com.mailslurp.apis

Class DomainControllerApi

java.lang.Object

com.mailslurp.apis.DomainControllerApi

public class DomainControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DomainControllerApi()
DomainControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DomainDto	addDomainWildcardCatchAll(UUID id) Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
okhttp3.Call	addDomainWildcardCatchAllAsync(UUID id, ApiCallback<DomainDto> _callback) Add catch all wild card inbox to domain (asynchronously) Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
okhttp3.Call	addDomainWildcardCatchAllCall(UUID id, ApiCallback _callback) Build call for addDomainWildcardCatchAll
ApiResponse<DomainDto>	addDomainWildcardCatchAllWithHttpInfo(UUID id) Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated
DomainDto	createDomain(CreateDomainOptions domainOptions) Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it.
okhttp3.Call	createDomainAsync(CreateDomainOptions domainOptions, ApiCallback<DomainDto> _callback) Create Domain (asynchronously) Link a domain that you own with MailSlurp so you can create email addresses using it.
okhttp3.Call	createDomainCall(CreateDomainOptions domainOptions, ApiCallback _callback) Build call for createDomain
ApiResponse<DomainDto>	createDomainWithHttpInfo(CreateDomainOptions domainOptions) Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it.
List<String>	deleteDomain(UUID id) Delete a domain Delete a domain.
okhttp3.Call	deleteDomainAsync(UUID id, ApiCallback<List<String>> _callback) Delete a domain (asynchronously) Delete a domain.
okhttp3.Call	deleteDomainCall(UUID id, ApiCallback _callback) Build call for deleteDomain
ApiResponse<List<String>>	deleteDomainWithHttpInfo(UUID id) Delete a domain Delete a domain.
ApiClient	getApiClient()
DomainDto	getDomain(UUID id) Get a domain Returns domain verification status and tokens for a given domain
okhttp3.Call	getDomainAsync(UUID id, ApiCallback<DomainDto> _callback) Get a domain (asynchronously) Returns domain verification status and tokens for a given domain
okhttp3.Call	getDomainCall(UUID id, ApiCallback _callback) Build call for getDomain
List<DomainPreview>	getDomains() Get domains List all custom domains you have created
okhttp3.Call	getDomainsAsync(ApiCallback<List<DomainPreview>> _callback) Get domains (asynchronously) List all custom domains you have created
okhttp3.Call	getDomainsCall(ApiCallback _callback) Build call for getDomains
ApiResponse<List<DomainPreview>>	getDomainsWithHttpInfo() Get domains List all custom domains you have created
ApiResponse<DomainDto>	getDomainWithHttpInfo(UUID id) Get a domain Returns domain verification status and tokens for a given domain
void	setApiClient(ApiClient apiClient)
DomainDto	updateDomain(UUID id, UpdateDomainOptions updateDomainDto) Update a domain Update values on a domain.
okhttp3.Call	updateDomainAsync(UUID id, UpdateDomainOptions updateDomainDto, ApiCallback<DomainDto> _callback) Update a domain (asynchronously) Update values on a domain.
okhttp3.Call	updateDomainCall(UUID id, UpdateDomainOptions updateDomainDto, ApiCallback _callback) Build call for updateDomain
ApiResponse<DomainDto>	updateDomainWithHttpInfo(UUID id, UpdateDomainOptions updateDomainDto) Update a domain Update values on a domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainControllerApi

public DomainControllerApi()

DomainControllerApi

public DomainControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addDomainWildcardCatchAllCall

public okhttp3.Call addDomainWildcardCatchAllCall(UUID id,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for addDomainWildcardCatchAll

Parameters:

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

addDomainWildcardCatchAll

public DomainDto addDomainWildcardCatchAll(UUID id)
                                    throws ApiException

Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

Parameters:

id - id (required)

Returns:

DomainDto

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	-

addDomainWildcardCatchAllWithHttpInfo

public ApiResponse<DomainDto> addDomainWildcardCatchAllWithHttpInfo(UUID id)
                                                             throws ApiException

Add catch all wild card inbox to domain Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

Parameters:

id - id (required)

Returns:

ApiResponse<DomainDto>

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	-

addDomainWildcardCatchAllAsync

public okhttp3.Call addDomainWildcardCatchAllAsync(UUID id,
                                                   ApiCallback<DomainDto> _callback)
                                            throws ApiException

Add catch all wild card inbox to domain (asynchronously) Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

Parameters:

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

createDomainCall

public okhttp3.Call createDomainCall(CreateDomainOptions domainOptions,
                                     ApiCallback _callback)
                              throws ApiException

Build call for createDomain

Parameters:

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

createDomain

public DomainDto createDomain(CreateDomainOptions domainOptions)
                       throws ApiException

Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

Parameters:

domainOptions - domainOptions (required)

Returns:

DomainDto

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

createDomainWithHttpInfo

public ApiResponse<DomainDto> createDomainWithHttpInfo(CreateDomainOptions domainOptions)
                                                throws ApiException

Create Domain Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

Parameters:

domainOptions - domainOptions (required)

Returns:

ApiResponse<DomainDto>

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

createDomainAsync

public okhttp3.Call createDomainAsync(CreateDomainOptions domainOptions,
                                      ApiCallback<DomainDto> _callback)
                               throws ApiException

Create Domain (asynchronously) Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider's DNS setup to verify the domain.

Parameters:

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

deleteDomainCall

public okhttp3.Call deleteDomainCall(UUID id,
                                     ApiCallback _callback)
                              throws ApiException

Build call for deleteDomain

Parameters:

id - id (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
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteDomain

public List<String> deleteDomain(UUID id)
                          throws ApiException

Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.

Parameters:

id - id (required)

Returns:

List<String>

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
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteDomainWithHttpInfo

public ApiResponse<List<String>> deleteDomainWithHttpInfo(UUID id)
                                                   throws ApiException

Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.

Parameters:

id - id (required)

Returns:

ApiResponse<List<String>>

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
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteDomainAsync

public okhttp3.Call deleteDomainAsync(UUID id,
                                      ApiCallback<List<String>> _callback)
                               throws ApiException

Delete a domain (asynchronously) Delete a domain. This will disable any existing inboxes that use this domain.

Parameters:

id - id (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
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

getDomainCall

public okhttp3.Call getDomainCall(UUID id,
                                  ApiCallback _callback)
                           throws ApiException

Build call for getDomain

Parameters:

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

getDomain

public DomainDto getDomain(UUID id)
                    throws ApiException

Get a domain Returns domain verification status and tokens for a given domain

Parameters:

id - id (required)

Returns:

DomainDto

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

getDomainWithHttpInfo

public ApiResponse<DomainDto> getDomainWithHttpInfo(UUID id)
                                             throws ApiException

Get a domain Returns domain verification status and tokens for a given domain

Parameters:

id - id (required)

Returns:

ApiResponse<DomainDto>

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

getDomainAsync

public okhttp3.Call getDomainAsync(UUID id,
                                   ApiCallback<DomainDto> _callback)
                            throws ApiException

Get a domain (asynchronously) Returns domain verification status and tokens for a given domain

Parameters:

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

getDomainsCall

public okhttp3.Call getDomainsCall(ApiCallback _callback)
                            throws ApiException

Build call for getDomains

Parameters:

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getDomains

public List<DomainPreview> getDomains()
                               throws ApiException

Get domains List all custom domains you have created

Returns:

List<DomainPreview>

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

getDomainsWithHttpInfo

public ApiResponse<List<DomainPreview>> getDomainsWithHttpInfo()
                                                        throws ApiException

Get domains List all custom domains you have created

Returns:

ApiResponse<List<DomainPreview>>

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

getDomainsAsync

public okhttp3.Call getDomainsAsync(ApiCallback<List<DomainPreview>> _callback)
                             throws ApiException

Get domains (asynchronously) List all custom domains you have created

Parameters:

_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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

updateDomainCall

public okhttp3.Call updateDomainCall(UUID id,
                                     UpdateDomainOptions updateDomainDto,
                                     ApiCallback _callback)
                              throws ApiException

Build call for updateDomain

Parameters:

id - id (required)

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

updateDomain

public DomainDto updateDomain(UUID id,
                              UpdateDomainOptions updateDomainDto)
                       throws ApiException

Update a domain Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

Parameters:

id - id (required)

updateDomainDto - updateDomainDto (required)

Returns:

DomainDto

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	-

updateDomainWithHttpInfo

public ApiResponse<DomainDto> updateDomainWithHttpInfo(UUID id,
                                                       UpdateDomainOptions updateDomainDto)
                                                throws ApiException

Update a domain Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

Parameters:

id - id (required)

updateDomainDto - updateDomainDto (required)

Returns:

ApiResponse<DomainDto>

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	-

updateDomainAsync

public okhttp3.Call updateDomainAsync(UUID id,
                                      UpdateDomainOptions updateDomainDto,
                                      ApiCallback<DomainDto> _callback)
                               throws ApiException

Update a domain (asynchronously) Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

Parameters:

id - id (required)

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