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

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = BounceControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of the bounced email to fetch
try {
    val result : BouncedEmailDto = apiInstance.getBouncedEmail(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BounceControllerApi#getBouncedEmail")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BounceControllerApi#getBouncedEmail")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
idjava.util.UUIDID of the bounced email to fetch

Return type

BouncedEmailDto

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-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

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = BounceControllerApi()
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val page : kotlin.Int = 56 // kotlin.Int | Optional page  
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
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
try {
    val result : PageBouncedEmail = apiInstance.getBouncedEmails(before, page, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BounceControllerApi#getBouncedEmails")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BounceControllerApi#getBouncedEmails")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
pagekotlin.IntOptional page[optional] [default to 0]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
sizekotlin.IntOptional page size[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageBouncedEmail

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-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

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = BounceControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | ID of the bounced recipient
try {
    val result : BouncedRecipientDto = apiInstance.getBouncedRecipient(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BounceControllerApi#getBouncedRecipient")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BounceControllerApi#getBouncedRecipient")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
idjava.util.UUIDID of the bounced recipient

Return type

BouncedRecipientDto

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-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.

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = BounceControllerApi()
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val page : kotlin.Int = 56 // kotlin.Int | Optional page  
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
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
try {
    val result : PageBouncedRecipients = apiInstance.getBouncedRecipients(before, page, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BounceControllerApi#getBouncedRecipients")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BounceControllerApi#getBouncedRecipients")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
pagekotlin.IntOptional page[optional] [default to 0]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
sizekotlin.IntOptional page size[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageBouncedRecipients

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-api-key”] = ""

HTTP request headers

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