Skip to main content
POST
Batch get mailbox messages

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.

Query Parameters

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.

Body

application/json
ids
string[]
required

Message IDs to fetch, maximum 100.

Required array length: 1 - 100 elements
body_mode
enum<string>

Body shape to include for each message.

Available options:
none,
raw,
clean_json
include_attachments
enum<string>

Attachment detail to include. Contents are not returned.

Available options:
none,
metadata
include_headers
enum<string>

Header detail to include in each message.

Available options:
none,
selected,
full
include_html
boolean

When true, include HTML content when available.

When true, include links extracted from the body.

max_body_chars
integer

Maximum body characters per message before truncation.

Required range: 1 <= x <= 1000000
part
enum<string>

Body part to return when body_mode is not none.

Available options:
auto,
text,
html,
both
strip_quotes
boolean

When true, remove quoted reply text.

strip_signature
boolean

When true, remove detected email signatures.

Response

Batch message result

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