Skip to Content

The SendRecipientResult type of the TypeScript SDK, part of SendResult.

type SendRecipientResult = {
  address: string
  deliveryId: string
  error?: string
  list?: string
  pattern?: string
  source?: ('permitted_recipients' | 'address_list' | 'verified_recipients')
  status: ('delivered' | 'queued' | 'filtered' | 'failed')
}

Fields

FieldTypeDescription
addressstringRecipient email address
deliveryIdstringUnique delivery attempt ID for this recipient
errorstringOptional. Error reason code if status is failed (e.g. 'over_quota', 'receiving_disabled'). 'sending_paused' and 'sending_disabled' mean a hold on the sender (mailbox, domain or account) landed while the request was running: recipients already handled keep their status and the rest are refused. 'sending_paused' is temporary: retry with the same X-Delivery-Id once the hold lifts. 'sending_disabled' is permanent. 'recipient_not_verified' is permanent for this recipient alone: the account is not yet vetted, so it may send only to its verified recipients (its own domains, and outside addresses whose owners confirmed them), and this one is neither; or the recipient is a hosted address that forwards for an account not yet vetted, to a target that is not one of that account's verified recipients.
liststringOptional. On an address-list refusal: the sender's list that decided
patternstringOptional. On an address-list refusal: the entry that decided (*@* for a block-all)
source('permitted_recipients' | 'address_list' | 'verified_recipients')Optional. On 'recipient_not_permitted': which of the sender's own policies refused it, the identity or credential allowlist, or the sender's outbound address lists. On 'recipient_not_verified': 'verified_recipients', the verified-recipients rule of the sending account, or of the account the recipient forwards for
status('delivered' | 'queued' | 'filtered' | 'failed')Outcome status for this recipient

Used in

SendResult.

On this page