Skip to content

\WaitForControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
wait_for post /waitFor Wait for an email to match the provided filter conditions such as subject contains keyword.
wait_for_email_count get /waitForEmailCount Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
wait_for_latest_email get /waitForLatestEmail Fetch inbox's latest email or if empty wait for an email to arrive
wait_for_latest_sms post /waitForLatestSms Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.
wait_for_matching_emails post /waitForMatchingEmails Wait or return list of emails that match simple matching patterns
wait_for_matching_first_email post /waitForMatchingFirstEmail Wait for or return the first email that matches provided MatchOptions array
wait_for_nth_email get /waitForNthEmail Wait for or fetch the email with a given in the inbox specified. If doesn't exist waits for it to exist or timeout to occur.
wait_for_sms post /waitForSms Wait for an SMS message to match the provided filter conditions such as body contains keyword.

wait_for

Vec wait_for(wait_for_conditions) Wait for an email to match the provided filter conditions such as subject contains keyword.

Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

Parameters

Name Type Description Required Notes
wait_for_conditions WaitForConditions [required]

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

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

wait_for_email_count

Vec wait_for_email_count(inbox_id, count, timeout, unread_only, before, since, sort, delay) Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

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.

Parameters

Name Type Description Required Notes
inbox_id String Id of the inbox we are fetching emails from [required]
count i32 Number of emails to wait for. Must be greater that 1 [required]
timeout Option<i64> Max milliseconds to wait
unread_only Option<bool> Optional filter for unread only [default to false]
before Option<String> Filter for emails that were received before the given timestamp
since Option<String> Filter for emails that were received after the given timestamp
sort Option<String> Sort direction
delay Option<i64> Max milliseconds delay between calls

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

wait_for_latest_email

crate::models::Email wait_for_latest_email(inbox_id, timeout, unread_only, before, since, sort, delay) Fetch inbox's latest email or if empty wait for an email to arrive

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.

Parameters

Name Type Description Required Notes
inbox_id Option<String> Id of the inbox we are fetching emails from
timeout Option<i64> Max milliseconds to wait
unread_only Option<bool> Optional filter for unread only. [default to false]
before Option<String> Filter for emails that were before after the given timestamp
since Option<String> Filter for emails that were received after the given timestamp
sort Option<String> Sort direction
delay Option<i64> Max milliseconds delay between calls

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

wait_for_latest_sms

crate::models::SmsDto wait_for_latest_sms(wait_for_single_sms_options) Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.

Wait until a phone number meets given conditions or return immediately if already met

Parameters

Name Type Description Required Notes
wait_for_single_sms_options WaitForSingleSmsOptions [required]

Return type

crate::models::SmsDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

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

wait_for_matching_emails

Vec wait_for_matching_emails(inbox_id, count, match_options, before, since, sort, delay, timeout, unread_only) Wait or return list of emails that match simple matching patterns

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.

Parameters

Name Type Description Required Notes
inbox_id String Id of the inbox we are fetching emails from [required]
count i32 Number of emails to wait for. Must be greater or equal to 1 [required]
match_options MatchOptions [required]
before Option<String> Filter for emails that were received before the given timestamp
since Option<String> Filter for emails that were received after the given timestamp
sort Option<String> Sort direction
delay Option<i64> Max milliseconds delay between calls
timeout Option<i64> Max milliseconds to wait
unread_only Option<bool> Optional filter for unread only [default to false]

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

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

wait_for_matching_first_email

crate::models::Email wait_for_matching_first_email(inbox_id, match_options, timeout, unread_only, since, before, sort, delay) Wait for or return the first email that matches provided MatchOptions array

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.

Parameters

Name Type Description Required Notes
inbox_id String Id of the inbox we are matching an email for [required]
match_options MatchOptions [required]
timeout Option<i64> Max milliseconds to wait
unread_only Option<bool> Optional filter for unread only [default to false]
since Option<String> Filter for emails that were received after the given timestamp
before Option<String> Filter for emails that were received before the given timestamp
sort Option<String> Sort direction
delay Option<i64> Max milliseconds delay between calls

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

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

wait_for_nth_email

crate::models::Email wait_for_nth_email(inbox_id, , timeout, unread_only, since, before, sort, delay) Wait for or fetch the email with a given in the inbox specified. If doesn't exist waits for it to exist or timeout to occur.

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.

Parameters

Name Type Description Required Notes
inbox_id Option<String> Id of the inbox you are fetching emails from
**** Option<i32> Zero based of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1 [default to 0]
timeout Option<i64> Max milliseconds to wait for the nth email if not already present
unread_only Option<bool> Optional filter for unread only [default to false]
since Option<String> Filter for emails that were received after the given timestamp
before Option<String> Filter for emails that were received before the given timestamp
sort Option<String> Sort direction
delay Option<i64> Max milliseconds delay between calls

Return type

crate::models::Email

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

wait_for_sms

Vec wait_for_sms(wait_for_sms_conditions) Wait for an SMS message to match the provided filter conditions such as body contains keyword.

Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met

Parameters

Name Type Description Required Notes
wait_for_sms_conditions WaitForSmsConditions [required]

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

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