OAIExpiredControllerApiAll URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptiongetExpirationDefaultsGET /expired/defaultsGet default expiration settingsgetExpiredInboxByInboxIdGET /expired/inbox/{inboxId}Get expired inbox record for a previously existing inboxgetExpiredInboxRecordGET /expired/{expiredId}Get an expired inbox recordgetExpiredInboxesGET /expiredList records of expired inboxesgetExpirationDefaults-(NSURLSessionTask*) getExpirationDefaultsWithCompletionHandler: (void (^)(OAIExpirationDefaults* output, NSError* error)) handler; Get default expiration settingsReturn default times used for inbox expirationExampleOAIDefaultConfiguration *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"]; OAIExpiredControllerApi*apiInstance = [[OAIExpiredControllerApi alloc] init]; // Get default expiration settings [apiInstance getExpirationDefaultsWithCompletionHandler: ^(OAIExpirationDefaults* output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error calling OAIExpiredControllerApi->getExpirationDefaults: %@", error); } }]; ParametersThis endpoint does not need any parameter.Return typeOAIExpirationDefaults*AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]getExpiredInboxByInboxId-(NSURLSessionTask*) getExpiredInboxByInboxIdWithInboxId: (NSString*) inboxId completionHandler: (void (^)(OAIExpiredInboxDto* output, NSError* error)) handler; Get expired inbox record for a previously existing inboxUse the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxIdExampleOAIDefaultConfiguration *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 you want to retrieve (not the inbox ID) OAIExpiredControllerApi*apiInstance = [[OAIExpiredControllerApi alloc] init]; // Get expired inbox record for a previously existing inbox [apiInstance getExpiredInboxByInboxIdWithInboxId:inboxId completionHandler: ^(OAIExpiredInboxDto* output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error calling OAIExpiredControllerApi->getExpiredInboxByInboxId: %@", error); } }]; ParametersNameTypeDescriptionNotesinboxIdNSString*ID of inbox you want to retrieve (not the inbox ID)Return typeOAIExpiredInboxDto*AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]getExpiredInboxRecord-(NSURLSessionTask*) getExpiredInboxRecordWithExpiredId: (NSString*) expiredId completionHandler: (void (^)(OAIExpiredInboxDto* output, NSError* error)) handler; Get an expired inbox recordInboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes propertiesExampleOAIDefaultConfiguration *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* expiredId = @"expiredId_example"; // ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId) OAIExpiredControllerApi*apiInstance = [[OAIExpiredControllerApi alloc] init]; // Get an expired inbox record [apiInstance getExpiredInboxRecordWithExpiredId:expiredId completionHandler: ^(OAIExpiredInboxDto* output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error calling OAIExpiredControllerApi->getExpiredInboxRecord: %@", error); } }]; ParametersNameTypeDescriptionNotesexpiredIdNSString*ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)Return typeOAIExpiredInboxDto*AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]getExpiredInboxes-(NSURLSessionTask*) getExpiredInboxesWithPage: (NSNumber*) page size: (NSNumber*) size sort: (NSString*) sort completionHandler: (void (^)(OAIPageExpiredInboxRecordProjection* output, NSError* error)) handler; List records of expired inboxesInboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes propertiesExampleOAIDefaultConfiguration *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* page = @0; // Optional page in inbox sent email list pagination (optional) (default to @0) NSNumber* size = @20; // Optional page size in inbox sent email list pagination (optional) (default to @20) NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC") OAIExpiredControllerApi*apiInstance = [[OAIExpiredControllerApi alloc] init]; // List records of expired inboxes [apiInstance getExpiredInboxesWithPage:page size:size sort:sort completionHandler: ^(OAIPageExpiredInboxRecordProjection* output, NSError* error) { if (output) { NSLog(@"%@", output); } if (error) { NSLog(@"Error calling OAIExpiredControllerApi->getExpiredInboxes: %@", error); } }]; ParametersNameTypeDescriptionNotespageNSNumber*Optional page in inbox sent email list pagination[optional] [default to @0]sizeNSNumber*Optional page size in inbox sent email list pagination[optional] [default to @20]sortNSString*Optional createdAt sort direction ASC or DESC[optional] [default to @“ASC”]Return typeOAIPageExpiredInboxRecordProjection*AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]