cPanel API 2 Functions - Email::listforwards - Knowledgebase

Description

This function list a domain's forwarders.

Warning:

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

Email::list_forwarders — This function lists a domain's 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=listforwards&domain=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List forwards that contain "user" on example.com.
$list_forwarders = $cpanel->api2(
    'Email', 'listforwards', 
    array(
        'domain'          => 'example.com',
        'regex'           => 'user',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List forwards that contain "user" on example.com.
my $list_forwarders = $cpliveapi->api2(
    'Email', 'listforwards',
    {
        'domain'          => 'example.com',
        'regex'           => 'user',
    }
);

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.

Command Line

cpapi2 --user=username Email listforwards domain=example.com regex=user

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listforwards",
    "data": [
      {
        "html_dest": "userforward@example.com",
        "dest": "userforward@example.com",
        "html_forward": ":fail:",
        "forward": ":fail:",
        "uri_dest": "userforward%40example.com",
        "uri_forward": "%3afail%3a"
      },
      {
        "html_dest": "user2@example.com",
        "dest": "user2@example.com",
        "html_forward": "fwdtome@example.com",
        "forward": "fwdtome@example.com",
        "uri_dest": "user2%40example.com",
        "uri_forward": "fwdtome%40example.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	The domain to search for forwarders. If you do not specify a domain value, the function returns forwarders for all of the cPanel account's domains.	A valid domain on the cPanel account.	example.com
regex	string	A Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the email address's username and domain.	A valid PCRE.	user

Parameter

Type

Description

Possible values

Example

domain

string

The domain to search for forwarders.

If you do not specify a domain value, the function returns forwarders for all of the cPanel account's domains.

A valid domain on the cPanel account.

example.com

regex

string

A Perl Compatible Regular Expression (PCRE) that filters the results.

The system matches the PCRE to both the email address's username and domain.

A valid PCRE.

user

Returns

Return	Type	Description	Possible values	Example
html_dest	string	The email address, in an HTML-safe format.	An email address on the cPanel account, in an HTML-safe format.	userforward@example.com
dest	string	The email address, in plaintext.	An email address on the cPanel account, in plaintext.	userforward@example.com
html_forward	string	The address to which the system forwards mail, or the method that the system uses to handle mail, in an HTML- safe format.	An email address, in an HTML-safe format — The system forwards mail to this address. :fail: — The system bounces mail back to the sender, and sends a failure message. :blackhole: — The system deletes mail without a failure message. The path to an application, in an HTML-safe format — The system pipes mail to this application. A username, in an HTML-safe format — The system forwards mail to this system account.	fwdtome@example.com
forward	string	The address to which the system forwards mail, or the method that the system uses to handle mail, in plaintext.	An email address, in plaintext format — The system forwards mail to this address. :fail: — The system bounces mail back to the sender, and sends a failure message. :blackhole: — The system deletes mail without a failure message. The path to an application, in plaintextformat — The system pipes mail to this application. A username, in plaintextformat — The system forwards mail to this system account.	fwdtome@example.com
uri_dest	string	The email address, in URI-encoded format.	An email address on the account, in URI-encoded format. Note: URI-encoded email addresses replace the @ symbol with%40.	userforward%40example.com
uri_forward	string	The address to which the system forwards mail, or the method that the system uses to handle mail, in URI- encoded format.	An email address, in URI-encoded format — The system forwards mail to this address. %3afail%3a — The system bounces mail back to the sender, and sends a failure message. %3ablackhole%3a — The system deletes mail without a failure message. The path to an application, in plaintext format — The system pipes mail to this application. A username, in URI-encoded format — The system forwards mail to this system account. Note: URI-encoded email addresses replace the @ symbol with%40.	fwdtome%40example.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