Module mailslurp::apis::wait_for_controller_api

Structs

WaitForEmailCountParams	struct for passing parameters to the method wait_for_email_count
WaitForLatestEmailParams	struct for passing parameters to the method wait_for_latest_email
WaitForMatchingEmailParams	struct for passing parameters to the method wait_for_matching_email
WaitForMatchingFirstEmailParams	struct for passing parameters to the method wait_for_matching_first_email
WaitForNthEmailParams	struct for passing parameters to the method wait_for_nth_email
WaitForParams	struct for passing parameters to the method wait_for

Enums

WaitForEmailCountError	struct for typed errors of method wait_for_email_count
WaitForError	struct for typed errors of method wait_for
WaitForLatestEmailError	struct for typed errors of method wait_for_latest_email
WaitForMatchingEmailError	struct for typed errors of method wait_for_matching_email
WaitForMatchingFirstEmailError	struct for typed errors of method wait_for_matching_first_email
WaitForNthEmailError	struct for typed errors of method wait_for_nth_email

Functions

wait_for	Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met
wait_for_email_count	If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.
wait_for_latest_email	Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set unreadOnly=true or see the other receive methods such as waitForNthEmail or waitForEmailCount.
wait_for_matching_email	Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch method.
wait_for_matching_first_email	Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch method.
wait_for_nth_email	If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.