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 


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

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the domains that use aliases and custom default addresses.
$list_domains_with_aliases = $cpanel->api2(
    'Email', 'listaliasbackups'
);

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the domains that use aliases and custom default addresses.
my $list_domains_with_aliases = $cpliveapi->api2(
    'Email', 'listaliasbackups',
);

cpapi2 --user=username Email listaliasbackups

{
  "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

ReturnTypeDescriptionPossible valuesExample
domainstring

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
reasonstring

A reason for failure.

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1