Skip to Content

The AddressListEntry type of the TypeScript SDK, which accountAddressLists.addEntry and 3 more methods take or answer.

type AddressListEntry = {
  createdAt: number
  expiresAt: number | null
  hitCount: number
  lastHitAt: number | null
  note: string | null
  pattern: string
}

Fields

FieldTypeDescription
createdAtnumberTimestamp when pattern was added in epoch seconds
expiresAtnumber | nullEpoch seconds after which the entry stops applying and disappears from the list, or null for never
hitCountnumberEvaluations this entry decided (at least: hits within ten seconds of the previous recorded one are folded into it)
lastHitAtnumber | nullEpoch seconds of the last recorded hit, or null if never matched
notestring | nullOptional operator note, or null
patternstringAddress pattern (e.g. user@example.com, *@example.com, or *@.example.com)

Used by

MethodWhat it does
accountAddressLists.addEntryAdd a pattern to an address list
accountAddressLists.listEntriesList patterns in an address list
mailboxAddressLists.addEntryAdd a pattern to an address list
mailboxAddressLists.listEntriesList patterns in an address list

Used in

AddressListEntryPage.