cPanel API 2 Functions - Email::listdomainforwards - Knowledgebase

Description

This function retrieves information about a domain-level forwarder.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Email::list_domain_forwarders —

Error rendering macro 'excerpt-include' : No link could be created for 'UAPI Functions - Email::list_domain_forwarders'.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listdomainforwards&domain=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List the domain-level forwarder information for example.com.
$list_domain_fwd_info = $cpanel->api2(
    'Email', 'listdomainforwards', 
    array(
        'domain'          => 'example.com',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List the domain-level forwarder information for example.com.
my $list_domain_fwd_info = $cpliveapi->api2(
    'Email', 'listdomainforwards',
    {
        'domain'          => 'example.com',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listdomainforwards",
    "data": [
      {
        "dest": "example.com",
        "forward": "forwardtome.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

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	Required The domain.	A valid domain on the account.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain.

A valid domain on the account.

example.com

Returns

Return	Type	Description	Possible values	Example
dest	string	The specified domain.	A valid domain on the account.	example.com
forward	string	The domain to which the system forwards thedest domain's mail.	A valid domain name.	forwardtome.com
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories