Description

This function creates a domain-level forwarder.

Examples 




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



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

 



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

 



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

 



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



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



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