Interface ListEmailMessagesInput

Input for SudoEmailClient.listEmailMessages.

ListEmailMessagesInput

interface ListEmailMessagesInput {
    cachePolicy?: CachePolicy;
    dateRange?: EmailMessageDateRange;
    includeDeletedMessages?: boolean;
    limit?: number;
    nextToken?: string;
    sortOrder?: SortOrder;
}

Hierarchy

  • Pagination
    • ListEmailMessagesInput

Properties

cachePolicy? dateRange? includeDeletedMessages? limit? nextToken? sortOrder?

Properties

Optional cachePolicy

cachePolicy?: CachePolicy

Determines how the email messages will be fetched. Default usage is remoteOnly.

Optional dateRange

dateRange?: EmailMessageDateRange

Email messages matching the specified date range inclusive will be fetched.

Optional includeDeletedMessages

includeDeletedMessages?: boolean

A flag to indicate if deleted messages should be included. Defaults to false.

Optional limit

limit?: number

Optional nextToken

nextToken?: string

Optional sortOrder

sortOrder?: SortOrder

The direction in which the email messages are sorted. Defaults to descending.

Settings

Member Visibility

Theme

On This Page

cachePolicydateRangeincludeDeletedMessageslimitnextTokensortOrder