MissedEmailControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
getAllMissedEmails | GET /missed-emails | Get all MissedEmails in paginated format |
getAllUnknownMissedEmails | GET /missed-emails/unknown | Get all unknown missed emails in paginated format |
getMissedEmail | GET /missed-emails/{missedEmailId} | Get MissedEmail |
restoreMissedEmails | POST /missed-emails/restore | Restore missed emails |
waitForNthMissedEmail | GET /missed-emails/waitForNthMissedEmail | Wait for Nth missed email |
Get all MissedEmails in paginated format
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(MissedEmailControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page in list pagination
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
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 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 result : PageMissedEmailProjection = webService.getAllMissedEmails(page, size, sort, searchFilter, since, before, inboxId)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | kotlin.Int | Optional page in list pagination | [optional] [default to 0] |
size | kotlin.Int | Optional page size in list pagination | [optional] [default to 20] |
sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
searchFilter | kotlin.String | Optional search filter | [optional] |
since | java.time.OffsetDateTime | Filter by created at after the given timestamp | [optional] |
before | java.time.OffsetDateTime | Filter by created at before the given timestamp | [optional] |
inboxId | java.util.UUID | Optional inbox ID filter | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
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.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(MissedEmailControllerApi::class.java)
val page : kotlin.Int = 56 // kotlin.Int | Optional page in list pagination
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
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 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 result : PageUnknownMissedEmailProjection = webService.getAllUnknownMissedEmails(page, size, sort, searchFilter, since, before, inboxId)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | kotlin.Int | Optional page in list pagination | [optional] [default to 0] |
size | kotlin.Int | Optional page size in list pagination | [optional] [default to 20] |
sort | kotlin.String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
searchFilter | kotlin.String | Optional search filter | [optional] |
since | java.time.OffsetDateTime | Filter by created at after the given timestamp | [optional] |
before | java.time.OffsetDateTime | Filter by created at before the given timestamp | [optional] |
inboxId | java.util.UUID | Optional inbox ID filter | [optional] |
Return type
PageUnknownMissedEmailProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Get MissedEmail
List emails that were missed due to plan limits.
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(MissedEmailControllerApi::class.java)
val missedEmailId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID |
val result : MissedEmailDto = webService.getMissedEmail(missedEmailId)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
missedEmailId | java.util.UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
Restore missed emails
If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(MissedEmailControllerApi::class.java)
webService.restoreMissedEmails()
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Wait for Nth missed email
Wait for 0 based missed email
Example
// Import classes:
//import com.mailslurp.*
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(MissedEmailControllerApi::class.java)
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 inboxId : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | Optional inbox ID filter
val timeout : kotlin.Long = 789 // kotlin.Long | Optional timeout milliseconds
val since : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at after the given timestamp
val before : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | Filter by created at before the given timestamp
val result : MissedEmailDto = webService.waitForNthMissedEmail(, inboxId, timeout, since, before)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
**** | 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 | |
inboxId | java.util.UUID | Optional inbox ID filter | [optional] |
timeout | kotlin.Long | Optional timeout milliseconds | [optional] |
since | java.time.OffsetDateTime | Filter by created at after the given timestamp | [optional] |
before | java.time.OffsetDateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /