Skip to content

\BounceControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
filter_bounced_recipient post /bounce/filter-recipients Filter a list of email recipients and remove those who have bounced
get_bounced_email get /bounce/emails/{id} Get a bounced email.
get_bounced_emails get /bounce/emails Get paginated list of bounced emails.
get_bounced_recipient get /bounce/recipients/{id} Get a bounced email.
get_bounced_recipients get /bounce/recipients Get paginated list of bounced recipients.
get_complaints get /bounce/complaints Get paginated list of complaints.

filter_bounced_recipient

crate::models::FilterBouncedRecipientsResult filter_bounced_recipient(filter_bounced_recipients_options) 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

Name Type Description Required Notes
filter_bounced_recipients_options FilterBouncedRecipientsOptions [required]

Return type

crate::models::FilterBouncedRecipientsResult

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_bounced_email

crate::models::BouncedEmailDto get_bounced_email(id) Get a bounced email.

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

Parameters

Name Type Description Required Notes
id String ID of the bounced email to fetch [required]

Return type

crate::models::BouncedEmailDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_bounced_emails

crate::models::PageBouncedEmail get_bounced_emails(page, size, sort, since, before) Get paginated list of bounced emails.

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

Parameters

Name Type Description Required Notes
page Option<i32> Optional page [default to 0]
size Option<i32> Optional page size [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageBouncedEmail

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_bounced_recipient

crate::models::BouncedRecipientDto get_bounced_recipient(id) Get a bounced email.

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

Parameters

Name Type Description Required Notes
id String ID of the bounced recipient [required]

Return type

crate::models::BouncedRecipientDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_bounced_recipients

crate::models::PageBouncedRecipients get_bounced_recipients(page, size, sort, since, before) 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

Name Type Description Required Notes
page Option<i32> Optional page [default to 0]
size Option<i32> Optional page size [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageBouncedRecipients

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_complaints

crate::models::PageComplaint get_complaints(page, size, sort, since, before) Get paginated list of complaints.

SMTP complaints made against your account

Parameters

Name Type Description Required Notes
page Option<i32> Optional page [default to 0]
size Option<i32> Optional page size [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageComplaint

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]