OAICommonActionsControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createNewEmailAddress | POST /newEmailAddress | Create new random inbox |
createRandomInbox | POST /createInbox | Create new random inbox |
deleteEmailAddress | DELETE /deleteEmailAddress | Delete inbox email address by inbox id |
emptyInbox | DELETE /emptyInbox | Delete all emails in an inbox |
sendEmailSimple | POST /sendEmail | Send an email |
-(NSURLSessionTask*) createNewEmailAddressWithAllowTeamAccess: (NSNumber*) allowTeamAccess
useDomainPool: (NSNumber*) useDomainPool
expiresAt: (NSDate*) expiresAt
expiresIn: (NSNumber*) expiresIn
emailAddress: (NSString*) emailAddress
inboxType: (NSString*) inboxType
_description: (NSString*) _description
name: (NSString*) name
tags: (NSArray<NSString*>*) tags
favourite: (NSNumber*) favourite
virtualInbox: (NSNumber*) virtualInbox
completionHandler: (void (^)(OAIInboxDto* output, NSError* error)) handler;
Create new random inbox
Returns an Inbox with an id
and an emailAddress
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* allowTeamAccess = @56; // (optional)
NSNumber* useDomainPool = @56; // (optional)
NSDate* expiresAt = @"2013-10-20T19:20:30+01:00"; // (optional)
NSNumber* expiresIn = @56; // (optional)
NSString* emailAddress = @"emailAddress_example"; // (optional)
NSString* inboxType = @"inboxType_example"; // (optional)
NSString* _description = @"_description_example"; // (optional)
NSString* name = @"name_example"; // (optional)
NSArray<NSString*>* tags = @[@"tags_example"]; // (optional)
NSNumber* favourite = @56; // (optional)
NSNumber* virtualInbox = @56; // (optional)
OAICommonActionsControllerApi*apiInstance = [[OAICommonActionsControllerApi alloc] init];
// Create new random inbox
[apiInstance createNewEmailAddressWithAllowTeamAccess:allowTeamAccess
useDomainPool:useDomainPool
expiresAt:expiresAt
expiresIn:expiresIn
emailAddress:emailAddress
inboxType:inboxType
_description:_description
name:name
tags:tags
favourite:favourite
virtualInbox:virtualInbox
completionHandler: ^(OAIInboxDto* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAICommonActionsControllerApi->createNewEmailAddress: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
allowTeamAccess | NSNumber* | [optional] | |
useDomainPool | NSNumber* | [optional] | |
expiresAt | NSDate* | [optional] | |
expiresIn | NSNumber* | [optional] | |
emailAddress | NSString* | [optional] | |
inboxType | NSString* | [optional] | |
_description | NSString* | [optional] | |
name | NSString* | [optional] | |
tags | NSArray | [optional] | |
favourite | NSNumber* | [optional] | |
virtualInbox | NSNumber* | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) createRandomInboxWithAllowTeamAccess: (NSNumber*) allowTeamAccess
useDomainPool: (NSNumber*) useDomainPool
expiresAt: (NSDate*) expiresAt
expiresIn: (NSNumber*) expiresIn
emailAddress: (NSString*) emailAddress
inboxType: (NSString*) inboxType
_description: (NSString*) _description
name: (NSString*) name
tags: (NSArray<NSString*>*) tags
favourite: (NSNumber*) favourite
virtualInbox: (NSNumber*) virtualInbox
completionHandler: (void (^)(OAIInboxDto* output, NSError* error)) handler;
Create new random inbox
Returns an Inbox with an id
and an emailAddress
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* allowTeamAccess = @56; // (optional)
NSNumber* useDomainPool = @56; // (optional)
NSDate* expiresAt = @"2013-10-20T19:20:30+01:00"; // (optional)
NSNumber* expiresIn = @56; // (optional)
NSString* emailAddress = @"emailAddress_example"; // (optional)
NSString* inboxType = @"inboxType_example"; // (optional)
NSString* _description = @"_description_example"; // (optional)
NSString* name = @"name_example"; // (optional)
NSArray<NSString*>* tags = @[@"tags_example"]; // (optional)
NSNumber* favourite = @56; // (optional)
NSNumber* virtualInbox = @56; // (optional)
OAICommonActionsControllerApi*apiInstance = [[OAICommonActionsControllerApi alloc] init];
// Create new random inbox
[apiInstance createRandomInboxWithAllowTeamAccess:allowTeamAccess
useDomainPool:useDomainPool
expiresAt:expiresAt
expiresIn:expiresIn
emailAddress:emailAddress
inboxType:inboxType
_description:_description
name:name
tags:tags
favourite:favourite
virtualInbox:virtualInbox
completionHandler: ^(OAIInboxDto* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAICommonActionsControllerApi->createRandomInbox: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
allowTeamAccess | NSNumber* | [optional] | |
useDomainPool | NSNumber* | [optional] | |
expiresAt | NSDate* | [optional] | |
expiresIn | NSNumber* | [optional] | |
emailAddress | NSString* | [optional] | |
inboxType | NSString* | [optional] | |
_description | NSString* | [optional] | |
name | NSString* | [optional] | |
tags | NSArray | [optional] | |
favourite | NSNumber* | [optional] | |
virtualInbox | NSNumber* | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) deleteEmailAddressWithInboxId: (NSString*) inboxId
completionHandler: (void (^)(NSError* error)) handler;
Delete inbox email address by inbox id
Deletes inbox email address
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"; //
OAICommonActionsControllerApi*apiInstance = [[OAICommonActionsControllerApi alloc] init];
// Delete inbox email address by inbox id
[apiInstance deleteEmailAddressWithInboxId:inboxId
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error calling OAICommonActionsControllerApi->deleteEmailAddress: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | NSString* |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) emptyInboxWithInboxId: (NSString*) inboxId
completionHandler: (void (^)(NSError* error)) handler;
Delete all emails in an inbox
Deletes all 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"];
NSString* inboxId = @"inboxId_example"; //
OAICommonActionsControllerApi*apiInstance = [[OAICommonActionsControllerApi alloc] init];
// Delete all emails in an inbox
[apiInstance emptyInboxWithInboxId:inboxId
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error calling OAICommonActionsControllerApi->emptyInbox: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | NSString* |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) sendEmailSimpleWithSimpleSendEmailOptions: (OAISimpleSendEmailOptions*) simpleSendEmailOptions
completionHandler: (void (^)(NSError* error)) handler;
Send an email
If no senderId or inboxId provided a random email address will be used to send from.
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"];
OAISimpleSendEmailOptions* simpleSendEmailOptions = [[OAISimpleSendEmailOptions alloc] init]; //
OAICommonActionsControllerApi*apiInstance = [[OAICommonActionsControllerApi alloc] init];
// Send an email
[apiInstance sendEmailSimpleWithSimpleSendEmailOptions:simpleSendEmailOptions
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error calling OAICommonActionsControllerApi->sendEmailSimple: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
simpleSendEmailOptions | OAISimpleSendEmailOptions* |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]