Get message search snippets
Returns subject and preview snippets for a text search. Provide message_ids to snippet exact messages, or omit it to snippet the first filtered results.
Authorizations
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
Filter to messages in this folder ID.
Filter by sender email address or display name.
Filter by To recipient email address or display name.
Filter by CC recipient email address or display name.
Filter by BCC recipient email address or display name.
Filter by subject text.
Filter by message body text.
Header name to match with header_value.
Header value to match with header_name.
Minimum message size in bytes.
x >= 0Maximum message size in bytes.
x >= 0Require this message keyword, such as $seen.
Exclude messages with this keyword.
Filter to messages after this ISO 8601 timestamp.
Filter to messages before this ISO 8601 timestamp.
When true, only return messages with attachments.
When true, only return unread messages.
Search text used to generate snippets.
Comma-separated message IDs, maximum 100.
Maximum results (default 50, max 100).
1 <= x <= 100Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.