mailslurp.api.MissedEmailControllerApi
Load the API package
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 |
PageMissedEmailProjection getAllMissedEmails(page, size, sort, searchFilter, since, before, inboxId)
Get all MissedEmails in paginated format
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = MissedEmailControllerApi();
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Optional inbox ID filter
try {
final result = api_instance.getAllMissedEmails(page, size, sort, searchFilter, since, before, inboxId);
print(result);
} catch (e) {
print('Exception when calling MissedEmailControllerApi->getAllMissedEmails: $en');
}
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 | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
inboxId | String | 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 ]
PageUnknownMissedEmailProjection getAllUnknownMissedEmails(page, size, sort, searchFilter, since, before, inboxId)
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 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = MissedEmailControllerApi();
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Optional inbox ID filter
try {
final result = api_instance.getAllUnknownMissedEmails(page, size, sort, searchFilter, since, before, inboxId);
print(result);
} catch (e) {
print('Exception when calling MissedEmailControllerApi->getAllUnknownMissedEmails: $en');
}
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 | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
inboxId | String | 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 ]
MissedEmailDto getMissedEmail(missedEmailId)
Get MissedEmail
List emails that were missed due to plan limits.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = MissedEmailControllerApi();
final missedEmailId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.getMissedEmail(missedEmailId);
print(result);
} catch (e) {
print('Exception when calling MissedEmailControllerApi->getMissedEmail: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
missedEmailId | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
restoreMissedEmails()
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 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = MissedEmailControllerApi();
try {
api_instance.restoreMissedEmails();
} catch (e) {
print('Exception when calling MissedEmailControllerApi->restoreMissedEmails: $en');
}
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 ]
MissedEmailDto waitForNthMissedEmail(, inboxId, timeout, since, before)
Wait for Nth missed email
Wait for 0 based missed email
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = MissedEmailControllerApi();
final = 56; // 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
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Optional inbox ID filter
final timeout = 789; // int | Optional timeout milliseconds
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
try {
final result = api_instance.waitForNthMissedEmail(, inboxId, timeout, since, before);
print(result);
} catch (e) {
print('Exception when calling MissedEmailControllerApi->waitForNthMissedEmail: $en');
}
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 | String | Optional inbox ID filter | [optional] |
timeout | int | Optional timeout milliseconds | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | 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 ]