mailslurp.api.MissedEmailControllerApi

Load the API package

import 'package:mailslurp/api.dart';

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 '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 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
final page = 56; // int | Optional page  in list pagination
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 size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC

try { 
    final result = api_instance.getAllMissedEmails(before, inboxId, page, searchFilter, since, size, sort);
    print(result);
} catch (e) {
    print('Exception when calling MissedEmailControllerApi->getAllMissedEmails: $en');
}

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter by created at before the given timestamp[optional]
inboxIdStringOptional inbox ID filter[optional]
pageintOptional page in list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceDateTimeFilter by created at after the given timestamp[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 ]

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 '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 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
final page = 56; // int | Optional page  in list pagination
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 size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC

try { 
    final result = api_instance.getAllUnknownMissedEmails(before, inboxId, page, searchFilter, since, size, sort);
    print(result);
} catch (e) {
    print('Exception when calling MissedEmailControllerApi->getAllUnknownMissedEmails: $en');
}

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter by created at before the given timestamp[optional]
inboxIdStringOptional inbox ID filter[optional]
pageintOptional page in list pagination[optional] [default to 0]
searchFilterStringOptional search filter[optional]
sinceDateTimeFilter by created at after the given timestamp[optional]
sizeintOptional page size in list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]

Return type

PageUnknownMissedEmailProjection

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

MissedEmail getMissedEmail(missedEmailId)

Get MissedEmail

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 | missedEmailId

try { 
    final result = api_instance.getMissedEmail(missedEmailId);
    print(result);
} catch (e) {
    print('Exception when calling MissedEmailControllerApi->getMissedEmail: $en');
}

Parameters

NameTypeDescriptionNotes
missedEmailIdStringmissedEmailId

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

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

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 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
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 since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final timeout = 789; // int | Optional timeout milliseconds

try { 
    final result = api_instance.waitForNthMissedEmail(before, inboxId, , since, timeout);
    print(result);
} catch (e) {
    print('Exception when calling MissedEmailControllerApi->waitForNthMissedEmail: $en');
}

Parameters

NameTypeDescriptionNotes
beforeDateTimeFilter by created at before the given timestamp[optional]
inboxIdStringOptional 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]
sinceDateTimeFilter by created at after the given timestamp[optional]
timeoutintOptional 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 ]