All URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptioncreateNewEmailAddressPOST /newEmailAddressCreate new random inboxcreateRandomInboxPOST /createInboxCreate new random inboxdeleteEmailAddressDELETE /deleteEmailAddressDelete inbox email address by inbox idemptyInboxDELETE /emptyInboxDelete all emails in an inboxsendEmailSimplePOST /sendEmailSend 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 completionHandler: (void (^)(OAIInboxDto* output, NSError* error)) handler; Create new random inboxReturns an Inbox with an id and an emailAddressExampleOAIDefaultConfiguration *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) 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 completionHandler: ^(OAIInboxDto* output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error calling OAICommonActionsControllerApi->createNewEmailAddress: %@", error); } }]; ParametersNameTypeDescriptionNotesallowTeamAccessNSNumber*[optional]useDomainPoolNSNumber*[optional]expiresAtNSDate*[optional]expiresInNSNumber*[optional]emailAddressNSString*[optional]inboxTypeNSString*[optional]_descriptionNSString*[optional]nameNSString*[optional]tagsNSArray<NSString>**[optional]favouriteNSNumber*[optional]Return typeOAIInboxDto*AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[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 completionHandler: (void (^)(OAIInboxDto* output, NSError* error)) handler; Create new random inboxReturns an Inbox with an id and an emailAddressExampleOAIDefaultConfiguration *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) 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 completionHandler: ^(OAIInboxDto* output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error calling OAICommonActionsControllerApi->createRandomInbox: %@", error); } }]; ParametersNameTypeDescriptionNotesallowTeamAccessNSNumber*[optional]useDomainPoolNSNumber*[optional]expiresAtNSDate*[optional]expiresInNSNumber*[optional]emailAddressNSString*[optional]inboxTypeNSString*[optional]_descriptionNSString*[optional]nameNSString*[optional]tagsNSArray<NSString>**[optional]favouriteNSNumber*[optional]Return typeOAIInboxDto*AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[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 idDeletes inbox email addressExampleOAIDefaultConfiguration *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); } }]; ParametersNameTypeDescriptionNotesinboxIdNSString*Return typevoid (empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: 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 inboxDeletes all emailsExampleOAIDefaultConfiguration *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); } }]; ParametersNameTypeDescriptionNotesinboxIdNSString*Return typevoid (empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: 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 emailIf no senderId or inboxId provided a random email address will be used to send from.ExampleOAIDefaultConfiguration *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); } }]; ParametersNameTypeDescriptionNotessimpleSendEmailOptionsOAISimpleSendEmailOptions*Return typevoid (empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: Not defined[Back to top] [Back to API list] [Back to Model list] [Back to ]