MailSlurpAPI.Api.MissedEmailController (mailslurp v15.4.1)
API calls for all endpoints tagged MissedEmailController
.
Link to this section Summary
Functions
Get all MissedEmails in paginated format
Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
Get MissedEmail
Wait for Nth missed email Wait for 0 based index missed email
Link to this section Functions
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
- :page (integer()): Optional page index in list pagination
- :size (integer()): Optional page size in list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
- :inbox_id (String.t): Optional inbox ID filter
Returns
} on success {:error, info} on failure
get_all_unknown_missed_emails(connection, opts \\ [])
Specs
get_all_unknown_missed_emails(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageUnknownMissedEmailProjection.t()} | {:error, Tesla.Env.t()}
Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :page (integer()): Optional page index in list pagination
- :size (integer()): Optional page size in list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
- :inbox_id (String.t): Optional inbox ID filter
Returns
} on success {:error, info} on failure
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):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
wait_for_nth_missed_email(connection, index, opts \\ [])
Specs
wait_for_nth_missed_email(Tesla.Env.client(), integer(), 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
- 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
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure