Mail
cPanel Account Mail Management
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.
get/suspend_outgoing_email
Request
- Base URLhttps://whm-server.tld:2087/json-api
- AuthHTTP basic
Query parameters
userstring required
Example:example
The cPanel account.
Note
You cannot suspend the root user's outgoing email with this function.
Response
HTTP Request was successful.
Example response
{
"metadata": {
"command": "suspend_outgoing_email",
"reason": "OK",
"result": 1,
"version": 1
}
}Changes
No recorded changes to this operation across all 5 revisions of this API.