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.

SecurityBasicAuth

Request

query Parameters

string or string

The email account.

Note:

If you do not specify a value, the function retrieves settings for the cPanel account's default mail account.

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Email/get_webmail_settings

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  get_webmail_settings

Response samples

application/json

{"apiversion": 3,
"func": "get_webmail_settings",
"module": "Email",
"result": {"data": {"domain": "mail.example.com",
"has_maildir": 1,
"user": "user@example.com"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}