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.

SecurityBasicAuth
Request
query Parameters
email
string <email>

The email address to query.

Example: email=username@example.com
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Email/get_held_message_count
Request samples
uapi --output=jsonpretty \
  --user=username \
  Email \
  get_held_message_count
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "get_held_message_count",
  • "module": "Email",
  • "result": {
    • "data": 0,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}