UAPI Functions - Email::add_domain_forwarder - Knowledgebase

Description

This function creates a domain-level forwarder.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/add_domain_forwarder?domain=example.com&destdomain=forwardtome.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Create a domain-level forwarder for example.com
$add_domain_forwarder = $cpanel->uapi(
    'Email', 'add_domain_forwarder',
    array(
        'domain'     => 'example.com',
        'destdomain' => 'forwardtome.com',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Create a domain-level forwarder for example.com
my $add_domain_forwarder = $cpliveapi->uapi(
    'Email', 'add_domain_forwarder',
    {
        'domain'     => 'example.com',
        'destdomain' => 'forwardtome.com',
    }
);

cPanel Template Toolkit

[% execute( 'Email', 'add_domain_forwarder', { domain => 'example.com', destdomain => 'forwardtome.com' } ); %]

Command Line

uapi --user=username Email add_domain_forwarder domain=example.com destdomain=forwardtome.com

Notes:

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

 Output (JSON)

{
  "messages": "File updated "/etc/vdomainaliases/example.com",
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": null
}

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	Required The domain from which to forward mail.	A valid domain on the cPanel account.	example.com
destdomain	string	Required The domain to receive forwarded mail.	A valid domain.	forwardtome.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain from which to forward mail.

A valid domain on the cPanel account.

example.com

destdomain

string

Required

The domain to receive forwarded mail.

A valid domain.

forwardtome.com

Returns

Return	Type	Description	Possible values	Example
messages	string	A message of success, or a reason for failure.	A message of success that lists the updated vdomainaliases file. A reason for failure.	File updated "/etc/vdomainaliases/example.com

Knowledgebase

Categories

Categories