MailSlurpAPI.Api.BounceController (mailslurp v15.17.22)
API calls for all endpoints tagged BounceController.
Summary
Functions
Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
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.
Get paginated list of complaints. SMTP complaints made against your account
Get paginated list of unsubscribed recipients. Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
Functions
filter_bounced_recipient(connection, filter_bounced_recipients_options, opts \\ [])
@spec filter_bounced_recipient( Tesla.Env.client(), MailSlurpAPI.Model.FilterBouncedRecipientsOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.FilterBouncedRecipientsResult.t()} | {:error, Tesla.Env.t()}
Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- filter_bounced_recipients_options (FilterBouncedRecipientsOptions):
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_bounced_email(connection, id, opts \\ [])
@spec 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
get_bounced_emails(connection, opts \\ [])
@spec 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
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
Returns
} on success {:error, info} on failure
get_bounced_recipient(connection, id, opts \\ [])
@spec 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
get_bounced_recipients(connection, opts \\ [])
@spec 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
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
Returns
} on success {:error, info} on failure
get_complaints(connection, opts \\ [])
@spec get_complaints(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageComplaint.t()} | {:error, Tesla.Env.t()}
Get paginated list of complaints. SMTP complaints made against your account
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
- :since (DateTime.t): Filter by created at after the given timestamp
- :before (DateTime.t): Filter by created at before the given timestamp
Returns
} on success {:error, info} on failure
get_list_unsubscribe_recipients(connection, opts \\ [])
@spec get_list_unsubscribe_recipients(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageListUnsubscribeRecipients.t()} | {:error, Tesla.Env.t()}
Get paginated list of unsubscribed recipients. Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
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
- :domain_id (String.t): Filter by domainId
Returns
} on success {:error, info} on failure