Skip to Content

The EmailSearchSnippet type of the TypeScript SDK, which search.fullText take or answer.

type EmailSearchSnippet = {
  id: string
  preview: string | null
  subject: string | null
}

Fields

FieldTypeDescription
idstringMessage ULID this snippet belongs to
previewstring | nullHighlighted HTML snippet for the message body, or null if not matched
subjectstring | nullHighlighted HTML snippet for the subject line, or null if not matched

Used by

MethodWhat it does
search.fullTextFull-text search a mailbox

Used in

EmailSearchResult, EmailSearchSnippetsResult, SemanticSearchResult.