Skip to Content

The MailboxRoutingAddressesItem type of the TypeScript SDK, part of MailboxRouting.

type MailboxRoutingAddressesItem = {
  address: string
  canSend: boolean
  kind: ('primary' | 'address' | 'catch_all' | 'pattern' | 'group')
  receives: boolean
  subaddressing: boolean
}

Fields

FieldTypeDescription
addressstringLowercased. An exact address, or <pattern>@domain for a wildcard: *@domain for a catch-all, sales-*@domain for a narrower pattern
canSendbooleanWhether this mailbox may send as it: its domain may send, and for a group, this mailbox is the persona. Mailbox-wide holds are reported by send-state, not here
kind('primary' | 'address' | 'catch_all' | 'pattern' | 'group')primary: the mailbox's own address. address: another route to it, or an alias domain's spelling of one. catch_all: a bare * pattern. pattern: a narrower wildcard. group: a group this mailbox is a member of or the persona of. A member counts when routing would bring it here through one of the mailbox's own addresses: written exactly, on an alias domain, or as a +tag form where the domain splits tags
receivesbooleanWhether mail to this address arrives here: its domain is enabled and receives here (not send-only), and for a group, this mailbox is a member or its persona archive. An alias spelling also requires its canonical domain to receive
subaddressingbooleanWhether local+tag@domain forms reach it too. Follows the canonical domain for an alias spelling. Always false on a wildcard, which already covers every local part

Used in

MailboxRouting.

On this page