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

Parameters

NameTypeDescriptionNotes
describeOptionsDescribeDomainOptionsdescribeOptions

Return type

DescribeMailServerDomainResult

Authorization

API_KEY

HTTP request headers

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

getDnsLookup

DNSLookupResults getDnsLookup(dnsLookupOptions)

Lookup DNS records for a domain

Parameters

NameTypeDescriptionNotes
dnsLookupOptionsDNSLookupOptionsdnsLookupOptions

Return type

DNSLookupResults

Authorization

API_KEY

HTTP request headers

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

getIpAddress

IPAddressResult getIpAddress(name)

Get IP address for a domain

Parameters

NameTypeDescriptionNotes
nameStringname[default to null]

Return type

IPAddressResult

Authorization

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.

Parameters

NameTypeDescriptionNotes
verifyOptionsVerifyEmailAddressOptionsverifyOptions

Return type

EmailVerificationResult

Authorization

API_KEY

HTTP request headers

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