ScheduledLegResult
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
| Field | Type | Description |
|---|---|---|
address | string | Recipient email address |
deliveryId | string | Delivery attempt identifier |
error | string | Optional. Error message if sending failed |
list | string | Optional. On an address-list refusal: the sender's list that decided |
pattern | string | Optional. 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 |
status | string | Delivery status ('delivered', 'queued', 'failed') |