Skip to Content

List address lists.

Returns allow and block address lists for this account or mailbox, optionally filtered by scope, direction (inbound/outbound), or verdict (allow/block).

openemail.accountAddressLists.list(
  accountId: string,
  options?: AccountAddressListsListOptions,
): PagePromise<AddressListPage, AddressList>

It calls GET /accounts/{accountId}/lists: List address lists in the API reference.

Example

for await (const addressList of openemail.accountAddressLists.list(accountId)) {
  // every item of every page (await the call instead for one page)
}

Arguments

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

Options

The last argument, options, a AccountAddressListsListOptions, takes:

OptionTypeSent asDescription
scopeKind('account' | 'domain' | 'mailbox')query scopeKindFilter by scope kind ('account', 'domain', 'mailbox')
scopeIdstringquery scopeIdFilter by scope identifier
direction('inbound' | 'outbound')query directionFilter by direction ('inbound', 'outbound')
verdict('allow' | 'block')query verdictFilter by policy action ('allow', 'block')
catchAllbooleanquery catchAlltrue: only the lists holding a live catch-all (*@*), the "block all" lists
limitnumberquery limitPage size (default 100)
cursorstringquery cursorOpaque page cursor from a previous response

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, AddressListPage. Iterated with for await, it is every AddressList of every page, each page fetched as the loop reaches it.

Errors

StatusWhat it means
400validation_failed, or invalid_pattern
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404not_found — the account, mailbox, scope or list is not accessible
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: AddressList, AddressListPage.