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.

Properties

NameTypeDescriptionNotes
beforedatetimeISO Date Time latest time of email to consider. Filter for matching emails that were received before this date[optional]
countintNumber 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.[optional]
count_typestrHow should the found count be compared to the expected count.[optional]
delay_timeoutintMax time in milliseconds to wait between retries if a timeout is specified.[optional]
inbox_idstrID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.
matches**list[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.[optional]
sincedatetimeISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date[optional]
sort_directionstrDirection to sort matching emails by created time[optional]
timeoutintMax time in milliseconds to retry the waitFor operation until conditions are met.
unread_onlyboolApply 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.[optional]

[Back to Model list] [Back to API list] [Back to ]