v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Accounts

Delete email account

This function deletes an email address.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/delete_pop

Query parameters

string email required
OR
string required
Example:user@domain.com

The email account username or address.

  • A valid email account username. For example, user if the email address is user@example.com.
  • A valid email address.
domainstring domain
Example:example.com

The email account's domain. For example, example.com if the email address is user@example.com.

flagsstring
Example:passwd

Whether to remove the mail account's home mail directory. If you do not specify a value, the function removes the mail account's home directory.

  • passwd — Preserve the mail account's home directory.
  • Any other value — Remove the mail account's home directory.
skip_quota0 | 1

Whether to modify the mail account's quota file.

  • 1 — Do not modify.
  • 0 — Modify.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete_pop",
  "module": "Email",
  "result": {
    "status": 1
  }
}