Description

This function deletes a domain-level forwarder.

Examples




https://hostname.example.com:2083/cpsess##########/execute/Email/delete_domain_forwarder?domain=example.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete the domain-level forwarder for example.com
$delete_domain_forwarder = $cpanel->uapi(
    'Email', 'delete_domain_forwarder',
    array(
        'domain'         => 'example.com',
         )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete the domain-level forwarder for example.com
my $delete_domain_forwarder = $cpliveapi->uapi(
    'Email', 'delete_domain_forwarder',
    {
        'domain'         => 'example.com',
    }
);

 



<!-- Delete the domain-level forwarder for example.com -->
[% execute( 'Email', 'delete_domain_forwarder', { 'domain' => 'example.com' } ) %]

 



uapi --user=username Email delete_domain_forwarder domain=example.com



{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain name.

A valid domain on the cPanel account.

example.com

Returns

This function only returns metadata.