public class DomainControllerApi extends Object
| Constructor and Description |
|---|
DomainControllerApi() |
DomainControllerApi(ApiClient apiClient) |
| 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.
|
public DomainControllerApi()
public DomainControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call addDomainWildcardCatchAllCall(UUID id, ApiCallback _callback) throws ApiException
id - id (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public DomainDto addDomainWildcardCatchAll(UUID id) throws ApiException
id - id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<DomainDto> addDomainWildcardCatchAllWithHttpInfo(UUID id) throws ApiException
id - id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call addDomainWildcardCatchAllAsync(UUID id, ApiCallback<DomainDto> _callback) throws ApiException
id - id (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createDomainCall(CreateDomainOptions domainOptions, ApiCallback _callback) throws ApiException
domainOptions - domainOptions (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public DomainDto createDomain(CreateDomainOptions domainOptions) throws ApiException
domainOptions - domainOptions (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<DomainDto> createDomainWithHttpInfo(CreateDomainOptions domainOptions) throws ApiException
domainOptions - domainOptions (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call createDomainAsync(CreateDomainOptions domainOptions, ApiCallback<DomainDto> _callback) throws ApiException
domainOptions - domainOptions (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call deleteDomainCall(UUID id, ApiCallback _callback) throws ApiException
id - id (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public List<String> deleteDomain(UUID id) throws ApiException
id - id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public ApiResponse<List<String>> deleteDomainWithHttpInfo(UUID id) throws ApiException
id - id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call deleteDomainAsync(UUID id, ApiCallback<List<String>> _callback) throws ApiException
id - id (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
public okhttp3.Call getDomainCall(UUID id, ApiCallback _callback) throws ApiException
id - id (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public DomainDto getDomain(UUID id) throws ApiException
id - id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<DomainDto> getDomainWithHttpInfo(UUID id) throws ApiException
id - id (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getDomainAsync(UUID id, ApiCallback<DomainDto> _callback) throws ApiException
id - id (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getDomainsCall(ApiCallback _callback) throws ApiException
_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public List<DomainPreview> getDomains() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<List<DomainPreview>> getDomainsWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call getDomainsAsync(ApiCallback<List<DomainPreview>> _callback) throws ApiException
_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call updateDomainCall(UUID id, UpdateDomainOptions updateDomainDto, ApiCallback _callback) throws ApiException
id - id (required)updateDomainDto - updateDomainDto (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public DomainDto updateDomain(UUID id, UpdateDomainOptions updateDomainDto) throws ApiException
id - id (required)updateDomainDto - updateDomainDto (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public ApiResponse<DomainDto> updateDomainWithHttpInfo(UUID id, UpdateDomainOptions updateDomainDto) throws ApiException
id - id (required)updateDomainDto - updateDomainDto (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
public okhttp3.Call updateDomainAsync(UUID id, UpdateDomainOptions updateDomainDto, ApiCallback<DomainDto> _callback) throws ApiException
id - id (required)updateDomainDto - updateDomainDto (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 200 | OK | - |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
Copyright © 2021. All rights reserved.