Description

This function lists domain-level forwarders.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Email/list_domain_forwarders?domain=example.com



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



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



<!-- Get a hash, then display the dest value. -->
[% data = execute( 'Email', 'list_domain_forwarders', { 'domain' => 'example.com' } ); %]
[% FOREACH q = data.dest %]
     <p>
         [% q %]
     </p>
[% END %]
 
<!-- Get only the dest value. -->
[% execute( 'Email', 'list_domain_forwarders', { 'domain' => 'example.com' } ).data.dest %]



uapi --user=username Email list_domain_forwarders domain=example.com



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



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The domain name to query.

If you do not use this parameter, the function returns all domain-level forwarders on the cPanel account.

A valid domain on the cPanel account.

example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataarray of hashesAn array of hashes of domain forwarder information.Each hash contains the dest and forward returns. 

dest

string

The forwarded domain.

The function returns this value in the data hash.

A valid domain on the cPanel account.

example.com

forward

string

The destination domain.

The function returns this value in the data hash.

A valid domain name.

forwardtome.com