Skip to Content

The AddressList type of the TypeScript SDK, which accountAddressLists.create and 7 more methods take or answer.

type AddressList = {
  catchAll?: boolean
  contactsExempt: boolean
  createdAt: number
  direction: ('inbound' | 'outbound')
  entryCount?: number
  id: string
  name: string
  scopeId: string
  scopeKind: ('account' | 'domain' | 'mailbox')
  updatedAt: number
  verdict: ('allow' | 'block')
}

Fields

FieldTypeDescription
catchAllbooleanOptional. Whether this list holds a live catch-all (*@*) entry: the "block all" switch, for this list only. Read-only, present on list reads.
contactsExemptbooleanInbound block lists only: when this list's catch-all (*@*) decides, a vouched sender found in the receiving mailbox's own address book is let through. Applies only where a concrete receiving mailbox is known: a group, webhook or remote route behind the same block-all still needs a named allow. Every catch-all list at the most specific scope holding one must opt in. Never lifts a named block.
createdAtnumberCreation timestamp in epoch seconds
direction('inbound' | 'outbound')Traffic direction ('inbound' for senders, 'outbound' for recipients)
entryCountnumberOptional. Count of pattern entries in this list (on single list read)
idstringAddress list ULID identifier
namestringDescriptive name for this address list
scopeIdstringAssociated account ID, domain name, or mailbox ID depending on scopeKind
scopeKind('account' | 'domain' | 'mailbox')Policy scope level ('account', 'domain', or 'mailbox')
updatedAtnumberLast updated timestamp in epoch seconds
verdict('allow' | 'block')Policy action ('allow' or 'block')

Used by

MethodWhat it does
accountAddressLists.createCreate an address list
accountAddressLists.listList address lists
accountAddressLists.getGet an address list
accountAddressLists.updateUpdate an address list
mailboxAddressLists.createCreate an address list
mailboxAddressLists.listList address lists
mailboxAddressLists.getGet an address list
mailboxAddressLists.updateUpdate an address list

Used in

AddressListPage.