Email
Email Suspensions
Suspend email account outgoing mail
This function rejects outgoing mail for a suspended email account. This function does not disable a user's login credentials or access permissions to their email account.
Notes:
- To suspend a user's login credentials and prevent authenticated connections to the email account, use the UAPI Email::suspend_login function.
- To allow an email account to send mail, use the UAPI Email::unsuspend_outgoing function.
- To hold outgoing mail in Exim's queue, use the UAPI Email::hold_outgoing function.
Important:
When you disable the Send Mail role, the system disables this function.
get/Email/suspend_outgoing
Query parameters
emailstring email required
Example:username@example.com
The email account's username.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "suspend_outgoing",
"module": "Email",
"result": {
"data": 1,
"status": 1
}
}