Release cPanel account queued outgoing emails

This function releases outgoing email in the email queue for a single cPanel account user.

Note:

If mail for a cPanel user's account is suspended, the system will reject their email before the mail server puts it in queue.

SecurityBasicAuth
Request
query Parameters
user
required
string

The cPanel account.

Example: user=example
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/release_outgoing_email
Request samples
whmapi1 --output=jsonpretty \
  release_outgoing_email \
  user='example'
Response samples
application/json
{
  • "metadata": {
    • "command": "release_outgoing_email",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}