Mail

Move a message

Moves a message from one folder to another. Requires scope mail:write.

post/mailboxes/{address}/messages/{uid}/move

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/messages/{uid}/move
  • Auth: HTTP bearer

Path parameters

addressstring required

Full mailbox address, e.g. user@yourdomain.com

integer required
OR
string required

The message: its IMAP UID (an integer, as returned by the list endpoint; relative to folder), or the permanent message_id from a message.received / message.sent webhook, which stays the same when the message moves. Add ?id=permanent to force the second reading of an all-digit id.

Request body

destinationstring required

Target folder path

folderstring

Source folder (defaults to INBOX)

Example request

{
  "destination": "Archive"
}

Response

Message moved

successboolean

Example response

{
  "success": true,
  "data": {
    "moved": true
  }
}

Changes

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