Child pages
  • UAPI Functions - Email::list_domain_forwarders
Skip to end of metadata
Go to start of metadata

Description

This function lists domain-level forwarders.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive and MailSend roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/list_domain_forwarders?domain=example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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',
         )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- 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 %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


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


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

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