OAIInboxForwarderControllerApi

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

MethodHTTP requestDescription
createNewInboxForwarderPOST /forwardersCreate an inbox forwarder
deleteInboxForwarderDELETE /forwarders/{id}Delete an inbox forwarder
deleteInboxForwardersDELETE /forwardersDelete inbox forwarders
getInboxForwarderGET /forwarders/{id}Get an inbox forwarder
getInboxForwardersGET /forwardersList inbox forwarders
testInboxForwarderPOST /forwarders/{id}/testTest an inbox forwarder
testInboxForwardersForInboxPUT /forwardersTest inbox forwarders for inbox
testNewInboxForwarderPATCH /forwardersTest new inbox forwarder

createNewInboxForwarder

-(NSURLSessionTask*) createNewInboxForwarderWithCreateInboxForwarderOptions: (OAICreateInboxForwarderOptions*) createInboxForwarderOptions
    inboxId: (NSString*) inboxId
        completionHandler: (void (^)(OAIInboxForwarderDto* output, NSError* error)) handler;

Create an inbox forwarder

Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

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


OAICreateInboxForwarderOptions* createInboxForwarderOptions = [[OAICreateInboxForwarderOptions alloc] init]; // createInboxForwarderOptions
NSString* inboxId = @"inboxId_example"; // Inbox id to attach forwarder to (optional)

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

// Create an inbox forwarder
[apiInstance createNewInboxForwarderWithCreateInboxForwarderOptions:createInboxForwarderOptions
              inboxId:inboxId
          completionHandler: ^(OAIInboxForwarderDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->createNewInboxForwarder: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
createInboxForwarderOptionsOAICreateInboxForwarderOptions*createInboxForwarderOptions
inboxIdNSString*Inbox id to attach forwarder to[optional]

Return type

OAIInboxForwarderDto*

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 ]

deleteInboxForwarder

-(NSURLSessionTask*) deleteInboxForwarderWithId: (NSString*) _id
        completionHandler: (void (^)(NSError* error)) handler;

Delete an inbox forwarder

Delete inbox forwarder

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* _id = @"_id_example"; // ID of inbox forwarder

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

// Delete an inbox forwarder
[apiInstance deleteInboxForwarderWithId:_id
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->deleteInboxForwarder: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
_idNSString*ID of inbox forwarder

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 ]

deleteInboxForwarders

-(NSURLSessionTask*) deleteInboxForwardersWithInboxId: (NSString*) inboxId
        completionHandler: (void (^)(NSError* error)) handler;

Delete inbox forwarders

Delete inbox forwarders. Accepts optional inboxId filter.

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"; // Optional inbox id to attach forwarder to (optional)

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

// Delete inbox forwarders
[apiInstance deleteInboxForwardersWithInboxId:inboxId
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->deleteInboxForwarders: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
inboxIdNSString*Optional inbox id to attach forwarder to[optional]

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 ]

getInboxForwarder

-(NSURLSessionTask*) getInboxForwarderWithId: (NSString*) _id
        completionHandler: (void (^)(OAIInboxForwarderDto* output, NSError* error)) handler;

Get an inbox forwarder

Get inbox ruleset

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* _id = @"_id_example"; // ID of inbox forwarder

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

// Get an inbox forwarder
[apiInstance getInboxForwarderWithId:_id
          completionHandler: ^(OAIInboxForwarderDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->getInboxForwarder: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
_idNSString*ID of inbox forwarder

Return type

OAIInboxForwarderDto*

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 ]

getInboxForwarders

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

List inbox forwarders

List all forwarders attached to an 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"];


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 to get forwarders from (optional)
NSNumber* page = @0; // Optional page  in inbox forwarder list pagination (optional) (default to @0)
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)
NSNumber* size = @20; // Optional page size in inbox forwarder list pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")

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

// List inbox forwarders
[apiInstance getInboxForwardersWithBefore:before
              inboxId:inboxId
              page:page
              searchFilter:searchFilter
              since:since
              size:size
              sort:sort
          completionHandler: ^(OAIPageInboxForwarderDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->getInboxForwarders: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter by created at before the given timestamp[optional]
inboxIdNSString*Optional inbox id to get forwarders from[optional]
pageNSNumber*Optional page in inbox forwarder list pagination[optional] [default to @0]
searchFilterNSString*Optional search filter[optional]
sinceNSDate*Filter by created at after the given timestamp[optional]
sizeNSNumber*Optional page size in inbox forwarder list pagination[optional] [default to @20]
sortNSString*Optional createdAt sort direction ASC or DESC[optional] [default to @“ASC”]

Return type

OAIPageInboxForwarderDto*

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 ]

testInboxForwarder

-(NSURLSessionTask*) testInboxForwarderWithId: (NSString*) _id
    inboxForwarderTestOptions: (OAIInboxForwarderTestOptions*) inboxForwarderTestOptions
        completionHandler: (void (^)(OAIInboxForwarderTestResult* output, NSError* error)) handler;

Test an inbox forwarder

Test an inbox forwarder

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* _id = @"_id_example"; // ID of inbox forwarder
OAIInboxForwarderTestOptions* inboxForwarderTestOptions = [[OAIInboxForwarderTestOptions alloc] init]; // inboxForwarderTestOptions

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

// Test an inbox forwarder
[apiInstance testInboxForwarderWithId:_id
              inboxForwarderTestOptions:inboxForwarderTestOptions
          completionHandler: ^(OAIInboxForwarderTestResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->testInboxForwarder: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
_idNSString*ID of inbox forwarder
inboxForwarderTestOptionsOAIInboxForwarderTestOptions*inboxForwarderTestOptions

Return type

OAIInboxForwarderTestResult*

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 ]

testInboxForwardersForInbox

-(NSURLSessionTask*) testInboxForwardersForInboxWithInboxId: (NSString*) inboxId
    inboxForwarderTestOptions: (OAIInboxForwarderTestOptions*) inboxForwarderTestOptions
        completionHandler: (void (^)(OAIInboxForwarderTestResult* output, NSError* error)) handler;

Test inbox forwarders for inbox

Test inbox forwarders for 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"];


NSString* inboxId = @"inboxId_example"; // ID of inbox
OAIInboxForwarderTestOptions* inboxForwarderTestOptions = [[OAIInboxForwarderTestOptions alloc] init]; // inboxForwarderTestOptions

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

// Test inbox forwarders for inbox
[apiInstance testInboxForwardersForInboxWithInboxId:inboxId
              inboxForwarderTestOptions:inboxForwarderTestOptions
          completionHandler: ^(OAIInboxForwarderTestResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->testInboxForwardersForInbox: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
inboxIdNSString*ID of inbox
inboxForwarderTestOptionsOAIInboxForwarderTestOptions*inboxForwarderTestOptions

Return type

OAIInboxForwarderTestResult*

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 ]

testNewInboxForwarder

-(NSURLSessionTask*) testNewInboxForwarderWithTestNewInboxForwarderOptions: (OAITestNewInboxForwarderOptions*) testNewInboxForwarderOptions
        completionHandler: (void (^)(OAIInboxForwarderTestResult* output, NSError* error)) handler;

Test new inbox forwarder

Test new inbox forwarder

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


OAITestNewInboxForwarderOptions* testNewInboxForwarderOptions = [[OAITestNewInboxForwarderOptions alloc] init]; // testNewInboxForwarderOptions

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

// Test new inbox forwarder
[apiInstance testNewInboxForwarderWithTestNewInboxForwarderOptions:testNewInboxForwarderOptions
          completionHandler: ^(OAIInboxForwarderTestResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxForwarderControllerApi->testNewInboxForwarder: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
testNewInboxForwarderOptionsOAITestNewInboxForwarderOptions*testNewInboxForwarderOptions

Return type

OAIInboxForwarderTestResult*

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 ]