cPanel API 2 Functions - Email::delforward - Knowledgebase

Description

This function deletes an email forwarder that forwards mail to another address.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Email::delete_forwarder — This function deletes an email forwarder.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=delforward&email=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete user@example.com's mail forwarder.
$kill_forward = $cpanel->api2(
    'Email', 'delforward', 
    array(
        'email'                => 'user@example.com', 
        'emaildest'            => 'fwdtome@example.com',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete user@example.com's mail forwarder.
my $kill_forward = $cpliveapi->api2(
    'Email', 'delforward',
    {
        'email'                => 'user@example.com',
        'emaildest'            => 'fwdtome@example.com',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Email delforward email=user%40example.com emaildest=fwdtome%40example.com

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delforward",
    "data": [
      {
        "statusmsg": "OK",
        "status": "1"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The forwarded email address.	A valid email address on the cPanel account.	user@example.com
emaildest	string	Required The email address to which the forwarder sends messages.	A valid email address.	fwdtome@example.com

Parameter

Type

Description

Possible values

Example

string

Required

The forwarded email address.

A valid email address on the cPanel account.

user@example.com

emaildest

string

Required

The email address to which the forwarder sends messages.

A valid email address.

fwdtome@example.com

Returns

Return	Type	Description	Possible values	Example
statusmsg	string	A message of success or failure.	OK — The function succeeded. Unable to delete forwarder. — The function failed.	OK
status	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories