# 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
verifyEmailAddress POST /mail-server/verify/email-address Verify 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.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.MailServerControllerApi;
public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mailslurp.com");
    // Configure API key authorization: API_KEY
    ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
    API_KEY.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //API_KEY.setApiKeyPrefix("Token");
    MailServerControllerApi apiInstance = new MailServerControllerApi(defaultClient);
    DescribeDomainOptions describeOptions = new DescribeDomainOptions(); // DescribeDomainOptions | describeOptions
    try {
      DescribeMailServerDomainResult result = apiInstance.describeMailServerDomain(describeOptions);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MailServerControllerApi#describeMailServerDomain");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

# Parameters

Name Type Description Notes
describeOptions DescribeDomainOptions describeOptions

# Return type

DescribeMailServerDomainResult

# Authorization

API_KEY

# HTTP request headers

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

# HTTP response details

Status code Description Response headers
200 OK -
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

# verifyEmailAddress

EmailVerificationResult verifyEmailAddress(verifyOptions)

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

# Example

// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.MailServerControllerApi;
public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.mailslurp.com");
    // Configure API key authorization: API_KEY
    ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
    API_KEY.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //API_KEY.setApiKeyPrefix("Token");
    MailServerControllerApi apiInstance = new MailServerControllerApi(defaultClient);
    VerifyEmailAddressOptions verifyOptions = new VerifyEmailAddressOptions(); // VerifyEmailAddressOptions | verifyOptions
    try {
      EmailVerificationResult result = apiInstance.verifyEmailAddress(verifyOptions);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MailServerControllerApi#verifyEmailAddress");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

# Parameters

Name Type Description Notes
verifyOptions VerifyEmailAddressOptions verifyOptions

# Return type

EmailVerificationResult

# Authorization

API_KEY

# HTTP request headers

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

# HTTP response details

Status code Description Response headers
200 OK -
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -