OAIBulkActionsControllerApi

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

MethodHTTP requestDescription
bulkCreateInboxesPOST /bulk/inboxesBulk create Inboxes (email addresses)
bulkDeleteInboxesDELETE /bulk/inboxesBulk Delete Inboxes
bulkSendEmailsPOST /bulk/sendBulk Send Emails

bulkCreateInboxes

-(NSURLSessionTask*) bulkCreateInboxesWithCount: (NSNumber*) count
        completionHandler: (void (^)(NSArray<OAIInbox>* output, NSError* error)) handler;

Bulk create Inboxes (email addresses)

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 inboxes to be created in bulk

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

// Bulk create Inboxes (email addresses)
[apiInstance bulkCreateInboxesWithCount:count
          completionHandler: ^(NSArray<OAIInbox>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIBulkActionsControllerApi->bulkCreateInboxes: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
countNSNumber*Number of inboxes to be created in bulk

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 ]

bulkDeleteInboxes

-(NSURLSessionTask*) bulkDeleteInboxesWithIds: (NSArray<NSString*>*) ids
        completionHandler: (void (^)(NSError* error)) handler;

Bulk Delete Inboxes

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


NSArray<NSString*>* ids = @[@"ids_example"]; // ids

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

// Bulk Delete Inboxes
[apiInstance bulkDeleteInboxesWithIds:ids
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIBulkActionsControllerApi->bulkDeleteInboxes: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
idsNSArray<NSString>**ids

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

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

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

bulkSendEmails

-(NSURLSessionTask*) bulkSendEmailsWithBulkSendEmailOptions: (OAIBulkSendEmailOptions*) bulkSendEmailOptions
        completionHandler: (void (^)(NSError* error)) handler;

Bulk Send Emails

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


OAIBulkSendEmailOptions* bulkSendEmailOptions = [[OAIBulkSendEmailOptions alloc] init]; // bulkSendEmailOptions

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

// Bulk Send Emails
[apiInstance bulkSendEmailsWithBulkSendEmailOptions:bulkSendEmailOptions
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIBulkActionsControllerApi->bulkSendEmails: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
bulkSendEmailOptionsOAIBulkSendEmailOptions*bulkSendEmailOptions

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

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

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