MailSlurpAPI.Api.WaitForController (mailslurp v11.7.200)

API calls for all endpoints tagged WaitForController.

Link to this section Summary

Functions

Wait for conditions to be met 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 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 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 proved 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 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.

Link to this section Functions

Link to this function

wait_for(connection, opts \\ [])

Specs

wait_for(Tesla.Env.client(), keyword()) ::
  {:ok, [MailSlurpAPI.Model.EmailPreview.t()]} | {:error, Tesla.Env.t()}

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

Parameters

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

      Returns

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

Link to this function

wait_for_email_count(connection, opts \\ [])

Specs

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

Wait for and return count number of emails 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

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :count (integer()): Number of emails to wait for. Must be greater that 1
    • :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

      Returns

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

Link to this function

wait_for_latest_email(connection, opts \\ [])

Specs

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

  • 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.

      Returns

} on success {:error, info} on failure

Link to this function

wait_for_matching_email(connection, match_options, opts \\ [])

Specs

wait_for_matching_email(
  Tesla.Env.client(),
  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

  • connection (MailSlurpAPI.Connection): Connection to server
  • match_options (MatchOptions): matchOptions
  • opts (KeywordList): [optional] Optional parameters
    • :count (integer()): Number of emails to wait for. Must be greater that 1
    • :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

      Returns

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

Link to this function

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

Specs

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

Wait for or return the first email that matches proved 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

  • connection (MailSlurpAPI.Connection): Connection to server
  • match_options (MatchOptions): matchOptions
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Id of the inbox we are matching an email for
    • :timeout (integer()): Max milliseconds to wait
    • :unread_only (boolean()): Optional filter for unread only

      Returns

} on success {:error, info} on failure

Link to this function

wait_for_nth_email(connection, opts \\ [])

Specs

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 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

  • 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

      Returns

} on success {:error, info} on failure