Type Alias SearchSnippetGetRequestInvocationArgs

The arguments for fetching SearchSnippet objects via a SearchSnippet/get call.

This is NOT a standard /get method. It takes a filter (the same as passed to Email/query) and a list of Email ids, and returns search snippets for those Emails.

See

RFC 8621 Section 5.1: SearchSnippet/get

type SearchSnippetGetRequestInvocationArgs = {
    accountId: Id;
    emailIds: Id[];
    filter?:
        | FilterOperator<EmailFilterCondition>
        | FilterCondition<EmailFilterCondition>
        | null;
}

Index

Properties

accountId emailIds filter?

Properties

accountId

accountId: Id

The id of the account to use.

emailIds

emailIds: Id[]

The ids of the Emails to fetch snippets for.

`Optional`filter

filter?:
    | FilterOperator<EmailFilterCondition>
    | FilterCondition<EmailFilterCondition>
    | null

The same filter as passed to Email/query.

See

RFC 8621 Section 4.4: Email/query