Skip to Content

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

FieldTypeDescription
createdAtnumberSubmission creation timestamp in epoch seconds
deliveryIdstringThe delivery id this submission was sent with, as returned by /send
messageIdstring | nullULID of the Sent copy this submission produced, or null when no Sent copy was kept
recipientsRecipientDeliveryStatus[]Per-recipient delivery status
sendAtstringUTC 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
submissionIdstringSubmission identifier (the JMAP EmailSubmission id)
threadIdstring | nullConversation thread identifier

Used by

MethodWhat it does
messages.getDeliveryGet delivery status of a sent message
deliveries.listList delivery statuses for a thread or a set of messages

Used in

MessageDeliveryList.