MailSlurpAPI.Api.BounceController (mailslurp v12.8.3)

API calls for all endpoints tagged BounceController.

Link to this section Summary

Functions

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Get paginated list of bounced emails. Bounced emails are email you have sent that were rejected by a recipient

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Get paginated list of bounced recipients. Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

Link to this section Functions

Link to this function

get_bounced_email(connection, id, opts \\ [])

Specs

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

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of the bounced email to fetch
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

get_bounced_emails(connection, opts \\ [])

Specs

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

Get paginated list of bounced emails. Bounced emails are email you have sent that were rejected by a recipient

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index
    • :size (integer()): Optional page size
    • :sort (String.t): Optional createdAt sort direction ASC or DESC

      Returns

} on success {:error, info} on failure

Link to this function

get_bounced_recipient(connection, id, opts \\ [])

Specs

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

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): ID of the bounced recipient
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

get_bounced_recipients(connection, opts \\ [])

Specs

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

Get paginated list of bounced recipients. Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index
    • :size (integer()): Optional page size
    • :sort (String.t): Optional createdAt sort direction ASC or DESC

      Returns

} on success {:error, info} on failure