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