Email
Email Suspensions
Suspend email account login
This function suspends a user's ability to log in to their email account. This function immediately suspends the user's login credentials and prevents future authenticated connections to the email account.
Notes:
- When you suspend an account, the user's account still receives email.
- To suspend incoming email for an account, use the UAPI Email::suspend_incoming function.
- To remove the login suspension for an account, use the UAPI Email::unsuspend_login function.
Important:
When you disable the Receive Mail role, the system disables this function.
get/Email/suspend_login
Query parameters
emailstring email required
Example:user@example.com
The email user's account name.
Response
HTTP Request was successful.
Example response
{
"apiversion": 3,
"func": "suspend_login",
"module": "Email",
"result": {
"status": 1
}
}