Mailboxes

Get mailbox inbox thread

Fetch full inbound JMAP thread messages for a mailbox, including body parts and attachment metadata. The response carries the conversation's current version: pass it as expected_version when creating a reply draft.

get/mailboxes/{id}/inbox/threads/{thread_id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/inbox/threads/{thread_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

Mailbox inbox thread.

object'inbox_thread' required
mailbox_idstring required
addressstring email 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.

versioninteger nullable required

Current conversation version. Pass it as expected_version when creating a reply draft. Null when the thread has no conversation.

Changes

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