This function retrieves a domain's default address.
Important:
When you disable the Receive Mail role, the system disables this function.
| user required | string <username> The user whose default addresses to list. Example: user=user |
| domain | string <domain> The domain. If you do not specify a value, the function lists default addresses for all of the cPanel account's domains. Example: domain=example.com |
| 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 list_default_address user='user'
{- "apiversion": 3,
- "func": "list_default_address",
- "module": "Email",
- "result": {
- "data": [
- {
- "defaultaddress": "user",
- "domain": "example.com"
}
], - "errors": null,
- "messages": null,
- "metadata": {
- "transformed": 1
}, - "status": 1,
- "warnings": null
}
}