# cPanel API 2 Functions - Email::adddomainforward

div
Warning:
br
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

br
## Description

This function creates a domain-level email forwarder.

div
Warning:
br
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

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


br
div
Important:
br
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

br
## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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"
```

div
Note:
br
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

br
LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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',
    )
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',
    }
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

br
cPanel Tag System (deprecated)

div
Warnings:
br
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Email adddomainforward domain=example.com destdomain=forwardtome.com
```

div
Note:
br
For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.  

Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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"
  }
}
```

div
Note:
br
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

br
## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
p
strong
Required
p
The domain to forward.
td
p
A valid domain on the account.
td
code
example.com
tr
td
code
destdomain
td
em
string
td
p
strong
Required
p
The destination domain.
td
A valid domain.
td
code
forwardtome.com
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
The forwarded domain.
td
The 
code
domain
 input parameter's value.
td
code
example.com
tr
td
code
destdomain
td
em
string
td
The destination domain.
td
The 
code
destdomain
 input parameter's value.
td
code
forwardtome.com
tr
td
code
statusmsg
td
em
string
td
A message of success or failure.
td
ul
li
p
A message of success.
li
An error message.
td
code
File updated \u201c/etc/vdomainaliases/example.com\u201d
tr
td
code
status
td
em
Boolean
td
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1