Skip to content

Interface: WaitForConditions

Conditions to apply to emails that you are waiting for

export

interface WaitForConditions

Table of contents

Properties

Properties

before

Optional before: Date

ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date

memberof WaitForConditions


count

Optional count: number

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: WaitForConditionsCountTypeEnum

How result size should be compared with the expected size. Exactly or at-least matching result?

memberof WaitForConditions


delayTimeout

Optional delayTimeout: number

Max time in milliseconds to wait between retries if a timeout is specified.

memberof WaitForConditions


inboxId

inboxId: string

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

memberof WaitForConditions


matches

Optional matches: MatchOption[]

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


since

Optional since: Date

ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date

memberof WaitForConditions


sortDirection

Optional sortDirection: WaitForConditionsSortDirectionEnum

Direction to sort matching emails by created time

memberof WaitForConditions


timeout

timeout: number

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

memberof WaitForConditions


unreadOnly

Optional unreadOnly: boolean

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