logout_user
The logout_user method terminates all IMAP and POP sessions that the specified user has active.
Syntax
{
<credentials object>,
"user": <mailbox_name>
}
Request fields for logout user
The following fields can be used in the logout_user method:
| Field name |  Obligation | Definition/Value |
|---|---|---|
| user | Required | The user's email address. |
Response fields for logout user
The following fields may be returned in response to the logout_user method:
| Field name | Obligation | Description/Value |
|---|---|---|
| error | Returned if success = false | A text string that explains the error. |
| error_number | Returned if success = false | A number that represents the error. |
| success | Always returned | Indicates whether the request was successful or not. Allowed values are true and false. |
Examples for logout_user
This example terminate all current IMAP and POP sessions for [email protected].
Request
{
"credentials": {
"user": "[email protected]",
"password": "pencil75"
},
"user": "[email protected]"
}
Response
{
"success": true
}
Updated less than a minute ago