MailSlurpAPI.Api.WaitForController.wait_for_latest_email

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