Skip to content

MailSlurp\BounceControllerApi

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

Method HTTP request Description
FilterBouncedRecipient Post /bounce/filter-recipients Filter a list of email recipients and remove those who have bounced
GetBouncedEmail Get /bounce/emails/{id} Get a bounced email.
GetBouncedEmails Get /bounce/emails Get paginated list of bounced emails.
GetBouncedRecipient Get /bounce/recipients/{id} Get a bounced email.
GetBouncedRecipients Get /bounce/recipients Get paginated list of bounced recipients.
GetComplaints Get /bounce/complaints Get paginated list of complaints.

FilterBouncedRecipient

FilterBouncedRecipientsResult FilterBouncedRecipient(ctx, filterBouncedRecipientsOptions)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
filterBouncedRecipientsOptions FilterBouncedRecipientsOptions

Return type

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 ]

GetBouncedEmail

BouncedEmailDto GetBouncedEmail(ctx, id)

Get a bounced email.

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of the bounced email to fetch

Return type

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 ]

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

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetBouncedEmailsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetBouncedEmailsOpts struct

Name Type Description Notes
page optional.Int32 Optional page [default to 0]
size optional.Int32 Optional page size [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]

GetBouncedRecipient

BouncedRecipientDto GetBouncedRecipient(ctx, id)

Get a bounced email.

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of the bounced recipient

Return type

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 ]

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

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetBouncedRecipientsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetBouncedRecipientsOpts struct

Name Type Description Notes
page optional.Int32 Optional page [default to 0]
size optional.Int32 Optional page size [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]

GetComplaints

PageComplaint GetComplaints(ctx, optional)

Get paginated list of complaints.

SMTP complaints made against your account

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetComplaintsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetComplaintsOpts struct

Name Type Description Notes
page optional.Int32 Optional page [default to 0]
size optional.Int32 Optional page size [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]