Skip to Content

Preview retention across an account's mailboxes.

Pages the account's mailboxes with each one's own window, the window in force after resolution against the account default, and a preview of what a window would expunge — the window named by ?days= (what an account default WOULD do, before setting one), else each mailbox's effective window. One store read per mailbox; a store that could not be read is listed in unreadable rather than reported as zero.

openemail.accounts.listRetention(
  accountId: string,
  options?: AccountsListRetentionOptions,
): PagePromise<AccountRetention, AccountRetentionRow>

It calls GET /accounts/{accountId}/retention: Preview retention across an account's mailboxes in the API reference.

Example

for await (const accountRetentionRow of openemail.accounts.listRetention(accountId)) {
  // every item of every page (await the call instead for one page)
}

Arguments

ArgumentTypeDescription
accountIdstringAccount ULID identifier. The path's {accountId}.

Options

The last argument, options, a AccountsListRetentionOptions, takes:

OptionTypeSent asDescription
limitnumberquery limitPage size (default 100)
cursorstringquery cursorOpaque page cursor from a previous response
daysstringquery daysOne window in days to preview on every mailbox (e.g. the account default you are about to set)

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

Answer

It is a listing, a PagePromise. Awaited, it is one page as the API answers it, AccountRetention. Iterated with for await, it is every AccountRetentionRow of every page, each page fetched as the loop reaches it.

Errors

StatusWhat it means
400validation_failed — malformed ?days= (an integer 1–36500)
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Account not found or not accessible to this principal
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

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