RecipientDeliveryStatus
The RecipientDeliveryStatus type of the TypeScript SDK, part of MessageDeliveryStatus.
type RecipientDeliveryStatus = {
at?: number
delivered: string
displayed?: string
email: string
mxHost?: string
smtpReply?: string
status: ('queued' | 'relayed' | 'delivered' | 'failed')
}Fields
| Field | Type | Description |
|---|---|---|
at | number | Optional. Epoch seconds at which this recipient reached the status above. Absent while the leg is still queued, in which case the submission's createdAt is its time |
delivered | string | Raw JMAP RFC 8621 delivered status ('queued', 'yes', 'no', 'unknown') |
displayed | string | Optional. Raw JMAP RFC 8621 displayed status ('unknown', 'yes') |
email | string | Recipient email address |
mxHost | string | Optional. Hostname of the mail exchanger that answered for this recipient, or the reporting MTA of a bounce that arrived later. Absent for legs that never spoke SMTP |
smtpReply | string | Optional. The reply the receiving mail system gave for this recipient, verbatim where it spoke SMTP ('250 2.0.0 Ok: queued as 4bXyz', '550 5.1.1 no such user'), synthesized in the same grammar for a leg that did not (local delivery, a policy refusal here) |
status | ('queued' | 'relayed' | 'delivered' | 'failed') | Delivery status for this recipient |