MissedEmailControllerAPI

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

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

getAllMissedEmails

    open class func getAllMissedEmails( inboxId: UUID? = nil,  page: Int? = nil,  searchFilter: String? = nil,  size: Int? = nil,  sort: Sort_getAllMissedEmails? = nil) -> Promise<PageMissedEmailProjection>

Get all MissedEmails in paginated format

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 inboxId = 987 // UUID | Optional inbox ID filter (optional)
let page = 987 // Int | Optional page  in list pagination (optional) (default to 0)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let size = 987 // Int | Optional page size in list pagination (optional) (default to 20)
let sort = "sort_example" // String | Optional createdAt sort direction ASC or DESC (optional) (default to .asc)

// Get all MissedEmails in paginated format
MissedEmailControllerAPI.getAllMissedEmails(inboxId: inboxId, page: page, searchFilter: searchFilter, size: size, sort: sort).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

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox ID filter[optional]
pageIntOptional page in list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sizeIntOptional page size in list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to .asc]

Return type

PageMissedEmailProjection

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

getMissedEmail

    open class func getMissedEmail( missedEmailId: UUID) -> Promise<MissedEmail>

Get MissedEmail

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 missedEmailId = 987 // UUID | missedEmailId

// Get MissedEmail
MissedEmailControllerAPI.getMissedEmail(missedEmailId: missedEmailId).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

NameTypeDescriptionNotes
missedEmailIdUUIDmissedEmailId

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

waitForNthMissedEmail

    open class func waitForNthMissedEmail( inboxId: UUID? = nil,  : Int? = nil,  timeout: Int64? = nil) -> Promise<MissedEmail>

Wait for Nth missed email

Wait for 0 based missed email

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 inboxId = 987 // UUID | Optional inbox ID filter (optional)
let  = 987 // 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 (optional)
let timeout = 987 // Int64 | Optional timeout milliseconds (optional)

// Wait for Nth missed email
MissedEmailControllerAPI.waitForNthMissedEmail(inboxId: inboxId, : , timeout: timeout).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

NameTypeDescriptionNotes
inboxIdUUIDOptional inbox ID filter[optional]
****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]
timeoutInt64Optional timeout milliseconds[optional]

Return type

MissedEmail

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]