v1

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

Delete email account's outgoing messages

This function deletes all outbound email messages held in the mail queue for the specified email account.

Important:

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

get/Email/delete_held_messages

Query parameters

emailstring email required
Example:username@example.com

The email address to query.

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_held_messages",
  "module": "Email",
  "result": {
    "status": 1
  }
}