Mailbox API

Read attachment text

Changed on

Read or poll a requested extraction. Returns 404 after cache expiry or source removal. Current access and source availability are checked even with If-None-Match. This request does not start a conversion.

get/mailbox/messages/{message_id}/attachments/{attachment_id}/text

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages/{message_id}/attachments/{attachment_id}/text
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read)

Path parameters

message_idstring required

Message ID in the selected mailbox.

attachment_idstring required

Attachment ID from that message.

Query parameters

max_bytesinteger

Maximum UTF-8 text bytes returned. Default 262144; maximum 1048576. Applies to cached results too.

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Headers

If-None-Matchstring

Return 304 when the authorised response is unchanged.

Response

Conversion completed. Check outcome before using text; original attachment downloads remain available.

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "id": "ext_example"
  }
}

Changes