# List mailbox messages

Lists messages newest-first (or oldest-first with order=asc) with cursor pagination, optionally filtered to one label. sortBy=date orders by the Date header instead of arrival time. Set state=expunged to list trash/restorable messages. For UID-ordered listing use GET /mailboxes/:id/labels/:label/messages.

## `GET /api/v1/mailboxes/{mailboxId}/messages`

### Path parameters

- `mailboxId` (string, required) — Mailbox ULID identifier

### Query parameters

- `label` (string) — Only messages carrying this label (folder)
- `excludeRoles` ("inbox" | "sent" | "drafts" | "trash" | "archive" | "junk"[]) — System label roles to exclude: 'inbox', 'sent', 'drafts', 'trash', 'archive', 'junk' (e.g. 'trash,junk'). Unknown roles return 400 validation_failed.
- `cursor` (string) — Opaque page cursor from a previous response using the same sortBy. Arrival cursors must be canonical uppercase ULIDs; the cursor message need not still exist.
- `limit` (integer, ≥ 1, ≤ 200) — Page size (max 200)
- `hasFlags` (string) — Comma-separated flag names; a message matches only if ALL are set (e.g. flagged)
- `notFlags` (string) — Comma-separated flag names; a message matches only if NONE are set (e.g. seen, for unread-only)
- `order` ("asc" | "desc") — Listing direction: desc (default) = newest first, asc = oldest first. Hold it constant across a cursor crawl — cursors do not encode direction, so switching mid-crawl re-windows the page rather than erroring
- `sortBy` ("arrival" | "date") — Sort key: arrival (default) = the order mail reached this mailbox (message id); date = the Date header, falling back to arrival where it is absent or unparseable (RFC 5256 SORT DATE). Cursors follow the key, so hold it constant across a crawl — unlike order, a mismatched cursor is refused with 400 invalid_cursor rather than silently re-windowing. Note that under arrival an imported message (APPEND with ?internaldate=) lists where it was imported, not at its receivedAt; date orders imported mail by its own header
- `state` ("live" | "expunged") — live (default): ordinary listing, including messages on the Trash LABEL. expunged: the Recently-deleted TIER — a different place, whose rows have no labels at all and are purged after purgeAfter — carrying expungedAt/purgeAfter, the labels held at expunge, and restoresTo

### Responses

**200** — Messages page (live rows, or trash rows when state=expunged)

`application/json` → object

- _option 1: object_
  - `messages` (MessageMeta[], required)
    - `auth` (MessageAuth, required) — Stored SMTP authentication and original inbound junk verdicts. Missing verdicts are null; the object is null when none were recorded (including APPEND and local Sent copies). Junk does not follow later label changes.
      - `arc` (string | null, required) — ARC verdict, or null
      - `dkim` (string | null, required) — DKIM verdict, or null
      - `dmarc` (string | null, required) — DMARC verdict, or null
      - `junk` (boolean | null, required) — The inbound spam verdict (X-OpenEmail-Junk), or null when none was stamped
      - `spf` (string | null, required) — SPF verdict (pass/fail/softfail/none/...), or null
    - `bcc` (array | null, required) — Parsed Bcc header addresses for composed drafts, or null
    - `blobGen` (string, required) — Storage generation identifier
    - `blobHash` (string, required) — SHA-256 hash of raw MIME content in storage
    - `cc` (array | null, required) — Parsed Cc header addresses, or null if unparseable
    - `deliveryMeta` (object | null, required) — Inbound delivery audit metadata
    - `deliveryState` ("queued" | "relayed" | "delivered" | "failed" | "mixed" | null, required) — What became of this message after it was SENT, for a message this mailbox sent: 'queued' (handed to the relay), 'relayed' (the receiving mail system accepted it — never 'read'), 'delivered' (committed to a local mailbox), 'failed', or 'mixed' (some recipients failed, others did not). Null for received mail, and for sent mail whose delivery record has aged out — render null as no indicator, never as a state. Per-recipient detail and the SMTP reply behind a failure are at /messages/{messageId}/delivery.
      - _option 1: "queued" | "relayed" | "delivered" | "failed" | "mixed"_
      - _option 2: null_
      - _option 3: null_
    - `envelopeFrom` (string, required) — SMTP envelope sender address
    - `envelopeTo` (string, required) — SMTP envelope recipient address
    - `flags` (string[], required) — System flags (seen, answered, flagged, draft, deleted)
    - `from` (array | null, required) — Parsed From header addresses, or null if unparseable
    - `hasAttachment` (boolean | null, required) — True if message has file attachments, null if not yet determined
    - `id` (string, required) — Unique message identifier (ULID)
    - `inReplyTo` (string | null, required) — In-Reply-To header Message-ID, or null
    - `keywords` (string[], required) — Custom JMAP keywords (e.g. $forwarded)
    - `labels` (MessageLabel[], required) — Labels attached to this message with per-label UIDs
      - `deleted` (boolean, required) — This membership's IMAP \Deleted mark (set with `flagLabel` on PATCH, acted on by POST /labels/{label}/expunge). Always present; false when unmarked. Per label, so the same message can be marked in one folder and clean in another
      - `modseq` (integer <int64>, required) — RFC 7162 MODSEQ change sequence number
      - `name` (string, required) — Label name
      - `uid` (integer <int64>, required) — Message UID inside this label
      - `uidValidity` (integer <int64>, required) — UID validity epoch of the label
    - `messageIdHeader` (string | null, required) — Message-ID header value, or null
    - `receivedAt` (integer <int64>, required) — Timestamp when message was received by server in epoch seconds
    - `referencesIds` (string[], required) — List of Message-IDs from References header
    - `sentAt` (integer | null, required) — Sent timestamp from Date header in epoch seconds, or null
    - `size` (integer <int64>, required) — Total message size in bytes
    - `snippet` (string | null, required) — Short plain-text preview of message body
    - `subject` (string | null, required) — Message subject line, or null
    - `threadId` (string | null, required) — Conversation thread identifier (ULID), or null
    - `to` (array | null, required) — Parsed To header addresses, or null if unparseable
    - `modseq` (integer <int64>) — Per-label MODSEQ (present in label UID listings)
    - `restoresTo` (array | null) — Where a recovery would file this message, as label names. Present only when the message is recoverable: one carrying the Trash label (POST /messages/untrash), one carrying the Junk label with a recorded origin (POST /messages/unjunk), or one on the expunged tier (POST /messages/restore). A message in both Trash and Junk's records answers for Trash, the verb a client offers it first. Null otherwise, meaning the message is filed rather than recoverable. This is the effective destination including the Inbox fallback, not a raw snapshot, so a client can name it on a Put back or Not spam control without reimplementing the rule.
    - `uid` (integer <int64>) — Per-label UID (present in label UID listings)
  - `nextCursor` (string) — Opaque cursor for the next page; absent on the last page
- _option 2: object_
  - `messages` (ExpungedMessageMeta[], required)
    - `auth` (MessageAuth, required) — Stored SMTP authentication and original inbound junk verdicts. Missing verdicts are null; the object is null when none were recorded (including APPEND and local Sent copies). Junk does not follow later label changes.
      - `arc` (string | null, required) — ARC verdict, or null
      - `dkim` (string | null, required) — DKIM verdict, or null
      - `dmarc` (string | null, required) — DMARC verdict, or null
      - `junk` (boolean | null, required) — The inbound spam verdict (X-OpenEmail-Junk), or null when none was stamped
      - `spf` (string | null, required) — SPF verdict (pass/fail/softfail/none/...), or null
    - `bcc` (array | null, required) — Parsed Bcc header addresses for composed drafts, or null
    - `blobGen` (string, required) — Storage generation identifier
    - `blobHash` (string, required) — SHA-256 hash of raw MIME content in storage
    - `cc` (array | null, required) — Parsed Cc header addresses, or null if unparseable
    - `deliveryMeta` (object | null, required) — Inbound delivery audit metadata
    - `deliveryState` ("queued" | "relayed" | "delivered" | "failed" | "mixed" | null, required) — What became of this message after it was SENT, for a message this mailbox sent: 'queued' (handed to the relay), 'relayed' (the receiving mail system accepted it — never 'read'), 'delivered' (committed to a local mailbox), 'failed', or 'mixed' (some recipients failed, others did not). Null for received mail, and for sent mail whose delivery record has aged out — render null as no indicator, never as a state. Per-recipient detail and the SMTP reply behind a failure are at /messages/{messageId}/delivery.
      - _option 1: "queued" | "relayed" | "delivered" | "failed" | "mixed"_
      - _option 2: null_
      - _option 3: null_
    - `envelopeFrom` (string, required) — SMTP envelope sender address
    - `envelopeTo` (string, required) — SMTP envelope recipient address
    - `flags` (string[], required) — System flags (seen, answered, flagged, draft, deleted)
    - `from` (array | null, required) — Parsed From header addresses, or null if unparseable
    - `hasAttachment` (boolean | null, required) — True if message has file attachments, null if not yet determined
    - `id` (string, required) — Unique message identifier (ULID)
    - `inReplyTo` (string | null, required) — In-Reply-To header Message-ID, or null
    - `keywords` (string[], required) — Custom JMAP keywords (e.g. $forwarded)
    - `labels` (MessageLabel[], required) — Labels attached to this message with per-label UIDs
      - `deleted` (boolean, required) — This membership's IMAP \Deleted mark (set with `flagLabel` on PATCH, acted on by POST /labels/{label}/expunge). Always present; false when unmarked. Per label, so the same message can be marked in one folder and clean in another
      - `modseq` (integer <int64>, required) — RFC 7162 MODSEQ change sequence number
      - `name` (string, required) — Label name
      - `uid` (integer <int64>, required) — Message UID inside this label
      - `uidValidity` (integer <int64>, required) — UID validity epoch of the label
    - `messageIdHeader` (string | null, required) — Message-ID header value, or null
    - `receivedAt` (integer <int64>, required) — Timestamp when message was received by server in epoch seconds
    - `referencesIds` (string[], required) — List of Message-IDs from References header
    - `sentAt` (integer | null, required) — Sent timestamp from Date header in epoch seconds, or null
    - `size` (integer <int64>, required) — Total message size in bytes
    - `snippet` (string | null, required) — Short plain-text preview of message body
    - `subject` (string | null, required) — Message subject line, or null
    - `threadId` (string | null, required) — Conversation thread identifier (ULID), or null
    - `to` (array | null, required) — Parsed To header addresses, or null if unparseable
    - `modseq` (integer <int64>) — Per-label MODSEQ (present in label UID listings)
    - `restoresTo` (array | null) — Where a recovery would file this message, as label names. Present only when the message is recoverable: one carrying the Trash label (POST /messages/untrash), one carrying the Junk label with a recorded origin (POST /messages/unjunk), or one on the expunged tier (POST /messages/restore). A message in both Trash and Junk's records answers for Trash, the verb a client offers it first. Null otherwise, meaning the message is filed rather than recoverable. This is the effective destination including the Inbox fallback, not a raw snapshot, so a client can name it on a Put back or Not spam control without reimplementing the rule.
    - `uid` (integer <int64>) — Per-label UID (present in label UID listings)
    - `expungedAt` (integer <int64>, required) — Timestamp when the message was expunged, in epoch seconds
    - `expungedLabels` (string[], required) — The labels this row literally held at the moment it was expunged. For a message deleted the ordinary way that is ["Trash"], because the delete moved it there first. To show or act on where it will actually go, read restoresTo.
    - `purgeAfter` (integer <int64>, required) — Timestamp after which message will be permanently purged in epoch seconds
  - `nextCursor` (string) — Opaque cursor for the next page; absent on the last page

**400** — validation_failed, label_not_applicable (label filter with state=expunged), or invalid_cursor (a malformed cursor or one from a different sortBy)

`application/json` → ErrorOrValidation

**401** — unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge

`application/json` → ErrorBody

**404** — Mailbox not found or not accessible to this principal, or unknown_label (the label filter names no existing label)

`application/json` → ErrorBody

**503** — temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

`application/json` → ErrorBody

### Example request

```bash
curl -X GET 'https://api.open.email/api/v1/mailboxes/{mailboxId}/messages' \
  -H 'Authorization: Bearer oek_…'
```

## TypeScript SDK

[`openemail.messages.list`](/docs/sdks/typescript/messages/list)

```ts
for await (const messageMeta of openemail.messages.list(mailboxId)) {
  // every item of every page (await the call instead for one page)
}
```
