OAIMissedEmailControllerApi

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

-(NSURLSessionTask*) getAllMissedEmailsWithPage: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    searchFilter: (NSString*) searchFilter
    since: (NSDate*) since
    before: (NSDate*) before
    inboxId: (NSString*) inboxId
        completionHandler: (void (^)(OAIPageMissedEmailProjection* output, NSError* error)) handler;

Get all MissedEmails in paginated format

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber* page = @0; // Optional page  in list pagination (optional) (default to @0)
NSNumber* size = @20; // Optional page size in list pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSString* searchFilter = @"searchFilter_example"; // Optional search filter (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)
NSString* inboxId = @"inboxId_example"; // Optional inbox ID filter (optional)

OAIMissedEmailControllerApi*apiInstance = [[OAIMissedEmailControllerApi alloc] init];

// Get all MissedEmails in paginated format
[apiInstance getAllMissedEmailsWithPage:page
              size:size
              sort:sort
              searchFilter:searchFilter
              since:since
              before:before
              inboxId:inboxId
          completionHandler: ^(OAIPageMissedEmailProjection* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIMissedEmailControllerApi->getAllMissedEmails: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
page	NSNumber*	Optional page in list pagination	[optional] [default to @0]
size	NSNumber*	Optional page size in list pagination	[optional] [default to @20]
sort	NSString*	Optional createdAt sort direction ASC or DESC	[optional] [default to @"ASC"]
searchFilter	NSString*	Optional search filter	[optional]
since	NSDate*	Filter by created at after the given timestamp	[optional]
before	NSDate*	Filter by created at before the given timestamp	[optional]
inboxId	NSString*	Optional inbox ID filter	[optional]

Return type

OAIPageMissedEmailProjection*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

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

-(NSURLSessionTask*) getAllUnknownMissedEmailsWithPage: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    searchFilter: (NSString*) searchFilter
    since: (NSDate*) since
    before: (NSDate*) before
    inboxId: (NSString*) inboxId
        completionHandler: (void (^)(OAIPageUnknownMissedEmailProjection* output, NSError* error)) handler;

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

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber* page = @0; // Optional page  in list pagination (optional) (default to @0)
NSNumber* size = @20; // Optional page size in list pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSString* searchFilter = @"searchFilter_example"; // Optional search filter (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)
NSString* inboxId = @"inboxId_example"; // Optional inbox ID filter (optional)

OAIMissedEmailControllerApi*apiInstance = [[OAIMissedEmailControllerApi alloc] init];

// Get all unknown missed emails in paginated format
[apiInstance getAllUnknownMissedEmailsWithPage:page
              size:size
              sort:sort
              searchFilter:searchFilter
              since:since
              before:before
              inboxId:inboxId
          completionHandler: ^(OAIPageUnknownMissedEmailProjection* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIMissedEmailControllerApi->getAllUnknownMissedEmails: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
page	NSNumber*	Optional page in list pagination	[optional] [default to @0]
size	NSNumber*	Optional page size in list pagination	[optional] [default to @20]
sort	NSString*	Optional createdAt sort direction ASC or DESC	[optional] [default to @"ASC"]
searchFilter	NSString*	Optional search filter	[optional]
since	NSDate*	Filter by created at after the given timestamp	[optional]
before	NSDate*	Filter by created at before the given timestamp	[optional]
inboxId	NSString*	Optional inbox ID filter	[optional]

Return type

OAIPageUnknownMissedEmailProjection*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

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

-(NSURLSessionTask*) getMissedEmailWithMissedEmailId: (NSString*) missedEmailId
        completionHandler: (void (^)(OAIMissedEmail* output, NSError* error)) handler;

Get MissedEmail

List emails that were missed due to plan limits.

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* missedEmailId = @"missedEmailId_example"; // 

OAIMissedEmailControllerApi*apiInstance = [[OAIMissedEmailControllerApi alloc] init];

// Get MissedEmail
[apiInstance getMissedEmailWithMissedEmailId:missedEmailId
          completionHandler: ^(OAIMissedEmail* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIMissedEmailControllerApi->getMissedEmail: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
missedEmailId	NSString*

Return type

OAIMissedEmail*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

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

-(NSURLSessionTask*) restoreMissedEmailsWithCompletionHandler: 
        (void (^)(NSError* error)) handler;

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

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];



OAIMissedEmailControllerApi*apiInstance = [[OAIMissedEmailControllerApi alloc] init];

// Restore missed emails
[apiInstance restoreMissedEmailsWithCompletionHandler: 
          ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIMissedEmailControllerApi->restoreMissedEmails: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

-(NSURLSessionTask*) waitForNthMissedEmailWithIndex: (NSNumber*) 
    inboxId: (NSString*) inboxId
    timeout: (NSNumber*) timeout
    since: (NSDate*) since
    before: (NSDate*) before
        completionHandler: (void (^)(OAIMissedEmail* output, NSError* error)) handler;

Wait for Nth missed email

Wait for 0 based missed email

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber*  = @56; // Zero based  of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1
NSString* inboxId = @"inboxId_example"; // Optional inbox ID filter (optional)
NSNumber* timeout = @56; // Optional timeout milliseconds (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)

OAIMissedEmailControllerApi*apiInstance = [[OAIMissedEmailControllerApi alloc] init];

// Wait for Nth missed email
[apiInstance waitForNthMissedEmailWithIndex:
              inboxId:inboxId
              timeout:timeout
              since:since
              before:before
          completionHandler: ^(OAIMissedEmail* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIMissedEmailControllerApi->waitForNthMissedEmail: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
****	NSNumber*	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	NSString*	Optional inbox ID filter	[optional]
timeout	NSNumber*	Optional timeout milliseconds	[optional]
since	NSDate*	Filter by created at after the given timestamp	[optional]
before	NSDate*	Filter by created at before the given timestamp	[optional]

Return type

OAIMissedEmail*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

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