Skip to content

Latest commit

 

History

History
20 lines (15 loc) · 2.25 KB

WaitForConditions.md

File metadata and controls

20 lines (15 loc) · 2.25 KB

WaitForConditions

Properties

Name Type Description Notes
InboxId string ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.
Count Pointer to int32 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. [optional]
DelayTimeout Pointer to int64 Max time in milliseconds to wait between retries if a `timeout` is specified. [optional]
Timeout int64 Max time in milliseconds to retry the `waitFor` operation until conditions are met.
UnreadOnly Pointer to bool 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. [optional]
CountType Pointer to string How result size should be compared with the expected size. Exactly or at-least matching result? [optional]
Matches Pointer to []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]
SortDirection Pointer to string Direction to sort matching emails by created time [optional]
Since Pointer to time.Time ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date [optional]
Before Pointer to time.Time ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date [optional]

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