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 |
open class func getAllMissedEmails( page: Int? = nil, size: Int? = nil, sort: Sort_getAllMissedEmails? = nil, searchFilter: String? = nil, since: Date? = nil, before: Date? = nil, inboxId: UUID? = 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 page = 987 // Int | Optional page in list pagination (optional) (default to 0)
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)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
let inboxId = 987 // UUID | Optional inbox ID filter (optional)
// Get all MissedEmails in paginated format
MissedEmailControllerAPI.getAllMissedEmails(page: page, size: size, sort: sort, searchFilter: searchFilter, since: since, before: before, inboxId: inboxId).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
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page in list pagination | [optional] [default to 0] |
size | Int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
searchFilter | String | Optional search filter | [optional] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
inboxId | UUID | Optional inbox ID filter | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func getAllUnknownMissedEmails( page: Int? = nil, size: Int? = nil, sort: Sort_getAllUnknownMissedEmails? = nil, searchFilter: String? = nil, since: Date? = nil, before: Date? = nil, inboxId: UUID? = nil) -> Promise<PageUnknownMissedEmailProjection>
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
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let page = 987 // Int | Optional page in list pagination (optional) (default to 0)
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)
let searchFilter = "searchFilter_example" // String | Optional search filter (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
let inboxId = 987 // UUID | Optional inbox ID filter (optional)
// Get all unknown missed emails in paginated format
MissedEmailControllerAPI.getAllUnknownMissedEmails(page: page, size: size, sort: sort, searchFilter: searchFilter, since: since, before: before, inboxId: inboxId).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
Name | Type | Description | Notes |
---|---|---|---|
page | Int | Optional page in list pagination | [optional] [default to 0] |
size | Int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to .asc] |
searchFilter | String | Optional search filter | [optional] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
inboxId | UUID | Optional inbox ID filter | [optional] |
Return type
PageUnknownMissedEmailProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
Get MissedEmail
List emails that were missed due to plan limits.
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 |
// 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
Name | Type | Description | Notes |
---|---|---|---|
missedEmailId | UUID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
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
// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
// Restore missed emails
MissedEmailControllerAPI.restoreMissedEmails().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
This endpoint does not need any parameter.
Return type
Void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
open class func waitForNthMissedEmail( : Int, inboxId: UUID? = nil, timeout: Int64? = nil, since: Date? = nil, before: Date? = nil) -> Promise<MissedEmailDto>
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 = 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
let inboxId = 987 // UUID | Optional inbox ID filter (optional)
let timeout = 987 // Int64 | Optional timeout milliseconds (optional)
let since = Date() // Date | Filter by created at after the given timestamp (optional)
let before = Date() // Date | Filter by created at before the given timestamp (optional)
// Wait for Nth missed email
MissedEmailControllerAPI.waitForNthMissedEmail(: , inboxId: inboxId, timeout: timeout, since: since, before: before).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
Name | Type | Description | Notes |
---|---|---|---|
**** | 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 | UUID | Optional inbox ID filter | [optional] |
timeout | Int64 | Optional timeout milliseconds | [optional] |
since | Date | Filter by created at after the given timestamp | [optional] |
before | Date | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]