This function retrieves an email account's Webmail settings.
Important:
When you disable the Receive Mail role, the system disables this function.
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. |
| apiversion | integer The version of the API. |
| func | string The name of the method called. |
| module | string The name of the module called. |
object |
uapi --user=username Email get_webmail_settings{- "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
}
}