mailslurp v12.8.4

MailSlurpAPI.Api.MissedEmailController (mailslurp v12.8.4)

API calls for all endpoints tagged MissedEmailController.

Link to this section Summary

Functions

get_all_missed_emails(connection, opts \\ [])

Get all MissedEmails in paginated format

get_missed_email(connection, missed_email_id, opts \\ [])

Get MissedEmail

wait_for_nth_missed_email(connection, opts \\ [])

Wait for Nth missed email Wait for 0 based index missed email

Link to this section Functions

Link to this function

get_all_missed_emails(connection, opts \\ [])

Specs

get_all_missed_emails(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageMissedEmailProjection.t()}
  | {:error, Tesla.Env.t()}

Get all MissedEmails in paginated format

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inbox ID filter
    • :page (integer()): Optional page index in list pagination
    • :search_filter (String.t): Optional search filter
    • :size (integer()): Optional page size in list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC

      Returns

} on success {:error, info} on failure

Link to this function

get_missed_email(connection, missed_email_id, opts \\ [])

Specs

get_missed_email(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.MissedEmail.t()} | {:error, Tesla.Env.t()}

Get MissedEmail

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • missed_email_id (String.t): missedEmailId
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

wait_for_nth_missed_email(connection, opts \\ [])

Specs

wait_for_nth_missed_email(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.MissedEmail.t()} | {:error, Tesla.Env.t()}

Wait for Nth missed email Wait for 0 based index missed email

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :inbox_id (String.t): Optional inbox ID filter
    • :index (integer()): Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1
    • :timeout (integer()): Optional timeout milliseconds

      Returns

} on success {:error, info} on failure