Mail

Get a message

Returns the full message including HTML/text body and attachment metadata. Automatically marks the message as seen. Requires scope mail:read.

get/mailboxes/{address}/messages/{uid}

Request

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

Full message

successboolean

Example response

{
  "success": true,
  "data": {
    "uid": 1234,
    "from": "alice@example.com",
    "to": [
      "jane@yourdomain.com"
    ],
    "subject": "Hello from Alice",
    "seen": true,
    "labels": [
      "needs-reply"
    ],
    "attachments": [
      {
        "filename": "report.pdf",
        "contentType": "application/pdf",
        "size": 102400
      }
    ]
  }
}

Changes

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