Mailboxes

Get one exact mailbox inbox message

get/mailboxes/{id}/inbox/messages/{message_id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/inbox/messages/{message_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

Exact full inbox message.

object'inbox_message_full' required
idstring required
thread_idstring required

Deprecated and not stable: a legacy thread ID that changes when the mail server re-threads its IDs or a relayed send's placeholder key is replaced. It remains supported in thread paths; store conversation_id instead.

conversation_idstring nullable required

Stable Shipmail conversation identifier (thd_...). Store this: it survives thread merges and mail-server re-threading, which thread_id does not.

mailbox_idstring required
addressstring email required
folder_idsstring[] required
keywordsobject required
subjectstring nullable required
received_atstring date-time required
previewstring required
has_attachmentboolean required
sizeinteger required
message_idstring[] nullable required
in_reply_tostring[] nullable required
referencesstring[] nullable required
body_valuesobject required
reply_textstring nullable required

What the sender newly wrote, computed from the text body (or the HTML body when there is no text part). Quoted history, the attribution line before it, signatures after -- and mobile footers such as "Sent from my iPhone" are removed. Inline replies between quoted lines are kept. Null when nothing is left; read body_values then. At most 20,000 characters.

Changes

No recorded changes to this operation across all 1 revision of this API.