Description
This function deletes an email forwarder.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/delete_forwarder?address=user%40example.com&forwarder=fwdtome%40example.com
LiveAPI PHP Class
$cpanel = new CPANEL();
$delete_forwarder = $cpanel->uapi(
'Email', 'delete_forwarder',
array(
'address' => 'user@example.com',
'forwarder' => 'fwdtome@example.com',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $delete_forwarder = $cpliveapi->uapi(
'Email', 'delete_forwarder',
{
'address' => 'user@example.com',
'forwarder' => 'fwdtome@example.com',
}
);
cPanel Template Toolkit
[% execute( 'Email', 'delete_forwarder', { address => 'user@example.com', forwarder => 'fwdtome@example.com' } ) %]
Command Line
uapi --user=username Email delete_forwarder address=user%40example.com forwarder=fwdtome%40example.com
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
"data":null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
address
|
string
|
Required
The forwarder's email address.
|
A valid email address on the cPanel account.
|
user@example.com
|
|
forwarder
|
string
|
Required
The forwarder's destination.
|
- A valid email address.
- A script location.
- A system account.
|
fwdtome@example.com
|
Returns
This function only returns metadata.
