Skip to Content

The AddressListVerdict type of the TypeScript SDK, which accountAddressLists.evaluate and mailboxAddressLists.evaluate take or answer.

type AddressListVerdict = {
  allowUnvouched?: AddressListVerdictAllowUnvouched
  decidedBy?: ('catch_all' | 'contact')
  listId?: string
  pattern?: string
  scopeKind?: ('account' | 'domain' | 'mailbox')
  verdict: ('allow' | 'block' | 'none')
}

Fields

FieldTypeDescription
allowUnvouchedAddressListVerdictAllowUnvouchedOptional. Message simulation only: an allow MATCHED an identity that no SPF pass, DMARC pass or local submission vouched for, so it could not fire. The usual answer to "I allowed them and they are still blocked".
decidedBy('catch_all' | 'contact')Optional. Absent when a named entry decided. catch_all: no named entry at any scope matched and the list's *@* decided. contact: that catch-all's list allows contacts and the sender is in the mailbox's address book.
listIdstringOptional. ID of the address list that matched (if any)
patternstringOptional. Specific pattern entry that matched (if any)
scopeKind('account' | 'domain' | 'mailbox')Optional. Scope level of the matching list (if any)
verdict('allow' | 'block' | 'none')Policy evaluation result ('allow', 'block', or 'none')

Used by

MethodWhat it does
accountAddressLists.evaluateTest address list policy against an address
mailboxAddressLists.evaluateTest address list policy against an address

On this page