Skip to Content

The ScheduledLegResult type of the TypeScript SDK, part of ScheduledSend.

type ScheduledLegResult = {
  address: string
  deliveryId: string
  error?: string
  list?: string
  pattern?: string
  source?: ('permitted_recipients' | 'address_list' | 'verified_recipients')
  status: string
}

Fields

FieldTypeDescription
addressstringRecipient email address
deliveryIdstringDelivery attempt identifier
errorstringOptional. Error message if sending failed
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' or 'recipient_not_verified': which of the sender's own policies refused it, as on SendRecipientResult
statusstringDelivery status ('delivered', 'queued', 'failed')

Used in

ScheduledSend.

On this page