Description
This function retrieves a list of the account's domains that use aliases and custom default addresses. The default (catchall) address handles unroutable mail that the account's domains receive.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listaliasbackups
LiveAPI PHP Class
$cpanel
=
new
CPANEL();
$list_domains_with_aliases
=
$cpanel
->api2(
'Email'
,
'listaliasbackups'
);
LiveAPI Perl Module
my
$cpliveapi
= Cpanel::LiveAPI->new();
my
$list_domains_with_aliases
=
$cpliveapi
->api2(
'Email'
,
'listaliasbackups'
,
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username Email listaliasbackups
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "listaliasbackups",
"data": [
{
"domain": "example.com"
},
{
"domain": "addondomain.com"
},
{
"domain": "myotherdomain.com"
}
],
"event": {
"result": 1
},
"module": "Email"
}
}
Parameters
This function does not accept parameters.
Returns
Return
|
Type
|
Description
|
Possible values
|
Example
|
domain
|
string
|
A domain that has an alias or custom default address.
The system uses the account's /etc/valiases file to determine the list of domains.
|
A valid domain on the account.
|
example.com
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reason value if it failed.
|
A string that describes the error.
|
This is an error message.
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|