@sudoplatform/sudo-email
    Preparing search index...

    Interface ListEmailMessagesInput

    Input for SudoEmailClient.listEmailMessages.

    ListEmailMessagesInput

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    cachePolicy?: CachePolicy

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

    dateRange?: EmailMessageDateRange

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

    includeDeletedMessages?: boolean

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

    limit?: number

    Number of items to return. Will be defaulted if omitted.

    nextToken?: string

    A token generated by a previous call.

    sortOrder?: SortOrder

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

    Settings

    Member Visibility

    On This Page

    Properties