Add cPanel account to outbound email hold queue

This function sets Exim's queue to hold 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 the queue.

SecurityBasicAuth

Request

user

required

string

The cPanel account.

Note

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

Example: user=example

Responses

200

HTTP Request was successful.

object

get/hold_outgoing_email

Request samples

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

Response samples

application/json

{"metadata": {"command": "hold_outgoing_email",
"reason": "OK",
"result": 1,
"version": 1
}
}