cPanel API 2 Functions - Email::adddomainforward

Warning:

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

Description

This function creates a domain-level email forwarder.

Warning:

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

Email::add_domain_forwarder — This function creates a domain-level forwarder.

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=adddomainforward&domain="example.com"&destdomain="forwardtome.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.

// Forward mail for example.com to forwardtome.com
$add_domain_fwd = $cpanel->api2(
    'Email', 'adddomainforward',
    array(
        'domain'          => 'example.com',
        'destdomain'      => 'forwardtome.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.

# Forward mail for example.com to forwardtome.com
my $add_domain_fwd = $cpliveapi->api2(
    'Email', 'adddomainforward',
    {
        'domain'          => 'example.com',
        'destdomain'      => 'forwardtome.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 adddomainforward domain=example.com destdomain=forwardtome.com

Note:

For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "adddomainforward",
    "data": [
      {
        "domain": "example.com",
        "destdomain": "forwardtome.com",
        "statusmsg": "File updated \u201c/etc/vdomainaliases/example.com\u201d",
        "status": 1
      }
    ],
    "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 to forward.	A valid domain on the account.	`example.com`
`destdomain`	string	Required The destination domain.	A valid domain.	`forwardtome.com`

domain

string

Required

The domain to forward.

A valid domain on the account.

example.com

destdomain

string

Required

The destination domain.

A valid domain.

forwardtome.com

Returns

Return	Type	Description	Possible values	Example
`domain`	string	The forwarded domain.	The `domain` input parameter's value.	`example.com`
`destdomain`	string	The destination domain.	The `destdomain` input parameter's value.	`forwardtome.com`
`statusmsg`	string	A message of success or failure.	A message of success. An error message.	`File updated \u201c/etc/vdomainaliases/example.com\u201d`
`status`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`