Skip to content

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 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 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 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. [optional]
CountType String How result size should be compared with the expected size. Exactly or at-least matching result? [optional]
VarMatches 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 String Direction to sort matching emails by created time [optional]
Since System.DateTime ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date [optional]
Before System.DateTime ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date [optional]

Examples

  • Prepare the resource
$WaitForConditions = Initialize-maislurp-client-powershellWaitForConditions  -InboxId null `
 -Count null `
 -DelayTimeout null `
 -Timeout null `
 -UnreadOnly null `
 -CountType null `
 -VarMatches null `
 -SortDirection null `
 -Since null `
 -Before null
  • Convert the resource to JSON
$WaitForConditions | ConvertTo-JSON

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