Skip to Content

The VerifiedRecipient type of the TypeScript SDK, which verifiedRecipients.list take or answer.

type VerifiedRecipient = {
  address: string
  createdAt: number
  id: string
  lastSentAt: number | null
  state: ('pending' | 'verified')
  verifiedAt: number | null
}

Fields

FieldTypeDescription
addressstringThe address, normalized as forwarding destinations are: trimmed, lowercased, its domain in A-label form
createdAtnumberWhen the address was added, in epoch seconds
idstringVerified recipient ULID: the handle DELETE takes, so no address is path-encoded
lastSentAtnumber | nullWhen a confirmation link was last mailed, in epoch seconds. Each link works for seven days from its own mailing; a pending address whose newest link has expired is dropped at the next add, and posting it again mails a fresh one
state('pending' | 'verified')Confirmation state; only 'verified' counts as a verified recipient
verifiedAtnumber | nullWhen its owner pressed Confirm, in epoch seconds, or null while pending

Used by

MethodWhat it does
verifiedRecipients.listList an account's verified recipients

Used in

VerifiedRecipientAdded.