Skip to Content

List messages in a label by UID.

Returns messages in a label ordered by UID, optionally filtered by a minimum and maximum UID range.

openemail.labels.listMessages(
  mailboxId: string,
  label: string,
  options?: LabelsListMessagesOptions,
): ApiPromise<LabelsListMessagesResult>

It calls GET /mailboxes/{mailboxId}/labels/{label}/messages: List messages in a label by UID in the API reference.

Example

const result = await openemail.labels.listMessages(mailboxId, label)

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
labelstringLabel or folder name (e.g. INBOX, Archive, custom). The path's {label}.

Options

The last argument, options, a LabelsListMessagesOptions, takes:

OptionTypeSent asDescription
uidMinnumberquery uidMinMinimum UID inclusive
uidMaxnumberquery uidMaxMaximum UID inclusive
limitnumberquery limitMaximum messages to return (default 25, max 1000)

Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, LabelsListMessagesResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed — malformed UID range or limit
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox or label not found
503temporary_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)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

LabelsListMessagesResult

/** What `labels.listMessages` answers. */
type LabelsListMessagesResult = {
  /** List of message metadata summaries */
  messages: MessageMeta[]
  /** UIDVALIDITY epoch of the label */
  uidValidity: number
}

It names these types of the API, each on a page of its own: MessageMeta.