Databricks SDK for JavaScript
    Preparing search index...

    Interface OutlookOptions

    Outlook specific options for ingestion

    interface OutlookOptions {
        attachmentMode?: OutlookAttachmentMode;
        bodyFormat?: OutlookBodyFormat;
        folderFilter?: string[];
        includeFolders?: string[];
        includeMailboxes?: string[];
        includeSenders?: string[];
        includeSubjects?: string[];
        senderFilter?: string[];
        startDate?: string;
        subjectFilter?: string[];
    }
    Index

    Properties

    attachmentMode? bodyFormat? folderFilter? includeFolders? includeMailboxes? includeSenders? includeSubjects? senderFilter? startDate? subjectFilter?

    Properties

    attachmentMode?: OutlookAttachmentMode

    (Optional) Controls which attachments to ingest. If not specified, defaults to ALL.

    bodyFormat?: OutlookBodyFormat

    (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.

    folderFilter?: string[]

    Deprecated. Use include_folders instead.

    includeFolders?: string[]

    (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders.

    includeMailboxes?: string[]

    (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes.

    includeSenders?: string[]

    (Optional) Filter emails by sender address. Uses exact email match. Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders.

    includeSubjects?: string[]

    (Optional) Filter emails by subject line. Values ending with "" use prefix match (subject starts with the part before ""); otherwise substring match (subject contains the value). Examples: "Invoice" (substring), "Re:" (prefix), "Support Ticket", "URGENT" If not specified, emails with all subjects will be synced. Filter semantics: OR between different subjects.

    senderFilter?: string[]

    Deprecated. Use include_senders instead.

    startDate?: string

    (Optional) Start date for the initial sync in YYYY-MM-DD format. Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested.

    subjectFilter?: string[]

    Deprecated. Use include_subjects instead.

    Settings

    Member Visibility

    On This Page

    Properties