Suspend cPanel account outgoing email

This function sets Exim's queue to suspend and force failure for email that a user sends to an external address.

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.

Authorizations:
query Parameters
user
required
string

The cPanel account.

Note

You cannot suspend the root user's outgoing email with this function.

Example: user=example

Responses

Response Schema: application/json
object

Request samples

whmapi1 --output=jsonpretty \
  suspend_outgoing_email \
  user='example'

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "suspend_outgoing_email",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}