OAIMailServerControllerApi

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

MethodHTTP requestDescription
describeMailServerDomainPOST /mail-server/describe/domainGet DNS Mail Server records for a domain
getDnsLookupPOST /mail-server/describe/dns-lookupLookup DNS records for a domain
getIpAddressPOST /mail-server/describe/ip-addressGet IP address for a domain
verifyEmailAddressPOST /mail-server/verify/email-addressVerify the existence of an email address at a given mail server.

describeMailServerDomain

-(NSURLSessionTask*) describeMailServerDomainWithDescribeOptions: (OAIDescribeDomainOptions*) describeOptions
        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* describeOptions = [[OAIDescribeDomainOptions alloc] init]; // describeOptions

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

// Get DNS Mail Server records for a domain
[apiInstance describeMailServerDomainWithDescribeOptions:describeOptions
          completionHandler: ^(OAIDescribeMailServerDomainResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIMailServerControllerApi->describeMailServerDomain: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
describeOptionsOAIDescribeDomainOptions*describeOptions

Return type

OAIDescribeMailServerDomainResult*

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 ]

getDnsLookup

-(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]; // dnsLookupOptions

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

NameTypeDescriptionNotes
dnsLookupOptionsOAIDNSLookupOptions*dnsLookupOptions

Return type

OAIDNSLookupResults*

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 ]

getIpAddress

-(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"; // name

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

NameTypeDescriptionNotes
nameNSString*name

Return type

OAIIPAddressResult*

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 ]

verifyEmailAddress

-(NSURLSessionTask*) verifyEmailAddressWithVerifyOptions: (OAIVerifyEmailAddressOptions*) verifyOptions
        completionHandler: (void (^)(OAIEmailVerificationResult* output, NSError* error)) handler;

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* verifyOptions = [[OAIVerifyEmailAddressOptions alloc] init]; // verifyOptions

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

// Verify the existence of an email address at a given mail server.
[apiInstance verifyEmailAddressWithVerifyOptions:verifyOptions
          completionHandler: ^(OAIEmailVerificationResult* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIMailServerControllerApi->verifyEmailAddress: %@", error);
                        }
                    }];

Parameters

NameTypeDescriptionNotes
verifyOptionsOAIVerifyEmailAddressOptions*verifyOptions

Return type

OAIEmailVerificationResult*

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 ]