Mailboxes

Update mailbox inbox message

Set read and/or starred state on one inbound JMAP message for a mailbox.

patch/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.

Request body

OR

Response

Inbox message action completed.

object'inbox_message_action' required
mailbox_idstring required
addressstring email required
message_idstring required
oktrue required
folder_idsstring[] nullable required

Folders the message is in after the change, read back from the mail server. Null when it could not be read back.

keywordsobject nullable required

Keywords such as $seen and $flagged after the change. Null when they could not be read back.

Changes

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