Unsuspend email account login

This function restores a user's ability to log in to their email account.

Note:

  • To suspend a user's ability to log in, use the UAPI Email::suspend_login function.
  • To suspend incoming email for an account, use the UAPI Email::suspend_incoming function.

Important:

When you disable the Receive Mail role, the system disables this function.

Authorizations:
query Parameters
email
string <email>

The email user's account name.

Example: email=username@example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  unsuspend_login

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "unsuspend_login",
  • "module": "Email",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}