BounceControllerApi

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

MethodHTTP requestDescription
getBouncedEmailGET /bounce/emails/{id}Get a bounced email.
getBouncedEmailsGET /bounce/emailsGet paginated list of bounced emails.
getBouncedRecipientGET /bounce/recipients/{id}Get a bounced email.
getBouncedRecipientsGET /bounce/recipientsGet paginated list of bounced recipients.

getBouncedEmail

BouncedEmailDto getBouncedEmail(id)

Get a bounced email.

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

Parameters

NameTypeDescriptionNotes
idUUIDID of the bounced email to fetch[default to null]

Return type

BouncedEmailDto

Authorization

API_KEY

HTTP request headers

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

getBouncedEmails

PageBouncedEmail getBouncedEmails(before, page, since, size, sort)

Get paginated list of bounced emails.

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

Parameters

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional] [default to null]
pageIntegerOptional page[optional] [default to 0]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
sizeIntegerOptional page size[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageBouncedEmail

Authorization

API_KEY

HTTP request headers

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

getBouncedRecipient

BouncedRecipientDto getBouncedRecipient(id)

Get a bounced email.

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

Parameters

NameTypeDescriptionNotes
idUUIDID of the bounced recipient[default to null]

Return type

BouncedRecipientDto

Authorization

API_KEY

HTTP request headers

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

getBouncedRecipients

PageBouncedRecipients getBouncedRecipients(before, page, since, size, sort)

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

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional] [default to null]
pageIntegerOptional page[optional] [default to 0]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
sizeIntegerOptional page size[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageBouncedRecipients

Authorization

API_KEY

HTTP request headers

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