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

DescribeMailServerDomainResult describeMailServerDomain(describeOptions)

Get DNS Mail Server records for a domain

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = MailServerControllerApi()
val describeOptions : DescribeDomainOptions =  // DescribeDomainOptions | describeOptions
try {
    val result : DescribeMailServerDomainResult = apiInstance.describeMailServerDomain(describeOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MailServerControllerApi#describeMailServerDomain")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MailServerControllerApi#describeMailServerDomain")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
describeOptionsDescribeDomainOptionsdescribeOptions

Return type

DescribeMailServerDomainResult

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-api-key”] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getDnsLookup

DNSLookupResults getDnsLookup(dnsLookupOptions)

Lookup DNS records for a domain

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = MailServerControllerApi()
val dnsLookupOptions : DNSLookupOptions =  // DNSLookupOptions | dnsLookupOptions
try {
    val result : DNSLookupResults = apiInstance.getDnsLookup(dnsLookupOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MailServerControllerApi#getDnsLookup")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MailServerControllerApi#getDnsLookup")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
dnsLookupOptionsDNSLookupOptionsdnsLookupOptions

Return type

DNSLookupResults

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-api-key”] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getIpAddress

IPAddressResult getIpAddress(name)

Get IP address for a domain

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = MailServerControllerApi()
val name : kotlin.String = name_example // kotlin.String | name
try {
    val result : IPAddressResult = apiInstance.getIpAddress(name)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MailServerControllerApi#getIpAddress")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MailServerControllerApi#getIpAddress")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
namekotlin.Stringname

Return type

IPAddressResult

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-api-key”] = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

verifyEmailAddress

EmailVerificationResult verifyEmailAddress(verifyOptions)

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

Example

// Import classes:
//import com.mailslurp.infrastructure.*
//import com.mailslurp.models.*

val apiInstance = MailServerControllerApi()
val verifyOptions : VerifyEmailAddressOptions =  // VerifyEmailAddressOptions | verifyOptions
try {
    val result : EmailVerificationResult = apiInstance.verifyEmailAddress(verifyOptions)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MailServerControllerApi#verifyEmailAddress")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MailServerControllerApi#verifyEmailAddress")
    e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
verifyOptionsVerifyEmailAddressOptionsverifyOptions

Return type

EmailVerificationResult

Authorization

Configure API_KEY: ApiClient.apiKey[“x-api-key”] = "" ApiClient.apiKeyPrefix[“x-api-key”] = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json