Message

Delete message

Move message to Trash or delete it if already in Trash<br/><br/>For Gmail API accounts the message is always moved to Trash. The force option, which permanently deletes on IMAP accounts, has no effect.

delete/v1/account/{account}/message/{message}

Request

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

Path parameters

accountstring required

Unique identifier for the email account

Example:user123
messagestring required

Message ID

Example:AAAAAQAACnA

Query parameters

forceboolean

Delete message even if not in Trash. Not supported for Gmail API accounts.

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 whether the message was moved to Trash or permanently deleted.

deletedboolean

Was the message deleted permanently. IMAP accounts return false when the message was moved to Trash, Gmail API and MS Graph API accounts return true also for moves to Trash

Example response

{
  "moved": {
    "destination": "Trash",
    "message": "AAAAAwAAAWg"
  }
}

Changes

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