MailSlurp JS

Globals / WaitForConditions

# Namespace: WaitForConditions


namespace WaitForConditions

# Index

# Enumerations

# Properties

# Properties

# count

Optional count: number

Defined in src/generated/api.ts:3808 (opens new window)

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.

memberof WaitForConditions

# countType

Optional countType: CountTypeEnum

Defined in src/generated/api.ts:3814 (opens new window)

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

memberof WaitForConditions

# inboxId

Optional inboxId: string

Defined in src/generated/api.ts:3820 (opens new window)

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

memberof WaitForConditions

# matches

Optional matches: Array<MatchOption>

Defined in src/generated/api.ts:3826 (opens new window)

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.

memberof WaitForConditions

# sortDirection

Optional sortDirection: SortDirectionEnum

Defined in src/generated/api.ts:3832 (opens new window)

Direction to sort matching emails by created time

memberof WaitForConditions

# timeout

Optional timeout: number

Defined in src/generated/api.ts:3838 (opens new window)

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

memberof WaitForConditions

# unreadOnly

Optional unreadOnly: boolean

Defined in src/generated/api.ts:3844 (opens new window)

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.

memberof WaitForConditions