# Module: WaitForConditions

export

namespace WaitForConditions

# Properties

# Optional count

count? : number

Defined in src/generated/api.ts:2373

Number of results that should match conditions. Either exactly or at least this amount based on the countType. If count condition is not met and the timeout has not been reached the waitFor method will retry the operation.

type {number}

memberof WaitForConditions


# Optional countType

countType? : CountTypeEnum

Defined in src/generated/api.ts:2379

How should the found count be compared to the expected count.

type {string}

memberof WaitForConditions


# Optional inboxId

inboxId? : string

Defined in src/generated/api.ts:2385

ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.

type {string}

memberof WaitForConditions


# Optional matches

matches? : Array‹MatchOption

Defined in src/generated/api.ts:2391

Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.

type {Array‹MatchOption›}

memberof WaitForConditions


# Optional sortDirection

sortDirection? : SortDirectionEnum

Defined in src/generated/api.ts:2397

Direction to sort matching emails by created time

type {string}

memberof WaitForConditions


# Optional timeout

timeout? : number

Defined in src/generated/api.ts:2403

Max time in milliseconds to retry the waitFor operation until conditions are met.

type {number}

memberof WaitForConditions


# Optional unreadOnly

unreadOnly? : boolean

Defined in src/generated/api.ts:2409

Apply conditions only to unread emails. All emails begin with read=false. An email is marked read=true when an EmailDto representation of it has been returned to the user at least once. For example you have called getEmail or waitForLatestEmail etc., or you have viewed the email in the dashboard.

type {boolean}

memberof WaitForConditions