Mail

Mark a message as spam

Moves the message to the Junk/Spam folder. Requires scope mail:write.

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

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/mailboxes/{address}/messages/{uid}/spam
  • 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.

Query parameters

folderstring

IMAP folder name (defaults to INBOX)

Response

Marked as spam

successboolean

Example response

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

Changes

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