v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Accounts

Return email account's client settings

This function retrieves an email account's client settings.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/get_client_settings

Query parameters

accountstring email
Example:username@example.com

The email address for which to send client settings.

Note:

This parameter defaults to the system default email account.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_client_settings",
  "module": "Email",
  "result": {
    "data": {
      "account": "username@example.com",
      "activesync_available": 1,
      "activesync_host": "mail.example.com",
      "activesync_port": 2091,
      "activesync_username": "username@example.com",
      "display": "username@example.com",
      "domain": "domain.com",
      "has_plaintext_authentication": 1,
      "inbox_host": "mail.example.com",
      "inbox_insecure_port": 143,
      "inbox_port": 993,
      "inbox_service": "imap",
      "inbox_username": "username@example.com",
      "mail_domain": "mail.example.com",
      "smtp_host": "mail.example.com",
      "smtp_insecure_port": 25,
      "smtp_port": 465,
      "smtp_username": "username@example.com"
    },
    "status": 1
  }
}