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. |
open class func filterBouncedRecipient( filterBouncedRecipientsOptions: FilterBouncedRecipientsOptions) -> Promise<FilterBouncedRecipientsResult>
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
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let filterBouncedRecipientsOptions = FilterBouncedRecipientsOptions(emailRecipients: ["emailRecipients_example"]) // FilterBouncedRecipientsOptions |
// Filter a list of email recipients and remove those who have bounced
BounceControllerAPI.filterBouncedRecipient(filterBouncedRecipientsOptions: filterBouncedRecipientsOptions).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
filterBouncedRecipientsOptions | FilterBouncedRecipientsOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Get a bounced email.
Bounced emails are email you have sent that were rejected by a recipient
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let _id = 987 // UUID | ID of the bounced email to fetch
// Get a bounced email.
BounceControllerAPI.getBouncedEmail(_id: _id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
_id | UUID | ID of the bounced email to fetch |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getBouncedEmails( page: Int? = nil, size: Int? = nil, sort: Sort_getBouncedEmails? = nil, since: Date? = nil, before: Date? = nil) -> Promise<PageBouncedEmail>
Get paginated list of bounced emails.
Bounced emails are email you have sent that were rejected by a recipient
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let page = 987 // Int | Optional page (optional) (default to 0)
let size = 987 // Int | Optional page size (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
// Get paginated list of bounced emails.
BounceControllerAPI.getBouncedEmails(page: page, size: size, sort: sort, since: since, before: before).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page | [optional] [default to 0] |
size | Int | Optional page size | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Get a bounced email.
Bounced emails are email you have sent that were rejected by a recipient
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let _id = 987 // UUID | ID of the bounced recipient
// Get a bounced email.
BounceControllerAPI.getBouncedRecipient(_id: _id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
_id | UUID | ID of the bounced recipient |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getBouncedRecipients( page: Int? = nil, size: Int? = nil, sort: Sort_getBouncedRecipients? = nil, since: Date? = nil, before: Date? = nil) -> Promise<PageBouncedRecipients>
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
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let page = 987 // Int | Optional page (optional) (default to 0)
let size = 987 // Int | Optional page size (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
// Get paginated list of bounced recipients.
BounceControllerAPI.getBouncedRecipients(page: page, size: size, sort: sort, since: since, before: before).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page | [optional] [default to 0] |
size | Int | Optional page size | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getComplaints( page: Int? = nil, size: Int? = nil, sort: Sort_getComplaints? = nil, since: Date? = nil, before: Date? = nil) -> Promise<PageComplaint>
Get paginated list of complaints.
SMTP complaints made against your account
Example
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let page = 987 // Int | Optional page (optional) (default to 0)
let size = 987 // Int | Optional page size (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
// Get paginated list of complaints.
BounceControllerAPI.getComplaints(page: page, size: size, sort: sort, since: since, before: before).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page | [optional] [default to 0] |
size | Int | Optional page size | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getListUnsubscribeRecipients( page: Int? = nil, size: Int? = nil, sort: Sort_getListUnsubscribeRecipients? = nil, domainId: UUID? = nil) -> Promise<PageListUnsubscribeRecipients>
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
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let page = 987 // Int | Optional page (optional) (default to 0)
let size = 987 // Int | Optional page size (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)
let domainId = 987 // UUID | Filter by domainId (optional)
// Get paginated list of unsubscribed recipients.
BounceControllerAPI.getListUnsubscribeRecipients(page: page, size: size, sort: sort, domainId: domainId).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page | [optional] [default to 0] |
size | Int | Optional page size | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
domainId | UUID | Filter by domainId | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]