MessageDeliveryStatus
The MessageDeliveryStatus type of the TypeScript SDK, which messages.getDelivery and deliveries.list take or answer.
type MessageDeliveryStatus = {
createdAt: number
deliveryId: string
messageId: string | null
recipients: RecipientDeliveryStatus[]
sendAt: string
status: ('queued' | 'relayed' | 'delivered' | 'failed' | 'mixed')
submissionId: string
threadId: string | null
}Fields
| Field | Type | Description |
|---|---|---|
createdAt | number | Submission creation timestamp in epoch seconds |
deliveryId | string | The delivery id this submission was sent with, as returned by /send |
messageId | string | null | ULID of the Sent copy this submission produced, or null when no Sent copy was kept |
recipients | RecipientDeliveryStatus[] | Per-recipient delivery status |
sendAt | string | UTC timestamp when message was sent or scheduled |
status | ('queued' | 'relayed' | 'delivered' | 'failed' | 'mixed') | Overall delivery status across all recipients. 'relayed' means the receiving mail system accepted the message; 'mixed' means at least one recipient failed while another did not |
submissionId | string | Submission identifier (the JMAP EmailSubmission id) |
threadId | string | null | Conversation thread identifier |
Used by
| Method | What it does |
|---|---|
messages.getDelivery | Get delivery status of a sent message |
deliveries.list | List delivery statuses for a thread or a set of messages |