OAIMailServerControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
describeMailServerDomain | POST /mail-server/describe/domain | Get DNS Mail Server records for a domain |
getDnsLookup | POST /mail-server/describe/dns-lookup | Lookup DNS records for a domain |
getIpAddress | POST /mail-server/describe/ip-address | Get IP address for a domain |
verifyEmailAddress | POST /mail-server/verify/email-address | Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server. |
-(NSURLSessionTask*) describeMailServerDomainWithDescribeDomainOptions: (OAIDescribeDomainOptions*) describeDomainOptions
completionHandler: (void (^)(OAIDescribeMailServerDomainResult* output, NSError* error)) handler;
Get DNS Mail Server records for a domain
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"];
OAIDescribeDomainOptions* describeDomainOptions = [[OAIDescribeDomainOptions alloc] init]; //
OAIMailServerControllerApi*apiInstance = [[OAIMailServerControllerApi alloc] init];
// Get DNS Mail Server records for a domain
[apiInstance describeMailServerDomainWithDescribeDomainOptions:describeDomainOptions
completionHandler: ^(OAIDescribeMailServerDomainResult* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIMailServerControllerApi->describeMailServerDomain: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
describeDomainOptions | OAIDescribeDomainOptions* |
Return type
OAIDescribeMailServerDomainResult*
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) getDnsLookupWithDNSLookupOptions: (OAIDNSLookupOptions*) dNSLookupOptions
completionHandler: (void (^)(OAIDNSLookupResults* output, NSError* error)) handler;
Lookup DNS records for a domain
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"];
OAIDNSLookupOptions* dNSLookupOptions = [[OAIDNSLookupOptions alloc] init]; //
OAIMailServerControllerApi*apiInstance = [[OAIMailServerControllerApi alloc] init];
// Lookup DNS records for a domain
[apiInstance getDnsLookupWithDNSLookupOptions:dNSLookupOptions
completionHandler: ^(OAIDNSLookupResults* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIMailServerControllerApi->getDnsLookup: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
dNSLookupOptions | OAIDNSLookupOptions* |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
-(NSURLSessionTask*) getIpAddressWithName: (NSString*) name
completionHandler: (void (^)(OAIIPAddressResult* output, NSError* error)) handler;
Get IP address for a domain
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* name = @"name_example"; //
OAIMailServerControllerApi*apiInstance = [[OAIMailServerControllerApi alloc] init];
// Get IP address for a domain
[apiInstance getIpAddressWithName:name
completionHandler: ^(OAIIPAddressResult* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIMailServerControllerApi->getIpAddress: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
name | NSString* |
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*) verifyEmailAddressWithVerifyEmailAddressOptions: (OAIVerifyEmailAddressOptions*) verifyEmailAddressOptions
completionHandler: (void (^)(OAIEmailVerificationResult* output, NSError* error)) handler;
Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
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"];
OAIVerifyEmailAddressOptions* verifyEmailAddressOptions = [[OAIVerifyEmailAddressOptions alloc] init]; //
OAIMailServerControllerApi*apiInstance = [[OAIMailServerControllerApi alloc] init];
// Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.
[apiInstance verifyEmailAddressWithVerifyEmailAddressOptions:verifyEmailAddressOptions
completionHandler: ^(OAIEmailVerificationResult* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling OAIMailServerControllerApi->verifyEmailAddress: %@", error);
}
}];
Parameters
Name | Type | Description | Notes |
---|---|---|---|
verifyEmailAddressOptions | OAIVerifyEmailAddressOptions* |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]