SentEmailsControllerApi

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

MethodHTTP requestDescription
getAllSentTrackingPixelsGET /sent/tracking-pixelsGet all sent email tracking pixels in paginated form
getSentEmailGET /sent/{id}Get sent email receipt
getSentEmailHTMLContentGET /sent/{id}/htmlGet sent email HTML content
getSentEmailTrackingPixelsGET /sent/{id}/tracking-pixelsGet all tracking pixels for a sent email in paginated form
getSentEmailsGET /sentGet all sent emails in paginated form
getSentOrganizationEmailsGET /sent/organizationGet all sent organization emails in paginated form

getAllSentTrackingPixels

PageTrackingPixelProjection getAllSentTrackingPixels(before, page, searchFilter, since, size, sort)

Get all sent email tracking pixels in paginated form

Example

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

val apiInstance = SentEmailsControllerApi()
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  in sent email tracking pixel list pagination
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 in sent email tracking pixel list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
try {
    val result : PageTrackingPixelProjection = apiInstance.getAllSentTrackingPixels(before, page, searchFilter, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SentEmailsControllerApi#getAllSentTrackingPixels")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SentEmailsControllerApi#getAllSentTrackingPixels")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
pagekotlin.IntOptional page in sent email tracking pixel list pagination[optional] [default to 0]
searchFilterkotlin.StringOptional search filter[optional]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
sizekotlin.IntOptional page size in sent email tracking pixel list pagination[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageTrackingPixelProjection

Authorization

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

HTTP request headers

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

getSentEmail

SentEmailDto getSentEmail(id)

Get sent email receipt

Example

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

val apiInstance = SentEmailsControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | id
try {
    val result : SentEmailDto = apiInstance.getSentEmail(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SentEmailsControllerApi#getSentEmail")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SentEmailsControllerApi#getSentEmail")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
idjava.util.UUIDid

Return type

SentEmailDto

Authorization

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

HTTP request headers

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

getSentEmailHTMLContent

kotlin.String getSentEmailHTMLContent(id)

Get sent email HTML content

Example

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

val apiInstance = SentEmailsControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | id
try {
    val result : kotlin.String = apiInstance.getSentEmailHTMLContent(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SentEmailsControllerApi#getSentEmailHTMLContent")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SentEmailsControllerApi#getSentEmailHTMLContent")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
idjava.util.UUIDid

Return type

kotlin.String

Authorization

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

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

getSentEmailTrackingPixels

PageTrackingPixelProjection getSentEmailTrackingPixels(id, before, page, searchFilter, since, size, sort)

Get all tracking pixels for a sent email in paginated form

Example

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

val apiInstance = SentEmailsControllerApi()
val id : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | id
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  in sent email tracking pixel list pagination
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 in sent email tracking pixel list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
try {
    val result : PageTrackingPixelProjection = apiInstance.getSentEmailTrackingPixels(id, before, page, searchFilter, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SentEmailsControllerApi#getSentEmailTrackingPixels")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SentEmailsControllerApi#getSentEmailTrackingPixels")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
idjava.util.UUIDid
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
pagekotlin.IntOptional page in sent email tracking pixel list pagination[optional] [default to 0]
searchFilterkotlin.StringOptional search filter[optional]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
sizekotlin.IntOptional page size in sent email tracking pixel list pagination[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageTrackingPixelProjection

Authorization

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

HTTP request headers

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

getSentEmails

PageSentEmailProjection getSentEmails(before, inboxId, page, searchFilter, since, size, sort)

Get all sent emails in paginated form

Example

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

val apiInstance = SentEmailsControllerApi()
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inboxId to filter sender of sent emails by
val page : kotlin.Int = 56 // kotlin.Int | Optional page  in inbox sent email list pagination
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 in inbox sent email list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
try {
    val result : PageSentEmailProjection = apiInstance.getSentEmails(before, inboxId, page, searchFilter, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SentEmailsControllerApi#getSentEmails")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SentEmailsControllerApi#getSentEmails")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdjava.util.UUIDOptional inboxId to filter sender of sent emails by[optional]
pagekotlin.IntOptional page in inbox sent email list pagination[optional] [default to 0]
searchFilterkotlin.StringOptional search filter[optional]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
sizekotlin.IntOptional page size in inbox sent email list pagination[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageSentEmailProjection

Authorization

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

HTTP request headers

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

getSentOrganizationEmails

PageSentEmailProjection getSentOrganizationEmails(before, inboxId, page, searchFilter, since, size, sort)

Get all sent organization emails in paginated form

Example

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

val apiInstance = SentEmailsControllerApi()
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inboxId to filter sender of sent emails by
val page : kotlin.Int = 56 // kotlin.Int | Optional page  in sent email list pagination
val searchFilter : kotlin.String = searchFilter_example // kotlin.String | Optional search filter
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 in sent email list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
try {
    val result : PageSentEmailProjection = apiInstance.getSentOrganizationEmails(before, inboxId, page, searchFilter, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SentEmailsControllerApi#getSentOrganizationEmails")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SentEmailsControllerApi#getSentOrganizationEmails")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdjava.util.UUIDOptional inboxId to filter sender of sent emails by[optional]
pagekotlin.IntOptional page in sent email list pagination[optional] [default to 0]
searchFilterkotlin.StringOptional search filter[optional]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
sizekotlin.IntOptional page size in sent email list pagination[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageSentEmailProjection

Authorization

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

HTTP request headers

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