MailServerControllerAPI

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

    open class func describeMailServerDomain( describeOptions: DescribeDomainOptions) -> Promise<DescribeMailServerDomainResult>

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).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
describeOptionsDescribeDomainOptionsdescribeOptions

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 ]

getDnsLookup

    open class func getDnsLookup( dnsLookupOptions: DNSLookupOptions) -> Promise<DNSLookupResults>

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).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
dnsLookupOptionsDNSLookupOptionsdnsLookupOptions

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 ]

getIpAddress

    open class func getIpAddress( name: String) -> Promise<IPAddressResult>

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).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
nameStringname

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 ]

verifyEmailAddress

    open class func verifyEmailAddress( verifyOptions: VerifyEmailAddressOptions) -> Promise<EmailVerificationResult>

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).then {
         // when the promise is fulfilled
     }.always {
         // regardless of whether the promise is fulfilled, or rejected
     }.catch { errorType in
         // when the promise is rejected
}

Parameters

NameTypeDescriptionNotes
verifyOptionsVerifyEmailAddressOptionsverifyOptions

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 ]