Child pages
  • cPanel API 2 Functions - Email::listforwards
Skip to end of metadata
Go to start of metadata

Description

This function list a domain's forwarders.

Warning:

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

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 


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


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 forwards that contain "user" on example.com.
$list_forwarders = $cpanel->api2(
    'Email', 'listforwards', 
    array(
        'domain'          => 'example.com',
        'regex'           => 'user',
    ) 
);


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 forwards that contain "user" on example.com.
my $list_forwarders = $cpliveapi->api2(
    'Email', 'listforwards',
    { 
        'domain'          => 'example.com',
        'regex'           => 'user',
    }
);


Note:

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

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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 listforwards domain=example.com regex=user


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":{  
      "event":{  
         "result":1
      },
      "apiversion":2,
      "data":[  
         {  
            "uri_dest":"mailforward%40example.com",
            "forward":"user@example.com",
            "dest":"mailforward@example.com",
            "html_dest":"mailforward@example.com.com",
            "html_forward":"user@example.com",
            "uri_forward":"user%40example.com"
         },
         {  
            "uri_dest":"forwarded%example.com",
            "forward":"user@example.com",
            "dest":"forwarded@example.com",
            "uri_forward":"user%40example.com",
            "html_forward":"user@example.com",
            "html_dest":"forwarded@example.com"
         }
      ],
      "module":"Email",
      "func":"listforwards"
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

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
regexstring

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

ReturnTypeDescriptionPossible valuesExample
html_deststringThe 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.
mailforward@example.com
deststringThe 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 plaintext format — The system pipes mail to this application.
  • A username, in plaintext format — The system forwards mail to this system account.
mailforward@example.com
html_forwardstring

The email address, in an HTML-safe format.

An email address on the cPanel account, in an HTML-safe format.user@example.com
forwardstringThe email address, in plaintext.An email address on the cPanel account, in plaintext.user@example.com
uri_deststringThe 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

mailforward%40example.com
uri_forwardstringThe email address, in URI-encoded format.

An email address on the account, in URI-encoded format.

user@example.com
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1