# mailboxes.getRetention

Get retention policy and preview.

Returns the time-based retention window in force for this mailbox (its own, else the account default, else none), where it came from, the platform floor, when the next message becomes due, and a PREVIEW of what a window would expunge — count and bytes of live messages older than it. Pass ?days= to preview windows that are not enabled. Retention expunges into the trash tier (restorable for 14 days), aged by the stored arrival time, never by the Date header.

```ts
openemail.mailboxes.getRetention(
  mailboxId: string,
  options?: MailboxesGetRetentionOptions,
): ApiPromise<Retention>
```

It calls `GET /mailboxes/{mailboxId}/retention`: [Get retention policy and preview](/docs/api/mailboxes/get_RetentionGet) in the API reference.

## Example

```ts
const retention = await openemail.mailboxes.getRetention(mailboxId)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |

## Options

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

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `days` | `string` | query `days` | Comma-separated windows in days to preview (at most 8), e.g. `30,90,365`. Omitted: the window in force is previewed, if any |

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, [`Retention`](/docs/sdks/typescript/types/retention). 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 ?days= (integers 1–36500, at most 8) |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox not found or not accessible to this principal |
| `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

It names these types of the API, each on a page of its own: [`Retention`](/docs/sdks/typescript/types/retention).
