UAPI Functions - Email::delete_forwarder

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(); // Connect to cPanel - only do this once.
  
// Delete the forwarder for user@example.com
$delete_forwarder $cpanel->uapi(
    'Email''delete_forwarder',
    array(
        'address'        => 'user@example.com',
        'forwarder'      => 'fwdtome@example.com',
         )
);

 LiveAPI Perl Module

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

 cPanel Template Toolkit

<!-- Delete the forwarder for user@example.com -->
[% 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

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

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

 

Note:

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

   

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.

  • 7 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....