v1

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

Return email account's outgoing message count

This function returns the count of 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/get_held_message_count

Query parameters

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