Skip to content

OAIInboxForwarderControllerApi

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

Method HTTP request Description
createNewInboxForwarder POST /forwarders Create an inbox forwarder
deleteInboxForwarder DELETE /forwarders/{id} Delete an inbox forwarder
deleteInboxForwarders DELETE /forwarders Delete inbox forwarders
getInboxForwarder GET /forwarders/{id} Get an inbox forwarder
getInboxForwarders GET /forwarders List inbox forwarders
testInboxForwarder POST /forwarders/{id}/test Test an inbox forwarder
testInboxForwardersForInbox PUT /forwarders Test inbox forwarders for inbox
testNewInboxForwarder PATCH /forwarders Test new inbox forwarder
-(NSURLSessionTask*) createNewInboxForwarderWithInboxId: (NSString*) inboxId
    createInboxForwarderOptions: (OAICreateInboxForwarderOptions*) createInboxForwarderOptions
        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"];


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

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

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

Parameters

Name Type Description Notes
inboxId NSString* Inbox id to attach forwarder to
createInboxForwarderOptions OAICreateInboxForwarderOptions*

Return type

OAIInboxForwarderDto*

Authorization

API_KEY

HTTP request headers

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

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

-(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

Name Type Description Notes
_id NSString* 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 ]

-(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

Name Type Description Notes
inboxId NSString* 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 ]

-(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

Name Type Description Notes
_id NSString* ID of inbox forwarder

Return type

OAIInboxForwarderDto*

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*) getInboxForwardersWithInboxId: (NSString*) inboxId
    page: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    searchFilter: (NSString*) searchFilter
    since: (NSDate*) since
    before: (NSDate*) before
        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"];


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)
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")
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)

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

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

Parameters

Name Type Description Notes
inboxId NSString* Optional inbox id to get forwarders from [optional]
page NSNumber* Optional page in inbox forwarder list pagination [optional] [default to @0]
size NSNumber* Optional page size in inbox forwarder 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]

Return type

OAIPageInboxForwarderDto*

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*) 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]; // 

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

Name Type Description Notes
_id NSString* ID of inbox forwarder
inboxForwarderTestOptions OAIInboxForwarderTestOptions*

Return type

OAIInboxForwarderTestResult*

Authorization

API_KEY

HTTP request headers

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

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

-(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]; // 

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

Name Type Description Notes
inboxId NSString* ID of inbox
inboxForwarderTestOptions OAIInboxForwarderTestOptions*

Return type

OAIInboxForwarderTestResult*

Authorization

API_KEY

HTTP request headers

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

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

-(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]; // 

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

Name Type Description Notes
testNewInboxForwarderOptions OAITestNewInboxForwarderOptions*

Return type

OAIInboxForwarderTestResult*

Authorization

API_KEY

HTTP request headers

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

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