cPanel API 1 Functions - Email::addforward - Knowledgebase

Description

This function adds a domain-level email forwarder.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Email::add_domain_forwarder — This function creates a domain-level forwarder.
cPanel API 2 — Email::adddomainforward — This function creates a domain-level email forwarder.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$add_domain_forward = $cpanel->api1('Email', 'adddforward', array('example.com', 'domain.com') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $add_domain_forward = $cpliveapi->api1('Email', 'adddforward', ['example.com', 'domain.com'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::adddforward( $FORM('domain','destdomain') )">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The domain for which to forward mail.	A valid domain on the server.	example.com
destdomain	string	Required The domain to which to forward mail.	A valid domain name.	domain.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain for which to forward mail.

A valid domain on the server.

example.com

destdomain

string

Required

The domain to which to forward mail.

A valid domain name.

domain.com

Returns

This function does not return output.

Knowledgebase

Categories

Categories