UAPI Functions - Email::list_domain_forwarders - Knowledgebase

Description

This function lists domain-level forwarders.

Examples

cPanel or Webmail Session URL

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

 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',
         )
);

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

 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 %]

Command Line

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

Notes:

You must URI-encode values.
username represents your account-level username.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	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

Parameter

Type

Description

Possible values

Example

domain

string

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

Return	Type	Description	Possible values	Example
data	array of hashes	An array of hashes of domain forwarder information.	Each hash contains the dest andforward returns.
dest	string	The forwarded domain. The function returns this value in thedata hash.	A valid domain on the cPanel account.	example.com
forward	string	The destination domain. The function returns this value in thedata hash.	A valid domain name.	forwardtome.com

Knowledgebase

Categories

Categories