Skip to content

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 Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

DescribeMailServerDomainResult describeMailServerDomain(describeDomainOptions)

Get DNS Mail Server records for a domain

Example

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

val apiInstance = MailServerControllerApi()
val describeDomainOptions : DescribeDomainOptions =  // DescribeDomainOptions | 
try {
    val result : DescribeMailServerDomainResult = apiInstance.describeMailServerDomain(describeDomainOptions)
    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

Name Type Description Notes
describeDomainOptions DescribeDomainOptions

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: /

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 | 
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

Name Type Description Notes
dnSLookupOptions DNSLookupOptions

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: /

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 | 
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

Name Type Description Notes
name kotlin.String

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: /

EmailVerificationResult verifyEmailAddress(verifyEmailAddressOptions)

Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. 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 verifyEmailAddressOptions : VerifyEmailAddressOptions =  // VerifyEmailAddressOptions | 
try {
    val result : EmailVerificationResult = apiInstance.verifyEmailAddress(verifyEmailAddressOptions)
    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

Name Type Description Notes
verifyEmailAddressOptions VerifyEmailAddressOptions

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: /