MailSlurpAPI.Api.WaitForController (mailslurp v15.14.0)

API calls for all endpoints tagged WaitForController.

Link to this section Summary

Functions

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

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.

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.

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

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.

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.

Wait for or fetch the email with a given index in the inbox specified. If index 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.

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

Link to this section Functions

Link to this function

wait_for(connection, wait_for_conditions, opts \\ [])

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • wait_for_conditions (WaitForConditions):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

, ...]} on success {:error, info} on failure

Link to this function

wait_for_email_count(connection, inbox_id, count, opts \\ [])

@spec wait_for_email_count(Tesla.Env.client(), String.t(), integer(), keyword()) ::
  {:ok, [MailSlurpAPI.Model.EmailPreview.t()]} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): Id of the inbox we are fetching emails from
  • count (integer()): Number of emails to wait for. Must be greater that 1
  • opts (KeywordList): [optional] Optional parameters
    • :timeout (integer()): Max milliseconds to wait
    • :unread_only (boolean()): Optional filter for unread only
    • :before (DateTime.t): Filter for emails that were received before the given timestamp
    • :since (DateTime.t): Filter for emails that were received after the given timestamp
    • :sort (String.t): Sort direction
    • :delay (integer()): Max milliseconds delay between calls

returns

Returns

, ...]} on success {:error, info} on failure

Link to this function

wait_for_latest_email(connection, opts \\ [])

@spec wait_for_latest_email(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.Email.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Id of the inbox we are fetching emails from
    • :timeout (integer()): Max milliseconds to wait
    • :unread_only (boolean()): Optional filter for unread only.
    • :before (DateTime.t): Filter for emails that were before after the given timestamp
    • :since (DateTime.t): Filter for emails that were received after the given timestamp
    • :sort (String.t): Sort direction
    • :delay (integer()): Max milliseconds delay between calls

returns

Returns

} on success {:error, info} on failure

Link to this function

wait_for_latest_sms(connection, wait_for_single_sms_options, opts \\ [])

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • wait_for_single_sms_options (WaitForSingleSmsOptions):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

} on success {:error, info} on failure

Link to this function

wait_for_matching_emails(connection, inbox_id, count, match_options, opts \\ [])

@spec wait_for_matching_emails(
  Tesla.Env.client(),
  String.t(),
  integer(),
  MailSlurpAPI.Model.MatchOptions.t(),
  keyword()
) :: {:ok, [MailSlurpAPI.Model.EmailPreview.t()]} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): Id of the inbox we are fetching emails from
  • count (integer()): Number of emails to wait for. Must be greater or equal to 1
  • match_options (MatchOptions):
  • opts (KeywordList): [optional] Optional parameters
    • :before (DateTime.t): Filter for emails that were received before the given timestamp
    • :since (DateTime.t): Filter for emails that were received after the given timestamp
    • :sort (String.t): Sort direction
    • :delay (integer()): Max milliseconds delay between calls
    • :timeout (integer()): Max milliseconds to wait
    • :unread_only (boolean()): Optional filter for unread only

returns

Returns

, ...]} on success {:error, info} on failure

Link to this function

wait_for_matching_first_email(connection, inbox_id, match_options, opts \\ [])

@spec wait_for_matching_first_email(
  Tesla.Env.client(),
  String.t(),
  MailSlurpAPI.Model.MatchOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.Email.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • inbox_id (String.t): Id of the inbox we are matching an email for
  • match_options (MatchOptions):
  • opts (KeywordList): [optional] Optional parameters
    • :timeout (integer()): Max milliseconds to wait
    • :unread_only (boolean()): Optional filter for unread only
    • :since (DateTime.t): Filter for emails that were received after the given timestamp
    • :before (DateTime.t): Filter for emails that were received before the given timestamp
    • :sort (String.t): Sort direction
    • :delay (integer()): Max milliseconds delay between calls

returns

Returns

} on success {:error, info} on failure

Link to this function

wait_for_nth_email(connection, opts \\ [])

@spec wait_for_nth_email(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.Email.t()} | {:error, Tesla.Env.t()}

Wait for or fetch the email with a given index in the inbox specified. If index 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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Id of the inbox you are fetching emails from
    • :index (integer()): Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1
    • :timeout (integer()): Max milliseconds to wait for the nth email if not already present
    • :unread_only (boolean()): Optional filter for unread only
    • :since (DateTime.t): Filter for emails that were received after the given timestamp
    • :before (DateTime.t): Filter for emails that were received before the given timestamp
    • :sort (String.t): Sort direction
    • :delay (integer()): Max milliseconds delay between calls

returns

Returns

} on success {:error, info} on failure

Link to this function

wait_for_sms(connection, wait_for_sms_conditions, opts \\ [])

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

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • wait_for_sms_conditions (WaitForSmsConditions):
  • opts (KeywordList): [optional] Optional parameters

returns

Returns

, ...]} on success {:error, info} on failure