OAIWaitForControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
waitForPOST /waitForWait for an email to match the provided filter conditions such as subject contains keyword.
waitForEmailCountGET /waitForEmailCountWait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
waitForLatestEmailGET /waitForLatestEmailFetch inbox’s latest email or if empty wait for an email to arrive
waitForMatchingEmailsPOST /waitForMatchingEmailsWait or return list of emails that match simple matching patterns
waitForMatchingFirstEmailPOST /waitForMatchingFirstEmailWait for or return the first email that matches provided MatchOptions array
waitForNthEmailGET /waitForNthEmailWait for or fetch the email with a given in the inbox specified. If doesn’t exist waits for it to exist or timeout to occur.

waitFor

-(NSURLSessionTask*) waitForWithWaitForConditions: (OAIWaitForConditions*) waitForConditions
        completionHandler: (void (^)(NSArray<OAIEmailPreview>* output, NSError* error)) handler;

Wait for an email to match the provided filter conditions such as subject contains keyword.

Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met

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"];


OAIWaitForConditions* waitForConditions = [[OAIWaitForConditions alloc] init]; // Conditions to apply to emails that you are waiting for (optional)

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

// Wait for an email to match the provided filter conditions such as subject contains keyword.
[apiInstance waitForWithWaitForConditions:waitForConditions
          completionHandler: ^(NSArray<OAIEmailPreview>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIWaitForControllerApi->waitFor: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
waitForConditionsOAIWaitForConditions*Conditions to apply to emails that you are waiting for[optional]

Return type

NSArray*

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

waitForEmailCount

-(NSURLSessionTask*) waitForEmailCountWithBefore: (NSDate*) before
    count: (NSNumber*) count
    delay: (NSNumber*) delay
    inboxId: (NSString*) inboxId
    since: (NSDate*) since
    sort: (NSString*) sort
    timeout: (NSNumber*) timeout
    unreadOnly: (NSNumber*) unreadOnly
        completionHandler: (void (^)(NSArray<OAIEmailPreview>* output, NSError* error)) handler;

Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

If inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.

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"];


NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received before the given timestamp (optional)
NSNumber* count = @56; // Number of emails to wait for. Must be greater that 1 (optional)
NSNumber* delay = @56; // Max milliseconds delay between calls (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are fetching emails from (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received after the given timestamp (optional)
NSString* sort = @"sort_example"; // Sort direction (optional)
NSNumber* timeout = @56; // Max milliseconds to wait (optional)
NSNumber* unreadOnly = @(NO); // Optional filter for unread only (optional) (default to @(NO))

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

// Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs
[apiInstance waitForEmailCountWithBefore:before
              count:count
              delay:delay
              inboxId:inboxId
              since:since
              sort:sort
              timeout:timeout
              unreadOnly:unreadOnly
          completionHandler: ^(NSArray<OAIEmailPreview>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIWaitForControllerApi->waitForEmailCount: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter for emails that were received before the given timestamp[optional]
countNSNumber*Number of emails to wait for. Must be greater that 1[optional]
delayNSNumber*Max milliseconds delay between calls[optional]
inboxIdNSString*Id of the inbox we are fetching emails from[optional]
sinceNSDate*Filter for emails that were received after the given timestamp[optional]
sortNSString*Sort direction[optional]
timeoutNSNumber*Max milliseconds to wait[optional]
unreadOnlyNSNumber*Optional filter for unread only[optional] [default to @(NO)]

Return type

NSArray*

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 ]

waitForLatestEmail

-(NSURLSessionTask*) waitForLatestEmailWithBefore: (NSDate*) before
    delay: (NSNumber*) delay
    inboxId: (NSString*) inboxId
    since: (NSDate*) since
    sort: (NSString*) sort
    timeout: (NSNumber*) timeout
    unreadOnly: (NSNumber*) unreadOnly
        completionHandler: (void (^)(OAIEmail* output, NSError* error)) handler;

Fetch inbox’s latest email or if empty wait for an email to arrive

Will return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set unreadOnly=true or see the other receive methods such as waitForNthEmail or waitForEmailCount.

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"];


NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were before after the given timestamp (optional)
NSNumber* delay = @56; // Max milliseconds delay between calls (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are fetching emails from (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received after the given timestamp (optional)
NSString* sort = @"sort_example"; // Sort direction (optional)
NSNumber* timeout = @56; // Max milliseconds to wait (optional)
NSNumber* unreadOnly = @(NO); // Optional filter for unread only. (optional) (default to @(NO))

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

// Fetch inbox's latest email or if empty wait for an email to arrive
[apiInstance waitForLatestEmailWithBefore:before
              delay:delay
              inboxId:inboxId
              since:since
              sort:sort
              timeout:timeout
              unreadOnly:unreadOnly
          completionHandler: ^(OAIEmail* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIWaitForControllerApi->waitForLatestEmail: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter for emails that were before after the given timestamp[optional]
delayNSNumber*Max milliseconds delay between calls[optional]
inboxIdNSString*Id of the inbox we are fetching emails from[optional]
sinceNSDate*Filter for emails that were received after the given timestamp[optional]
sortNSString*Sort direction[optional]
timeoutNSNumber*Max milliseconds to wait[optional]
unreadOnlyNSNumber*Optional filter for unread only.[optional] [default to @(NO)]

Return type

OAIEmail*

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 ]

waitForMatchingEmails

-(NSURLSessionTask*) waitForMatchingEmailsWithMatchOptions: (OAIMatchOptions*) matchOptions
    before: (NSDate*) before
    count: (NSNumber*) count
    delay: (NSNumber*) delay
    inboxId: (NSString*) inboxId
    since: (NSDate*) since
    sort: (NSString*) sort
    timeout: (NSNumber*) timeout
    unreadOnly: (NSNumber*) unreadOnly
        completionHandler: (void (^)(NSArray<OAIEmailPreview>* output, NSError* error)) handler;

Wait or return list of emails that match simple matching patterns

Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch 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"];


OAIMatchOptions* matchOptions = [[OAIMatchOptions alloc] init]; // matchOptions
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received before the given timestamp (optional)
NSNumber* count = @56; // Number of emails to wait for. Must be greater or equal to 1 (optional)
NSNumber* delay = @56; // Max milliseconds delay between calls (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are fetching emails from (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received after the given timestamp (optional)
NSString* sort = @"sort_example"; // Sort direction (optional)
NSNumber* timeout = @56; // Max milliseconds to wait (optional)
NSNumber* unreadOnly = @(NO); // Optional filter for unread only (optional) (default to @(NO))

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

// Wait or return list of emails that match simple matching patterns
[apiInstance waitForMatchingEmailsWithMatchOptions:matchOptions
              before:before
              count:count
              delay:delay
              inboxId:inboxId
              since:since
              sort:sort
              timeout:timeout
              unreadOnly:unreadOnly
          completionHandler: ^(NSArray<OAIEmailPreview>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIWaitForControllerApi->waitForMatchingEmails: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
matchOptionsOAIMatchOptions*matchOptions
beforeNSDate*Filter for emails that were received before the given timestamp[optional]
countNSNumber*Number of emails to wait for. Must be greater or equal to 1[optional]
delayNSNumber*Max milliseconds delay between calls[optional]
inboxIdNSString*Id of the inbox we are fetching emails from[optional]
sinceNSDate*Filter for emails that were received after the given timestamp[optional]
sortNSString*Sort direction[optional]
timeoutNSNumber*Max milliseconds to wait[optional]
unreadOnlyNSNumber*Optional filter for unread only[optional] [default to @(NO)]

Return type

NSArray*

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

waitForMatchingFirstEmail

-(NSURLSessionTask*) waitForMatchingFirstEmailWithMatchOptions: (OAIMatchOptions*) matchOptions
    before: (NSDate*) before
    delay: (NSNumber*) delay
    inboxId: (NSString*) inboxId
    since: (NSDate*) since
    sort: (NSString*) sort
    timeout: (NSNumber*) timeout
    unreadOnly: (NSNumber*) unreadOnly
        completionHandler: (void (^)(OAIEmail* output, NSError* error)) handler;

Wait for or return the first email that matches provided MatchOptions array

Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch 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"];


OAIMatchOptions* matchOptions = [[OAIMatchOptions alloc] init]; // matchOptions
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received before the given timestamp (optional)
NSNumber* delay = @56; // Max milliseconds delay between calls (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are matching an email for (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received after the given timestamp (optional)
NSString* sort = @"sort_example"; // Sort direction (optional)
NSNumber* timeout = @56; // Max milliseconds to wait (optional)
NSNumber* unreadOnly = @(NO); // Optional filter for unread only (optional) (default to @(NO))

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

// Wait for or return the first email that matches provided MatchOptions array
[apiInstance waitForMatchingFirstEmailWithMatchOptions:matchOptions
              before:before
              delay:delay
              inboxId:inboxId
              since:since
              sort:sort
              timeout:timeout
              unreadOnly:unreadOnly
          completionHandler: ^(OAIEmail* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIWaitForControllerApi->waitForMatchingFirstEmail: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
matchOptionsOAIMatchOptions*matchOptions
beforeNSDate*Filter for emails that were received before the given timestamp[optional]
delayNSNumber*Max milliseconds delay between calls[optional]
inboxIdNSString*Id of the inbox we are matching an email for[optional]
sinceNSDate*Filter for emails that were received after the given timestamp[optional]
sortNSString*Sort direction[optional]
timeoutNSNumber*Max milliseconds to wait[optional]
unreadOnlyNSNumber*Optional filter for unread only[optional] [default to @(NO)]

Return type

OAIEmail*

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

waitForNthEmail

-(NSURLSessionTask*) waitForNthEmailWithBefore: (NSDate*) before
    delay: (NSNumber*) delay
    inboxId: (NSString*) inboxId
    : (NSNumber*) 
    since: (NSDate*) since
    sort: (NSString*) sort
    timeout: (NSNumber*) timeout
    unreadOnly: (NSNumber*) unreadOnly
        completionHandler: (void (^)(OAIEmail* output, NSError* error)) handler;

Wait for or fetch the email with a given in the inbox specified. If doesn’t exist waits for it to exist or timeout to occur.

If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.

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"];


NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received before the given timestamp (optional)
NSNumber* delay = @56; // Max milliseconds delay between calls (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox you are fetching emails from (optional)
NSNumber*  = @0; // Zero based  of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1 (optional) (default to @0)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter for emails that were received after the given timestamp (optional)
NSString* sort = @"sort_example"; // Sort direction (optional)
NSNumber* timeout = @56; // Max milliseconds to wait for the nth email if not already present (optional)
NSNumber* unreadOnly = @(NO); // Optional filter for unread only (optional) (default to @(NO))

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

// Wait for or fetch the email with a given  in the inbox specified. If  doesn't exist waits for it to exist or timeout to occur.
[apiInstance waitForNthEmailWithBefore:before
              delay:delay
              inboxId:inboxId
              :
              since:since
              sort:sort
              timeout:timeout
              unreadOnly:unreadOnly
          completionHandler: ^(OAIEmail* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIWaitForControllerApi->waitForNthEmail: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter for emails that were received before the given timestamp[optional]
delayNSNumber*Max milliseconds delay between calls[optional]
inboxIdNSString*Id of the inbox you are fetching emails from[optional]
****NSNumber*Zero based of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1[optional] [default to @0]
sinceNSDate*Filter for emails that were received after the given timestamp[optional]
sortNSString*Sort direction[optional]
timeoutNSNumber*Max milliseconds to wait for the nth email if not already present[optional]
unreadOnlyNSNumber*Optional filter for unread only[optional] [default to @(NO)]

Return type

OAIEmail*

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 ]