MailSlurpBounceControllerApi

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(ctx, id)

Get a bounced email.

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringID of the bounced email to fetch

Return type

BouncedEmailDto

Authorization

API_KEY

HTTP request headers

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

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

GetBouncedEmails

PageBouncedEmail GetBouncedEmails(ctx, optional)

Get paginated list of bounced emails.

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetBouncedEmailsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetBouncedEmailsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
pageoptional.Int32Optional page[default to 0]
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

PageBouncedEmail

Authorization

API_KEY

HTTP request headers

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

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

GetBouncedRecipient

BouncedRecipientDto GetBouncedRecipient(ctx, id)

Get a bounced email.

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringID of the bounced recipient

Return type

BouncedRecipientDto

Authorization

API_KEY

HTTP request headers

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

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

GetBouncedRecipients

PageBouncedRecipients GetBouncedRecipients(ctx, optional)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetBouncedRecipientsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetBouncedRecipientsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
pageoptional.Int32Optional page[default to 0]
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

PageBouncedRecipients

Authorization

API_KEY

HTTP request headers

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

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