MailSlurpAPI.Api.WaitForController.wait_for_matching_email

You're seeing just the function wait_for_matching_email, go back to MailSlurpAPI.Api.WaitForController module for more information.
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