Description

This function deletes an email account.
 When you call this function, the system deletes the email account and all of its data.

We strongly recommend that you use the following UAPI function instead of this function:

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=delpop&domain="example.com"&email="user"

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete the user@example.com email address.
$delete_email_address = $cpanel->api2(
    'Email', 'delpop', 
    array(
        'domain'          => 'example.com', 
        'email'           => 'user',
    ) 
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete the user@example.com email address.
my $delete_email_address = $cpliveapi->api2(
    'Email', 'delpop',
    { 
        'domain'          => 'example.com', 
        'email'           => 'user',
    }
);

 

cpapi2 --user=username Email delpop domain=example.com email=user

For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.  

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delpop",
    "data": [
      {
        "rawout": "\nHorde data for \u201cuser@example.com\u201d has been removed.\n\n\n",
        "reason": "OK",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The email account's domain.

A valid domain on the cPanel account.

For example, example.com to delete user@example.com.

example.com
emailstring

Required

The email account's username.

An email account username.

For example, user to delete user@example.com

user

Returns

ReturnTypeDescriptionPossible valuesExample
rawoutstringA confirmation message.

A message that the function successfully removed the email account's Horde data. 

\nHorde data for \u201cuser@example.com\u201d has been removed.\n\n\n  
reasonstring

A message of success or a reason for failure.

  • OK
  • A string that describes an error.
This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1