# MailServerControllerAPI

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 Verify the existence of an email address at a given mail server.

# describeMailServerDomain

    open class func describeMailServerDomain(describeOptions: DescribeDomainOptions, completion: @escaping (_ data: DescribeMailServerDomainResult?, _ error: Error?) -> Void)

Get DNS Mail Server records for a domain

# Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let describeOptions = DescribeDomainOptions(domain: "domain_example") // DescribeDomainOptions | describeOptions
// Get DNS Mail Server records for a domain
MailServerControllerAPI.describeMailServerDomain(describeOptions: describeOptions) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

Name Type Description Notes
describeOptions DescribeDomainOptions describeOptions

# Return type

DescribeMailServerDomainResult

# 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 README]

# getDnsLookup

    open class func getDnsLookup(dnsLookupOptions: DNSLookupOptions, completion: @escaping (_ data: DNSLookupResults?, _ error: Error?) -> Void)

Lookup DNS records for a domain

# Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let dnsLookupOptions = DNSLookupOptions(hostname: "hostname_example", omitFinalDNSDot: false, recordTypes: ["recordTypes_example"]) // DNSLookupOptions | dnsLookupOptions
// Lookup DNS records for a domain
MailServerControllerAPI.getDnsLookup(dnsLookupOptions: dnsLookupOptions) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

Name Type Description Notes
dnsLookupOptions DNSLookupOptions dnsLookupOptions

# Return type

DNSLookupResults

# 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 README]

# getIpAddress

    open class func getIpAddress(name: String, completion: @escaping (_ data: IPAddressResult?, _ error: Error?) -> Void)

Get IP address for a domain

# Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let name = "name_example" // String | name
// Get IP address for a domain
MailServerControllerAPI.getIpAddress(name: name) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

Name Type Description Notes
name String name

# Return type

IPAddressResult

# 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 README]

# verifyEmailAddress

    open class func verifyEmailAddress(verifyOptions: VerifyEmailAddressOptions, completion: @escaping (_ data: EmailVerificationResult?, _ error: Error?) -> Void)

Verify the existence of an email address at a given mail server.

# Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import mailslurp
let verifyOptions = VerifyEmailAddressOptions(mailServerDomain: "mailServerDomain_example", emailAddress: "emailAddress_example", senderEmailAddress: "senderEmailAddress_example", port: 123) // VerifyEmailAddressOptions | verifyOptions
// Verify the existence of an email address at a given mail server.
MailServerControllerAPI.verifyEmailAddress(verifyOptions: verifyOptions) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }
    if (response) {
        dump(response)
    }
}

# Parameters

Name Type Description Notes
verifyOptions VerifyEmailAddressOptions verifyOptions

# Return type

EmailVerificationResult

# 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 README]