---
title: "Return email account's client settings"
method: GET
path: "/Email/get_client_settings"
tags: ["Email", "Email Accounts"]
---

# Return email account's client settings

`GET /Email/get_client_settings`

This function retrieves an email account's client settings.

**Important:**

When you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Query parameters

- `account` string, email

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `account` string, email — The account's email address.
      - `activesync_available` 1 | 0 — Whether the account supports ActiveSync. * `1` — Supported. * `0` — **Not** supported.
      - `activesync_host` string, domain — The account's ActiveSync hostname. This return **only** appears if `activesync_available` is `1`.
      - `activesync_port` integer — The account's ActiveSync SSL/TLS port. This return **only** appears if `activesync_available` is `1`.
      - `activesync_username` string, email — The account's ActiveSync username. This return **only** appears if `activesync_available` is `1`.
      - `display` string, email — The account's display name.
      - `domain` string, domain — The account's domain name.
      - `from_archiving` 1 | 0 — Whether the account is a mail archive. * `1` — The account is a mail archive. * `0` — The account is **not** a mail archive.
      - `has_plaintext_authentication` 1 | 0 — Whether the account supports plaintext authentication. * `1` — Supported. * `0` — **Not** supported.
      - `inbox_host` string, domain — The account's hostname.
      - `inbox_insecure_port` integer — The account's insecure inbound port.
      - `inbox_port` integer — The account's secure inbound port.
      - `inbox_service` 'imap' | 'pop' — The service type that the account uses. * `imap` * `pop`
      - `inbox_username` string, email — The account's username.
      - `mail_domain` string, domain — The account's mail hostname.
      - `smtp_host` string, domain — The account's outbound SMTP hostname.
      - `smtp_insecure_port` integer — The account's insecure outbound SMTP port.
      - `smtp_port` integer — The account's secure outbound SMTP port.
      - `smtp_username` string, email — The account's SMTP username.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)