Interface SearchEmailsOptions

Export

Interface

SearchEmailsOptions

Hierarchy

  • SearchEmailsOptions

Properties

before? inboxIds? pageIndex? pageSize? searchFilter? since? sortDirection? unreadOnly?

Properties

Optional before

before?: Date

Optional filter emails received before given date time

Memberof

SearchEmailsOptions

Optional inboxIds

inboxIds?: string[]

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.

Memberof

SearchEmailsOptions

Optional pageIndex

pageIndex?: number

Optional page index in email list pagination

Memberof

SearchEmailsOptions

Optional pageSize

pageSize?: number

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results

Memberof

SearchEmailsOptions

Optional searchFilter

searchFilter?: string

Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body

Memberof

SearchEmailsOptions

Optional since

since?: Date

Optional filter emails received after given date time

Memberof

SearchEmailsOptions

Optional sortDirection

sortDirection?: SearchEmailsOptionsSortDirectionEnum

Optional createdAt sort direction ASC or DESC

Memberof

SearchEmailsOptions

Optional unreadOnly

unreadOnly?: boolean

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly

Memberof

SearchEmailsOptions

Settings

Member Visibility

Theme