v1

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

Return email account's Webmail settings

This function retrieves an email account's Webmail settings.

Important:

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

get/Email/get_webmail_settings

Query parameters

string email
OR
string username
Example:user@example.com

The email account.

Note:

If you do not specify a value, the function retrieves settings for the cPanel account's default mail 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_webmail_settings",
  "module": "Email",
  "result": {
    "data": {
      "domain": "mail.example.com",
      "has_maildir": 1,
      "user": "user@example.com"
    },
    "status": 1
  }
}