Mail

List messages

Returns a paginated list of message summaries. Requires scope mail:read.

get/mailboxes/{address}/messages

Request

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

Path parameters

addressstring required

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

Query parameters

folderstring

IMAP folder name (defaults to INBOX)

pageinteger

Page number (1-based)

limitinteger

Messages per page (max 100)

labelstring

Only messages carrying this label

Response

Paginated message list

successboolean

Example response

{
  "success": true,
  "data": {
    "messages": [
      {
        "uid": 1234,
        "seq": 1,
        "from": "alice@example.com",
        "to": "jane@yourdomain.com",
        "subject": "Hello from Alice",
        "size": 4096,
        "labels": [
          "needs-reply"
        ]
      }
    ],
    "total": 142,
    "page": 1,
    "pages": 3
  }
}

Changes

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