com.mailslurp.apis

Class MailServerControllerApi

java.lang.Object

com.mailslurp.apis.MailServerControllerApi

public class MailServerControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MailServerControllerApi()
MailServerControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DescribeMailServerDomainResult	describeMailServerDomain(DescribeDomainOptions describeDomainOptions) Get DNS Mail Server records for a domain
okhttp3.Call	describeMailServerDomainAsync(DescribeDomainOptions describeDomainOptions, ApiCallback<DescribeMailServerDomainResult> _callback) Get DNS Mail Server records for a domain (asynchronously)
okhttp3.Call	describeMailServerDomainCall(DescribeDomainOptions describeDomainOptions, ApiCallback _callback) Build call for describeMailServerDomain
ApiResponse<DescribeMailServerDomainResult>	describeMailServerDomainWithHttpInfo(DescribeDomainOptions describeDomainOptions) Get DNS Mail Server records for a domain
ApiClient	getApiClient()
String	getCustomBaseUrl()
DNSLookupResults	getDnsLookup(DNSLookupOptions dnSLookupOptions) Lookup DNS records for a domain
okhttp3.Call	getDnsLookupAsync(DNSLookupOptions dnSLookupOptions, ApiCallback<DNSLookupResults> _callback) Lookup DNS records for a domain (asynchronously)
okhttp3.Call	getDnsLookupCall(DNSLookupOptions dnSLookupOptions, ApiCallback _callback) Build call for getDnsLookup
ApiResponse<DNSLookupResults>	getDnsLookupWithHttpInfo(DNSLookupOptions dnSLookupOptions) Lookup DNS records for a domain
int	getHostIndex()
IPAddressResult	getIpAddress(String name) Get IP address for a domain
okhttp3.Call	getIpAddressAsync(String name, ApiCallback<IPAddressResult> _callback) Get IP address for a domain (asynchronously)
okhttp3.Call	getIpAddressCall(String name, ApiCallback _callback) Build call for getIpAddress
ApiResponse<IPAddressResult>	getIpAddressWithHttpInfo(String name) Get IP address for a domain
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
EmailVerificationResult	verifyEmailAddress(VerifyEmailAddressOptions verifyEmailAddressOptions) Deprecated.
okhttp3.Call	verifyEmailAddressAsync(VerifyEmailAddressOptions verifyEmailAddressOptions, ApiCallback<EmailVerificationResult> _callback) Deprecated.
okhttp3.Call	verifyEmailAddressCall(VerifyEmailAddressOptions verifyEmailAddressOptions, ApiCallback _callback) Deprecated.
ApiResponse<EmailVerificationResult>	verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyEmailAddressOptions) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailServerControllerApi

public MailServerControllerApi()

MailServerControllerApi

public MailServerControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

describeMailServerDomainCall

public okhttp3.Call describeMailServerDomainCall(DescribeDomainOptions describeDomainOptions,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for describeMailServerDomain

Parameters:

describeDomainOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

describeMailServerDomain

public DescribeMailServerDomainResult describeMailServerDomain(DescribeDomainOptions describeDomainOptions)
                                                        throws ApiException

Get DNS Mail Server records for a domain

Parameters:

describeDomainOptions - (required)

Returns:

DescribeMailServerDomainResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

describeMailServerDomainWithHttpInfo

public ApiResponse<DescribeMailServerDomainResult> describeMailServerDomainWithHttpInfo(DescribeDomainOptions describeDomainOptions)
                                                                                 throws ApiException

Get DNS Mail Server records for a domain

Parameters:

describeDomainOptions - (required)

Returns:

ApiResponse<DescribeMailServerDomainResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

describeMailServerDomainAsync

public okhttp3.Call describeMailServerDomainAsync(DescribeDomainOptions describeDomainOptions,
                                                  ApiCallback<DescribeMailServerDomainResult> _callback)
                                           throws ApiException

Get DNS Mail Server records for a domain (asynchronously)

Parameters:

describeDomainOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getDnsLookupCall

public okhttp3.Call getDnsLookupCall(DNSLookupOptions dnSLookupOptions,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getDnsLookup

Parameters:

dnSLookupOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getDnsLookup

public DNSLookupResults getDnsLookup(DNSLookupOptions dnSLookupOptions)
                              throws ApiException

Lookup DNS records for a domain

Parameters:

dnSLookupOptions - (required)

Returns:

DNSLookupResults

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getDnsLookupWithHttpInfo

public ApiResponse<DNSLookupResults> getDnsLookupWithHttpInfo(DNSLookupOptions dnSLookupOptions)
                                                       throws ApiException

Lookup DNS records for a domain

Parameters:

dnSLookupOptions - (required)

Returns:

ApiResponse<DNSLookupResults>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getDnsLookupAsync

public okhttp3.Call getDnsLookupAsync(DNSLookupOptions dnSLookupOptions,
                                      ApiCallback<DNSLookupResults> _callback)
                               throws ApiException

Lookup DNS records for a domain (asynchronously)

Parameters:

dnSLookupOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getIpAddressCall

public okhttp3.Call getIpAddressCall(String name,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getIpAddress

Parameters:

name - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getIpAddress

public IPAddressResult getIpAddress(String name)
                             throws ApiException

Get IP address for a domain

Parameters:

name - (required)

Returns:

IPAddressResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getIpAddressWithHttpInfo

public ApiResponse<IPAddressResult> getIpAddressWithHttpInfo(String name)
                                                      throws ApiException

Get IP address for a domain

Parameters:

name - (required)

Returns:

ApiResponse<IPAddressResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getIpAddressAsync

public okhttp3.Call getIpAddressAsync(String name,
                                      ApiCallback<IPAddressResult> _callback)
                               throws ApiException

Get IP address for a domain (asynchronously)

Parameters:

name - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

verifyEmailAddressCall

@Deprecated
public okhttp3.Call verifyEmailAddressCall(VerifyEmailAddressOptions verifyEmailAddressOptions,
                                                       ApiCallback _callback)
                                                throws ApiException

Deprecated.

Build call for verifyEmailAddress

Parameters:

verifyEmailAddressOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

verifyEmailAddress

@Deprecated
public EmailVerificationResult verifyEmailAddress(VerifyEmailAddressOptions verifyEmailAddressOptions)
                                                       throws ApiException

Deprecated.

Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

Parameters:

verifyEmailAddressOptions - (required)

Returns:

EmailVerificationResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

verifyEmailAddressWithHttpInfo

@Deprecated
public ApiResponse<EmailVerificationResult> verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyEmailAddressOptions)
                                                                                throws ApiException

Deprecated.

Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server.

Parameters:

verifyEmailAddressOptions - (required)

Returns:

ApiResponse<EmailVerificationResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

verifyEmailAddressAsync

@Deprecated
public okhttp3.Call verifyEmailAddressAsync(VerifyEmailAddressOptions verifyEmailAddressOptions,
                                                        ApiCallback<EmailVerificationResult> _callback)
                                                 throws ApiException

Deprecated.

Deprecated. Use the EmailVerificationController methods for more accurate and reliable functionality. Verify the existence of an email address at a given mail server. (asynchronously)

Parameters:

verifyEmailAddressOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-