Skip to Content

The MailTemplateSendRow type of the TypeScript SDK, part of MailTemplateSend.

type MailTemplateSendRow = {
  address: string
  deliveryId: string
  error?: string
  retryAfterSeconds?: number
  sentCopy?: ('saved' | 'duplicate' | 'over_quota')
  status: ('delivered' | 'queued' | 'filtered' | 'failed')
}

Fields

FieldTypeDescription
addressstring
deliveryIdstringThis recipient's leg key, the same shape /send answers
errorstringOptional. Why, when failed. '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 delivery id once the hold lifts. 'sending_disabled' is permanent. A sending_paused row is temporary even where it carries no retryAfterSeconds.
retryAfterSecondsnumberOptional. Set on the rows a temporary refusal stopped: retry this recipient after this long
sentCopy('saved' | 'duplicate' | 'over_quota')Optional.
status('delivered' | 'queued' | 'filtered' | 'failed')

Used in

MailTemplateSend.

On this page