Page tree
Skip to end of metadata
Go to start of metadata

 

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

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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',
         )
);

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.
 
# Create a domain-level forwarder for example.com
my $add_domain_forwarder = $cpliveapi->uapi(
    'Email', 'add_domain_forwarder',
    {
        'domain'     => 'example.com',
        'destdomain' => 'forwardtome.com',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Create a domain-level forwarder for example.com -->
[% execute( 'Email', 'add_domain_forwarder', { domain => 'example.com', destdomain => 'forwardtome.com' } ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

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

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain from which to forward mail.

A valid domain on the cPanel account.

example.com
destdomainstring

Required

The domain to receive forwarded mail.

A valid domain.

forwardtome.com

Returns

ReturnTypeDescriptionPossible valuesExample
messagesstring

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