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 describeOptions) Get DNS Mail Server records for a domain
okhttp3.Call	describeMailServerDomainAsync(DescribeDomainOptions describeOptions, ApiCallback<DescribeMailServerDomainResult> _callback) Get DNS Mail Server records for a domain (asynchronously)
okhttp3.Call	describeMailServerDomainCall(DescribeDomainOptions describeOptions, ApiCallback _callback) Build call for describeMailServerDomain
ApiResponse<DescribeMailServerDomainResult>	describeMailServerDomainWithHttpInfo(DescribeDomainOptions describeOptions) Get DNS Mail Server records for a domain
ApiClient	getApiClient()
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
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)
EmailVerificationResult	verifyEmailAddress(VerifyEmailAddressOptions verifyOptions) Verify the existence of an email address at a given mail server.
okhttp3.Call	verifyEmailAddressAsync(VerifyEmailAddressOptions verifyOptions, ApiCallback<EmailVerificationResult> _callback) Verify the existence of an email address at a given mail server.
okhttp3.Call	verifyEmailAddressCall(VerifyEmailAddressOptions verifyOptions, ApiCallback _callback) Build call for verifyEmailAddress
ApiResponse<EmailVerificationResult>	verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyOptions) Verify the existence of an email address at a given mail server.

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)

describeMailServerDomainCall

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

Build call for describeMailServerDomain

Parameters:

describeOptions - describeOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

describeMailServerDomain

public DescribeMailServerDomainResult describeMailServerDomain(DescribeDomainOptions describeOptions)
                                                        throws ApiException

Get DNS Mail Server records for a domain

Parameters:

describeOptions - describeOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

describeMailServerDomainWithHttpInfo

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

Get DNS Mail Server records for a domain

Parameters:

describeOptions - describeOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

describeMailServerDomainAsync

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

Get DNS Mail Server records for a domain (asynchronously)

Parameters:

describeOptions - describeOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getDnsLookupCall

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

Build call for getDnsLookup

Parameters:

dnsLookupOptions - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getDnsLookup

public DNSLookupResults getDnsLookup(DNSLookupOptions dnsLookupOptions)
                              throws ApiException

Lookup DNS records for a domain

Parameters:

dnsLookupOptions - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getDnsLookupWithHttpInfo

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

Lookup DNS records for a domain

Parameters:

dnsLookupOptions - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getDnsLookupAsync

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

Lookup DNS records for a domain (asynchronously)

Parameters:

dnsLookupOptions - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getIpAddressCall

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

Build call for getIpAddress

Parameters:

name - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getIpAddress

public IPAddressResult getIpAddress(String name)
                             throws ApiException

Get IP address for a domain

Parameters:

name - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getIpAddressWithHttpInfo

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

Get IP address for a domain

Parameters:

name - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getIpAddressAsync

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

Get IP address for a domain (asynchronously)

Parameters:

name - 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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

verifyEmailAddressCall

public okhttp3.Call verifyEmailAddressCall(VerifyEmailAddressOptions verifyOptions,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for verifyEmailAddress

Parameters:

verifyOptions - verifyOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

verifyEmailAddress

public EmailVerificationResult verifyEmailAddress(VerifyEmailAddressOptions verifyOptions)
                                           throws ApiException

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

Parameters:

verifyOptions - verifyOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

verifyEmailAddressWithHttpInfo

public ApiResponse<EmailVerificationResult> verifyEmailAddressWithHttpInfo(VerifyEmailAddressOptions verifyOptions)
                                                                    throws ApiException

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

Parameters:

verifyOptions - verifyOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

verifyEmailAddressAsync

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

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

Parameters:

verifyOptions - verifyOptions (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	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-