cPanel API 2 Functions - Email::listdomainforwards

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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 — This function lists domain-level forwarders.

Important:

When you disable the Receive Mail role, the system disables this function.

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="example.com"

Note:

For more information, read our Calls from the WHM API documentation.

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

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 the domain-level forwarder information for example.com.
my $list_domain_fwd_info = $cpliveapi->api2(
    'Email', 'listdomainforwards',
    {
        'domain'          => 'example.com',
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

Command Line

cpapi2 --user=username Email listdomainforwarders domain=example.com

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username command.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The domain.	A valid domain on the cPanel account.	`example.com`

domain

string

Required

The domain.

A valid domain on the cPanel account.

example.com

Returns

Return	Type	Description	Possible values	Example
`dest`	string	The specified domain.	A valid domain on the cPanel account.	`example.com`
`forward`	string	The domain to which the system forwards the `dest` domain's mail.	A valid domain name.	`forwardtome.com`
`reason`	string	A reason for failure. Note: This function only returns a `reason` value 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`