Page tree
Skip to end of metadata
Go to start of metadata

 

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

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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',
         )
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
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',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

 

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

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

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":null
}

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain name.

A valid domain on the cPanel account.

example.com

Returns

This function only returns metadata.