BounceControllerApi
All URIs are relative to https://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. |
| getListUnsubscribeRecipients | GET /bounce/list-unsubscribe-recipients | Get paginated list of unsubscribed recipients. |
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
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val filterBouncedRecipientsOptions : FilterBouncedRecipientsOptions = // FilterBouncedRecipientsOptions |
val result : FilterBouncedRecipientsResult = webService.filterBouncedRecipient(filterBouncedRecipientsOptions)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| filterBouncedRecipientsOptions | FilterBouncedRecipientsOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
Get a bounced email.
Bounced emails are email you have sent that were rejected by a recipient
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of the bounced email to fetch
val result : BouncedEmailDto = webService.getBouncedEmail(id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID | ID of the bounced email to fetch |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get paginated list of bounced emails.
Bounced emails are email you have sent that were rejected by a recipient
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page
val size : kotlin.Int = 56 // kotlin.Int | Optional page size
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val result : PageBouncedEmail = webService.getBouncedEmails(page, size, sort, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | kotlin.Int | Optional page | [optional] [default to 0] |
| size | kotlin.Int | Optional page size | [optional] [default to 20] |
| sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
| since | java.time.OffsetDateTime | Filter by created at after the given timestamp | [optional] |
| before | java.time.OffsetDateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get a bounced email.
Bounced emails are email you have sent that were rejected by a recipient
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of the bounced recipient
val result : BouncedRecipientDto = webService.getBouncedRecipient(id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | java.util.UUID | ID of the bounced recipient |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
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.
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page
val size : kotlin.Int = 56 // kotlin.Int | Optional page size
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val result : PageBouncedRecipients = webService.getBouncedRecipients(page, size, sort, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | kotlin.Int | Optional page | [optional] [default to 0] |
| size | kotlin.Int | Optional page size | [optional] [default to 20] |
| sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
| since | java.time.OffsetDateTime | Filter by created at after the given timestamp | [optional] |
| before | java.time.OffsetDateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get paginated list of complaints.
SMTP complaints made against your account
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page
val size : kotlin.Int = 56 // kotlin.Int | Optional page size
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val result : PageComplaint = webService.getComplaints(page, size, sort, since, before)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | kotlin.Int | Optional page | [optional] [default to 0] |
| size | kotlin.Int | Optional page size | [optional] [default to 20] |
| sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
| since | java.time.OffsetDateTime | Filter by created at after the given timestamp | [optional] |
| before | java.time.OffsetDateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get paginated list of unsubscribed recipients.
Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(BounceControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page
val size : kotlin.Int = 56 // kotlin.Int | Optional page size
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
val domainId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Filter by domainId
val result : PageListUnsubscribeRecipients = webService.getListUnsubscribeRecipients(page, size, sort, domainId)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | kotlin.Int | Optional page | [optional] [default to 0] |
| size | kotlin.Int | Optional page size | [optional] [default to 20] |
| sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
| domainId | java.util.UUID | Filter by domainId | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /