Skip to Content

Highlighted excerpts for search results.

Builds the same highlighted <mark> excerpts (subject + body preview) the search surfaces return inline under snippet, for up to 50 result ids the caller already holds, so a client can paint a results page first and fill the highlights in afterwards. filter is the filter the results were found with (for the ranked GET, { text: q }). Ids the caller cannot see are omitted.

openemail.search.snippets(
  mailboxId: string,
  body: EmailSearchSnippetsRequest,
  options?: CallOptions,
): ApiPromise<EmailSearchSnippetsResult>

It calls POST /mailboxes/{mailboxId}/search/snippets: Highlighted excerpts for search results in the API reference.

Example

const emailSearchSnippetsResult = await openemail.search.snippets(mailboxId, { ids: ['…'], filter: { operator: 'AND', conditions: [] } })

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
bodyEmailSearchSnippetsRequestThe request's body.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, EmailSearchSnippetsResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, unsupported_filter, or invalid_filter
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox not found or not accessible to this principal
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: EmailSearchSnippetsRequest, EmailSearchSnippetsResult.