Email
Email Accounts
Return domain's default email address
This function retrieves a domain's default address.
Important:
When you disable the Receive Mail role, the system disables this function.
get/Email/list_default_address
Query parameters
userstring username required
Example:user
The user whose default addresses to list.
domainstring domain
Example:example.com
The domain. If you do not specify a value, the function lists default addresses for all of the cPanel account's domains.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "list_default_address",
"module": "Email",
"result": {
"data": [
{
"defaultaddress": "user",
"domain": "example.com"
}
],
"metadata": {
"transformed": 1
},
"status": 1
}
}