# labels.listMessages

List messages in a label by UID.

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

```ts
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](/docs/api/labels/get_LabelMessageList) in the API reference.

## Example

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

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |
| `label` | `string` | Label or folder name (e.g. INBOX, Archive, custom). The path's `{label}`. |

## Options

The last argument, `options`, a `LabelsListMessagesOptions`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `uidMin` | `number` | query `uidMin` | Minimum UID inclusive |
| `uidMax` | `number` | query `uidMax` | Maximum UID inclusive |
| `limit` | `number` | query `limit` | Maximum 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](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`LabelsListMessagesResult`](#labelslistmessagesresult). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

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

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

### LabelsListMessagesResult

```ts
/** 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`](/docs/sdks/typescript/types/message-meta).
