Message

Move a message to a specified folder

Moves a message to a target folder

put/v1/account/{account}/message/{message}/move

Request

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

Path parameters

accountstring required

Unique identifier for the email account

Example:user123
messagestring required

Message ID

Example:AAAAAQAACnA

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

Request body

pathstring required

Destination mailbox folder path

sourcestring

Source mailbox folder path (Gmail API only). Needed to remove the label from the message.

Example request

{
  "path": "Target/Folder"
}

Response

Returns the message identifiers in the target folder.

pathstring required

Destination mailbox folder path

idstring

ID of the moved message. Only included if the server provides it.

uidinteger

UID of the moved message, applies only to IMAP accounts. Only included if the server provides it.

Example response

{
  "path": "INBOX",
  "id": "AAAAAQAACnA",
  "uid": 12345
}

Changes

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