v1

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

Send email client settings to an email address

This function sends an email account's client settings to an email address.

Important:

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

get/Email/dispatch_client_settings

Query parameters

string username required
OR
string email required
Example:username

The email account username or address for which to send client settings.

tostring email required
Example:user@example.com

The email address to send client settings.

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": "dispatch_client_settings",
  "module": "Email",
  "result": {
    "status": 1
  }
}