Interface SearchInboxesOptions

Export

Interface

SearchInboxesOptions

Hierarchy

  • SearchInboxesOptions

Properties

before? domainId? favourite? inboxFunction? inboxType? pageIndex? pageSize? search? since? sortDirection? tag?

Properties

Optional before

before?: Date

Optional filter by created before given date time

Memberof

SearchInboxesOptions

Optional domainId

domainId?: string

Optional domain ID filter

Memberof

SearchInboxesOptions

Optional favourite

favourite?: boolean

Optionally filter results for favourites only

Memberof

SearchInboxesOptions

Optional inboxFunction

inboxFunction?: SearchInboxesOptionsInboxFunctionEnum

Optional filter by inbox function

Memberof

SearchInboxesOptions

Optional inboxType

inboxType?: SearchInboxesOptionsInboxTypeEnum

Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).

Memberof

SearchInboxesOptions

Optional pageIndex

pageIndex?: number

Optional page index in list pagination

Memberof

SearchInboxesOptions

Optional pageSize

pageSize?: number

Optional page size in list pagination

Memberof

SearchInboxesOptions

Optional search

search?: string

Optionally filter by search words partial matching ID, tags, name, and email address

Memberof

SearchInboxesOptions

Optional since

since?: Date

Optional filter by created after given date time

Memberof

SearchInboxesOptions

Optional sortDirection

sortDirection?: SearchInboxesOptionsSortDirectionEnum

Optional createdAt sort direction ASC or DESC

Memberof

SearchInboxesOptions

Optional tag

tag?: string

Optionally filter by tags. Will return inboxes that include given tags

Memberof

SearchInboxesOptions

Settings

Member Visibility

Theme