Mailbox

Delete mailbox

Delete existing mailbox folder

delete/v1/account/{account}/mailbox

Request

Base URL: https://your-emailengine-host
URL: https://your-emailengine-host/v1/account/{account}/mailbox
Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Query parameters

pathstring required

Mailbox folder path to delete

Example:My Outdated Mail

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the deleted folder path.

pathstring required

Full path to mailbox

mailboxIdstring

ID of the deleted mailbox (Gmail API and MS Graph API accounts only)

deletedboolean

Was the mailbox deleted

Example response

{
  "path": "Kalender/S&APw-nnip&AOQ-evad",
  "mailboxId": "1439876283476",
  "deleted": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.