OAIInboxRulesetControllerApi

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

MethodHTTP requestDescription
createNewInboxRulesetPOST /rulesetsCreate an inbox ruleset
deleteInboxRulesetDELETE /rulesets/{id}Delete an inbox ruleset
deleteInboxRulesetsDELETE /rulesetsDelete inbox rulesets
getInboxRulesetGET /rulesets/{id}Get an inbox ruleset
getInboxRulesetsGET /rulesetsList inbox rulesets
testInboxRulesetPOST /rulesets/{id}/testTest an inbox ruleset
testInboxRulesetsForInboxPUT /rulesetsTest inbox rulesets for inbox
testNewInboxRulesetPATCH /rulesetsTest new inbox ruleset

createNewInboxRuleset

-(NSURLSessionTask*) createNewInboxRulesetWithCreateInboxRulesetOptions: (OAICreateInboxRulesetOptions*) createInboxRulesetOptions
    inboxId: (NSString*) inboxId
        completionHandler: (void (^)(OAIInboxRulesetDto* output, NSError* error)) handler;

Create an inbox ruleset

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


OAICreateInboxRulesetOptions* createInboxRulesetOptions = [[OAICreateInboxRulesetOptions alloc] init]; // createInboxRulesetOptions
NSString* inboxId = @"inboxId_example"; // Inbox id to attach ruleset to (optional)

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

// Create an inbox ruleset
[apiInstance createNewInboxRulesetWithCreateInboxRulesetOptions:createInboxRulesetOptions
              inboxId:inboxId
          completionHandler: ^(OAIInboxRulesetDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->createNewInboxRuleset: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
createInboxRulesetOptionsOAICreateInboxRulesetOptions*createInboxRulesetOptions
inboxIdNSString*Inbox id to attach ruleset to[optional]

Return type

OAIInboxRulesetDto*

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 ]

deleteInboxRuleset

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

Delete an inbox ruleset

Delete 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 ruleset

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

// Delete an inbox ruleset
[apiInstance deleteInboxRulesetWithId:_id
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->deleteInboxRuleset: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
_idNSString*ID of inbox ruleset

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 ]

deleteInboxRulesets

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

Delete inbox rulesets

Delete inbox rulesets. 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 ruleset to (optional)

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

// Delete inbox rulesets
[apiInstance deleteInboxRulesetsWithInboxId:inboxId
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->deleteInboxRulesets: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
inboxIdNSString*Optional inbox id to attach ruleset 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 ]

getInboxRuleset

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

Get an inbox ruleset

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 ruleset

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

// Get an inbox ruleset
[apiInstance getInboxRulesetWithId:_id
          completionHandler: ^(OAIInboxRulesetDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->getInboxRuleset: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
_idNSString*ID of inbox ruleset

Return type

OAIInboxRulesetDto*

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 ]

getInboxRulesets

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

List inbox rulesets

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

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

// List inbox rulesets
[apiInstance getInboxRulesetsWithBefore:before
              inboxId:inboxId
              page:page
              searchFilter:searchFilter
              since:since
              size:size
              sort:sort
          completionHandler: ^(OAIPageInboxRulesetDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->getInboxRulesets: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter by created at before the given timestamp[optional]
inboxIdNSString*Optional inbox id to get rulesets from[optional]
pageNSNumber*Optional page in inbox ruleset 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 ruleset list pagination[optional] [default to @20]
sortNSString*Optional createdAt sort direction ASC or DESC[optional] [default to @“ASC”]

Return type

OAIPageInboxRulesetDto*

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 ]

testInboxRuleset

-(NSURLSessionTask*) testInboxRulesetWithId: (NSString*) _id
    inboxRulesetTestOptions: (OAIInboxRulesetTestOptions*) inboxRulesetTestOptions
        completionHandler: (void (^)(OAIInboxRulesetTestResult* output, NSError* error)) handler;

Test an inbox ruleset

Test an 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 ruleset
OAIInboxRulesetTestOptions* inboxRulesetTestOptions = [[OAIInboxRulesetTestOptions alloc] init]; // inboxRulesetTestOptions

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

// Test an inbox ruleset
[apiInstance testInboxRulesetWithId:_id
              inboxRulesetTestOptions:inboxRulesetTestOptions
          completionHandler: ^(OAIInboxRulesetTestResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->testInboxRuleset: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
_idNSString*ID of inbox ruleset
inboxRulesetTestOptionsOAIInboxRulesetTestOptions*inboxRulesetTestOptions

Return type

OAIInboxRulesetTestResult*

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 ]

testInboxRulesetsForInbox

-(NSURLSessionTask*) testInboxRulesetsForInboxWithInboxId: (NSString*) inboxId
    inboxRulesetTestOptions: (OAIInboxRulesetTestOptions*) inboxRulesetTestOptions
        completionHandler: (void (^)(OAIInboxRulesetTestResult* output, NSError* error)) handler;

Test inbox rulesets for inbox

Test inbox rulesets 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
OAIInboxRulesetTestOptions* inboxRulesetTestOptions = [[OAIInboxRulesetTestOptions alloc] init]; // inboxRulesetTestOptions

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

// Test inbox rulesets for inbox
[apiInstance testInboxRulesetsForInboxWithInboxId:inboxId
              inboxRulesetTestOptions:inboxRulesetTestOptions
          completionHandler: ^(OAIInboxRulesetTestResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->testInboxRulesetsForInbox: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
inboxIdNSString*ID of inbox
inboxRulesetTestOptionsOAIInboxRulesetTestOptions*inboxRulesetTestOptions

Return type

OAIInboxRulesetTestResult*

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 ]

testNewInboxRuleset

-(NSURLSessionTask*) testNewInboxRulesetWithTestNewInboxRulesetOptions: (OAITestNewInboxRulesetOptions*) testNewInboxRulesetOptions
        completionHandler: (void (^)(OAIInboxRulesetTestResult* output, NSError* error)) handler;

Test new inbox ruleset

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


OAITestNewInboxRulesetOptions* testNewInboxRulesetOptions = [[OAITestNewInboxRulesetOptions alloc] init]; // testNewInboxRulesetOptions

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

// Test new inbox ruleset
[apiInstance testNewInboxRulesetWithTestNewInboxRulesetOptions:testNewInboxRulesetOptions
          completionHandler: ^(OAIInboxRulesetTestResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIInboxRulesetControllerApi->testNewInboxRuleset: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
testNewInboxRulesetOptionsOAITestNewInboxRulesetOptions*testNewInboxRulesetOptions

Return type

OAIInboxRulesetTestResult*

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 ]