MailSlurp JS / WaitForConditions

Interface: WaitForConditions

Conditions that a waitForXEmails endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately. Can include unreadOnly to ignore already read emails that were returned in an API call or viewing in the dashboard. Can also include matches for emails containing from, subject, hasAttachments etc.

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

Defined in

src/generated/api.ts:6134


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

Defined in

src/generated/api.ts:6140


countType

Optional countType: CountTypeEnum

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

memberof WaitForConditions

Defined in

src/generated/api.ts:6146


delayTimeout

Optional delayTimeout: number

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

memberof WaitForConditions

Defined in

src/generated/api.ts:6152


inboxId

inboxId: string

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

memberof WaitForConditions

Defined in

src/generated/api.ts:6158


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

Defined in

src/generated/api.ts:6164


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

Defined in

src/generated/api.ts:6170


sortDirection

Optional sortDirection: SortDirectionEnum

Direction to sort matching emails by created time

memberof WaitForConditions

Defined in

src/generated/api.ts:6176


timeout

timeout: number

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

memberof WaitForConditions

Defined in

src/generated/api.ts:6182


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

Defined in

src/generated/api.ts:6188