Skip to Content

Create an address list.

Creates an allow or block list at the account, domain, or mailbox scope. Scope, direction, and verdict are immutable once created.

openemail.mailboxAddressLists.create(
  mailboxId: string,
  body: MailboxAddressListsCreateBody,
  options?: CallOptions,
): ApiPromise<AddressList>

It calls POST /mailboxes/{mailboxId}/lists: Create an address list in the API reference.

Example

const addressList = await openemail.mailboxAddressLists.create(mailboxId, { name: 'Ada', direction: 'inbound', verdict: 'allow' })

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
bodyMailboxAddressListsCreateBodyThe request's body.

Options

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

Answer

Awaited, it is the API's JSON, AddressList. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

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
403account_credentials_required — a mailbox credential may mutate inbound lists only; outbound lists are administrator-managed
404not_found — the account, mailbox, scope or list is not accessible
409list_name_taken (name already exists in this scope) or list_limit_reached (maximum lists for this scope reached)
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
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

MailboxAddressListsCreateBody

/** The body of `mailboxAddressLists.create`. */
type MailboxAddressListsCreateBody = {
  /** Inbound block lists only (else 400): when this list's catch-all decides, let a vouched sender from the receiving mailbox's own address book through. Groups, webhooks and remote routes still need a named allow. */
  contactsExempt?: boolean
  /** Traffic direction ('inbound' or 'outbound') */
  direction: ('inbound' | 'outbound')
  /** Descriptive name for the list */
  name: string
  /** Identifier of the domain, mailbox, or account */
  scopeId?: string
  /** Required on account routes ('account', 'domain', 'mailbox'); omitted on mailbox routes */
  scopeKind?: ('account' | 'domain' | 'mailbox')
  /** Policy outcome ('allow' or 'block') */
  verdict: ('allow' | 'block')
}

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