delete_user

The delete_user method soft deletes a user's account. Once a user is deleted they will not be able to receive mail or access the system in any way.

Syntax

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

Request fields for delete_user

The following fields can be used in the delete_user method:

Field name

Obligation

Definition/Value

user

Required

The user's mailbox name.

Response fields for delete_user

The following fields may be returned in response to the delete_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 delete_user

Request

{
credentials object,
      "user": "[email protected]"
      "password": "abc123"
    },
    "user": "[email protected]"
}

Response

{
   "success": true
}