Skip to main content
GET
Read attachment text

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-None-Match
string

Return 304 when the authorised response is unchanged.

Path Parameters

message_id
string
required

Message ID in the selected mailbox.

attachment_id
string
required

Attachment ID from that message.

Query Parameters

max_bytes
integer

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

Required range: 1 <= x <= 1048576
mailbox_id
string

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.

Response

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

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required