Skip to content
cPanel API 2 Modules
/
cPanel API 2 Modules - Email
/
cPanel API 2 Functions - Email::delpop
Last updated

cPanel API 2 Functions - Email::delpop

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function deletes an email account.

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

Warning:

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

  • Email::delete_pop — This function deletes an email address.

Examples

WHM API (JSON)

syntaxhighlighter-pre
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"
Note:

For more information, read our Calls from the WHM API documentation


LiveAPI PHP Class

syntaxhighlighter-pre
$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',
    )
);
Note:

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


LiveAPI Perl Module

syntaxhighlighter-pre
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',
    }
);
Note:

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


cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username Email delpop domain=example.com email=user
Note:

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


Output (JSON)

syntaxhighlighter-pre
{
  "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"
  }
}
Note:

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


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
Previous page
Next page