The logout_user method terminates all IMAP and POP sessions that the specified user has active.


    <credentials object>, 
    "user": <mailbox_name>

Request fields for logout user

The following fields can be used in the logout_user method:

Field name ObligationDefinition/Value
userRequiredThe user's email address.

Response fields for logout user

The following fields may be returned in response to the logout_user method:

Field nameObligationDescription/Value
errorReturned if success = falseA text string that explains the error.
error_numberReturned if success = falseA number that represents the error.
successAlways returnedIndicates 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].


"credentials": {
"user": "[email protected]",
"password": "pencil75"
"user": "[email protected]"


"success": true