Skip to Content

List pattern routes.

Returns a paginated list of wildcard address pattern routes for an account or domain.

openemail.patterns.list(
  options?: PatternsListOptions,
): PagePromise<PatternsListResult, Pattern>

It calls GET /patterns: List pattern routes in the API reference.

Example

for await (const pattern of openemail.patterns.list()) {
  // every item of every page (await the call instead for one page)
}

Options

The last argument, options, a PatternsListOptions, takes:

OptionTypeSent asDescription
domainstringquery domainFilter by domain name
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, PatternsListResult. Iterated with for await, it is every Pattern of every page, each page fetched as the loop reaches it.

Errors

StatusWhat it means
400validation_failed or invalid_cursor
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
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

PatternsListResult

/** What `patterns.list` answers. */
type PatternsListResult = {
  /** Opaque cursor for the next page; absent on the last page */
  nextCursor?: string
  patterns: Pattern[]
}

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