Sign in
Mailbox API

Get message search snippets

Changed on

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.

get/mailbox/messages/search-snippets

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/messages/search-snippets
  • 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)

Query parameters

folder_idstring

Filter to messages in this folder ID.

fromstring

Filter by sender email address or display name.

tostring

Filter by To recipient email address or display name.

ccstring

Filter by CC recipient email address or display name.

bccstring

Filter by BCC recipient email address or display name.

subjectstring

Filter by subject text.

bodystring

Filter by message body text.

header_namestring

Header name to match with header_value.

header_valuestring

Header value to match with header_name.

min_size_bytesinteger

Minimum message size in bytes.

max_size_bytesinteger

Maximum message size in bytes.

keywordstring

Require this message keyword, such as $seen.

not_keywordstring

Exclude messages with this keyword.

afterstring

Filter to messages after this ISO 8601 timestamp.

beforestring

Filter to messages before this ISO 8601 timestamp.

has_attachmentboolean

When true, only return messages with attachments.

is_unreadboolean

When true, only return unread messages.

qstring required

Search text used to generate snippets.

message_idsstring

Comma-separated message IDs, maximum 100.

limitinteger

Maximum results (default 50, max 100).

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.

Response

Search snippets

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes