MissedEmailControllerApi

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

MethodHTTP requestDescription
getAllMissedEmailsGET /missed-emailsGet all MissedEmails in paginated format
getAllUnknownMissedEmailsGET /missed-emails/unknownGet all unknown missed emails in paginated format
getMissedEmailGET /missed-emails/{missedEmailId}Get MissedEmail
waitForNthMissedEmailGET /missed-emails/waitForNthMissedEmailWait for Nth missed email

getAllMissedEmails

PageMissedEmailProjection getAllMissedEmails(before, inboxId, page, searchFilter, since, size, sort)

Get all MissedEmails in paginated format

Example

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

val apiInstance = MissedEmailControllerApi()
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 inbox ID filter
val page : kotlin.Int = 56 // kotlin.Int | Optional page  in 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 list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
try {
    val result : PageMissedEmailProjection = apiInstance.getAllMissedEmails(before, inboxId, page, searchFilter, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MissedEmailControllerApi#getAllMissedEmails")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MissedEmailControllerApi#getAllMissedEmails")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdjava.util.UUIDOptional inbox ID filter[optional]
pagekotlin.IntOptional page in 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 list pagination[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageMissedEmailProjection

Authorization

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

HTTP request headers

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

getAllUnknownMissedEmails

PageUnknownMissedEmailProjection getAllUnknownMissedEmails(before, inboxId, page, searchFilter, since, size, sort)

Get all unknown missed emails in paginated format

Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

Example

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

val apiInstance = MissedEmailControllerApi()
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 inbox ID filter
val page : kotlin.Int = 56 // kotlin.Int | Optional page  in 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 list pagination
val sort : kotlin.String = sort_example // kotlin.String | Optional createdAt sort direction ASC or DESC
try {
    val result : PageUnknownMissedEmailProjection = apiInstance.getAllUnknownMissedEmails(before, inboxId, page, searchFilter, since, size, sort)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MissedEmailControllerApi#getAllUnknownMissedEmails")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MissedEmailControllerApi#getAllUnknownMissedEmails")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdjava.util.UUIDOptional inbox ID filter[optional]
pagekotlin.IntOptional page in 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 list pagination[optional] [default to 20]
sortkotlin.StringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageUnknownMissedEmailProjection

Authorization

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

HTTP request headers

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

getMissedEmail

MissedEmail getMissedEmail(missedEmailId)

Get MissedEmail

Example

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

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

Parameters

NameTypeDescriptionNotes
missedEmailIdjava.util.UUIDmissedEmailId

Return type

MissedEmail

Authorization

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

HTTP request headers

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

waitForNthMissedEmail

MissedEmail waitForNthMissedEmail(before, inboxId, , since, timeout)

Wait for Nth missed email

Wait for 0 based missed email

Example

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

val apiInstance = MissedEmailControllerApi()
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 inbox ID filter
val  : kotlin.Int = 56 // kotlin.Int | Zero based  of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
val timeout : kotlin.Long = 789 // kotlin.Long | Optional timeout milliseconds
try {
    val result : MissedEmail = apiInstance.waitForNthMissedEmail(before, inboxId, , since, timeout)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MissedEmailControllerApi#waitForNthMissedEmail")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MissedEmailControllerApi#waitForNthMissedEmail")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
beforejava.time.OffsetDateTimeFilter by created at before the given timestamp[optional]
inboxIdjava.util.UUIDOptional inbox ID filter[optional]
****kotlin.IntZero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1[optional]
sincejava.time.OffsetDateTimeFilter by created at after the given timestamp[optional]
timeoutkotlin.LongOptional timeout milliseconds[optional]

Return type

MissedEmail

Authorization

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

HTTP request headers

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