# OAIWaitForControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
waitFor | POST /waitFor | Wait for conditions to be met |
waitForEmailCount | GET /waitForEmailCount | Wait for and return count number of emails |
waitForLatestEmail | GET /waitForLatestEmail | Fetch inbox's latest email or if empty wait for an email to arrive |
waitForMatchingEmail | POST /waitForMatchingEmails | Wait or return list of emails that match simple matching patterns |
waitForMatchingFirstEmail | POST /waitForMatchingFirstEmail | Wait for or return the first email that matches proved MatchOptions array |
waitForNthEmail | GET /waitForNthEmail | Wait for or fetch the email with a given index in the inbox specified |
# waitFor
-(NSURLSessionTask*) waitForWithWaitForConditions: (OAIWaitForConditions*) waitForConditions
completionHandler: (void (^)(NSArray<OAIEmailPreview>* output, NSError* error)) handler;
Wait for conditions to be met
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 wait for (optional)
OAIWaitForControllerApi*apiInstance = [[OAIWaitForControllerApi alloc] init];
// Wait for conditions to be met
[apiInstance waitForWithWaitForConditions:waitForConditions
completionHandler: ^(NSArray<OAIEmailPreview>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIWaitForControllerApi->waitFor: %@", error);
}
}];
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
waitForConditions | OAIWaitForConditions* | Conditions to wait for | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# waitForEmailCount
-(NSURLSessionTask*) waitForEmailCountWithCount: (NSNumber*) count
inboxId: (NSString*) inboxId
timeout: (NSNumber*) timeout
unreadOnly: (NSNumber*) unreadOnly
completionHandler: (void (^)(NSArray<OAIEmailPreview>* output, NSError* error)) handler;
Wait for and return count number of emails
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"];
NSNumber* count = @56; // Number of emails to wait for. Must be greater that 1 (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are fetching emails from (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
[apiInstance waitForEmailCountWithCount:count
inboxId:inboxId
timeout:timeout
unreadOnly:unreadOnly
completionHandler: ^(NSArray<OAIEmailPreview>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIWaitForControllerApi->waitForEmailCount: %@", error);
}
}];
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
count | NSNumber* | Number of emails to wait for. Must be greater that 1 | [optional] |
inboxId | NSString* | Id of the inbox we are fetching emails from | [optional] |
timeout | NSNumber* | Max milliseconds to wait | [optional] |
unreadOnly | NSNumber* | Optional filter for unread only | [optional] [default to @(NO)] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# waitForLatestEmail
-(NSURLSessionTask*) waitForLatestEmailWithInboxId: (NSString*) inboxId
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"];
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are fetching emails from (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 waitForLatestEmailWithInboxId:inboxId
timeout:timeout
unreadOnly:unreadOnly
completionHandler: ^(OAIEmail* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIWaitForControllerApi->waitForLatestEmail: %@", error);
}
}];
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | NSString* | Id of the inbox we are fetching emails from | [optional] |
timeout | NSNumber* | Max milliseconds to wait | [optional] |
unreadOnly | NSNumber* | Optional filter for unread only. | [optional] [default to @(NO)] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# waitForMatchingEmail
-(NSURLSessionTask*) waitForMatchingEmailWithMatchOptions: (OAIMatchOptions*) matchOptions
count: (NSNumber*) count
inboxId: (NSString*) inboxId
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
NSNumber* count = @56; // Number of emails to wait for. Must be greater that 1 (optional)
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are fetching emails from (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 waitForMatchingEmailWithMatchOptions:matchOptions
count:count
inboxId:inboxId
timeout:timeout
unreadOnly:unreadOnly
completionHandler: ^(NSArray<OAIEmailPreview>* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIWaitForControllerApi->waitForMatchingEmail: %@", error);
}
}];
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
matchOptions | OAIMatchOptions* | matchOptions | |
count | NSNumber* | Number of emails to wait for. Must be greater that 1 | [optional] |
inboxId | NSString* | Id of the inbox we are fetching emails from | [optional] |
timeout | NSNumber* | Max milliseconds to wait | [optional] |
unreadOnly | NSNumber* | Optional filter for unread only | [optional] [default to @(NO)] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# waitForMatchingFirstEmail
-(NSURLSessionTask*) waitForMatchingFirstEmailWithMatchOptions: (OAIMatchOptions*) matchOptions
inboxId: (NSString*) inboxId
timeout: (NSNumber*) timeout
unreadOnly: (NSNumber*) unreadOnly
completionHandler: (void (^)(OAIEmail* output, NSError* error)) handler;
Wait for or return the first email that matches proved 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
NSString* inboxId = @"inboxId_example"; // Id of the inbox we are matching an email for (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 proved MatchOptions array
[apiInstance waitForMatchingFirstEmailWithMatchOptions:matchOptions
inboxId:inboxId
timeout:timeout
unreadOnly:unreadOnly
completionHandler: ^(OAIEmail* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIWaitForControllerApi->waitForMatchingFirstEmail: %@", error);
}
}];
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
matchOptions | OAIMatchOptions* | matchOptions | |
inboxId | NSString* | Id of the inbox we are matching an email for | [optional] |
timeout | NSNumber* | Max milliseconds to wait | [optional] |
unreadOnly | NSNumber* | Optional filter for unread only | [optional] [default to @(NO)] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# waitForNthEmail
-(NSURLSessionTask*) waitForNthEmailWithInboxId: (NSString*) inboxId
index: (NSNumber*) index
timeout: (NSNumber*) timeout
unreadOnly: (NSNumber*) unreadOnly
completionHandler: (void (^)(OAIEmail* output, NSError* error)) handler;
Wait for or fetch the email with a given index in the inbox specified
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"];
NSString* inboxId = @"inboxId_example"; // Id of the inbox you are fetching emails from (optional)
NSNumber* index = @0; // Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 (optional) (default to @0)
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 index in the inbox specified
[apiInstance waitForNthEmailWithInboxId:inboxId
index:index
timeout:timeout
unreadOnly:unreadOnly
completionHandler: ^(OAIEmail* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIWaitForControllerApi->waitForNthEmail: %@", error);
}
}];
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | NSString* | Id of the inbox you are fetching emails from | [optional] |
index | NSNumber* | Zero based index of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass index=1 | [optional] [default to @0] |
timeout | NSNumber* | Max milliseconds to wait for the nth email if not already present | [optional] |
unreadOnly | NSNumber* | Optional filter for unread only | [optional] [default to @(NO)] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]