MailSlurpClient::WaitForConditions

Properties

NameTypeDescriptionNotes
beforeDateTimeISO Date Time latest time of email to consider. Filter for matching emails that were received before this date[optional]
countIntegerNumber 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_typeStringHow should the found count be compared to the expected count.[optional]
delay_timeoutIntegerMax time in milliseconds to wait between retries if a timeout is specified.[optional]
inbox_idStringID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.
matchesArrayConditions 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_directionStringDirection to sort matching emails by created time[optional]
timeoutIntegerMax time in milliseconds to retry the waitFor operation until conditions are met.
unread_onlyBooleanApply 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]

Code Sample

require 'MailSlurpClient'

instance = MailSlurpClient::WaitForConditions.new(before: null,
                                 count: null,
                                 count_type: null,
                                 delay_timeout: null,
                                 inbox_id: null,
                                 matches: null,
                                 since: null,
                                 sort_direction: null,
                                 timeout: null,
                                 unread_only: null)