Description
This function lists the domains with domain-level forwarders.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/list_forwarders_backups
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_forwarders_backups = $cpanel->uapi(
'Email', 'list_forwarders_backups'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_forwarders_backups = $cpliveapi->uapi(
'Email', 'list_forwarders_backups',
);
cPanel Template Toolkit
[% execute('Email', 'list_forwarders_backups' ) %]
Command Line
uapi --user=username Email list_forwarders_backups
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": [
{
"domain": "example.com"
}
],
"metadata": {
"transformed": 1
}
}
Parameters
This function does not accept parameters.
Returns
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
domain
|
string
|
A domain that uses a domain-level filter.
|
A valid domain on the cPanel account.
|
example.com
|
