Description

This function lists the domains with domain-level forwarders.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Email/list_forwarders_backups



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List example.com's domain-level forwarders.
$list_forwarders_backups = $cpanel->uapi(
    'Email', 'list_forwarders_backups'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List example.com's domain-level forwarders.
my $list_forwarders_backups = $cpliveapi->uapi(
    'Email', 'list_forwarders_backups',
);

 



<!-- List example.com's domain-level forwarders. -->
[% execute('Email', 'list_forwarders_backups' ) %]

 



uapi --user=username Email list_forwarders_backups



{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "domain": "example.com"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}



Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample

domain

string

A domain that uses a domain-level filter.

 

A valid domain on the cPanel account.

example.com