com.mailslurp.apis

Class CommonActionsControllerApi

java.lang.Object

com.mailslurp.apis.CommonActionsControllerApi

public class CommonActionsControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CommonActionsControllerApi()
CommonActionsControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
InboxDto	createNewEmailAddress(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId) Create new random inbox Returns an Inbox with an `id` and an `emailAddress`
okhttp3.Call	createNewEmailAddressAsync(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId, ApiCallback<InboxDto> _callback) Create new random inbox (asynchronously) Returns an Inbox with an `id` and an `emailAddress`
okhttp3.Call	createNewEmailAddressCall(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId, ApiCallback _callback) Build call for createNewEmailAddress
ApiResponse<InboxDto>	createNewEmailAddressWithHttpInfo(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId) Create new random inbox Returns an Inbox with an `id` and an `emailAddress`
InboxDto	createRandomInbox(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId) Create new random inbox Returns an Inbox with an `id` and an `emailAddress`
okhttp3.Call	createRandomInboxAsync(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId, ApiCallback<InboxDto> _callback) Create new random inbox (asynchronously) Returns an Inbox with an `id` and an `emailAddress`
okhttp3.Call	createRandomInboxCall(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId, ApiCallback _callback) Build call for createRandomInbox
ApiResponse<InboxDto>	createRandomInboxWithHttpInfo(Boolean allowTeamAccess, Boolean useDomainPool, OffsetDateTime expiresAt, Long expiresIn, String emailAddress, String inboxType, String description, String name, List<String> tags, Boolean favourite, Boolean virtualInbox, Boolean useShortAddress, String domainName, UUID domainId) Create new random inbox Returns an Inbox with an `id` and an `emailAddress`
void	deleteEmailAddress(UUID inboxId) Delete inbox email address by inbox id Deletes inbox email address
okhttp3.Call	deleteEmailAddressAsync(UUID inboxId, ApiCallback<Void> _callback) Delete inbox email address by inbox id (asynchronously) Deletes inbox email address
okhttp3.Call	deleteEmailAddressCall(UUID inboxId, ApiCallback _callback) Build call for deleteEmailAddress
ApiResponse<Void>	deleteEmailAddressWithHttpInfo(UUID inboxId) Delete inbox email address by inbox id Deletes inbox email address
void	emptyInbox(UUID inboxId) Delete all emails in an inbox Deletes all emails
okhttp3.Call	emptyInboxAsync(UUID inboxId, ApiCallback<Void> _callback) Delete all emails in an inbox (asynchronously) Deletes all emails
okhttp3.Call	emptyInboxCall(UUID inboxId, ApiCallback _callback) Build call for emptyInbox
ApiResponse<Void>	emptyInboxWithHttpInfo(UUID inboxId) Delete all emails in an inbox Deletes all emails
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	sendEmailSimple(SimpleSendEmailOptions simpleSendEmailOptions) Send an email If no senderId or inboxId provided a random email address will be used to send from.
okhttp3.Call	sendEmailSimpleAsync(SimpleSendEmailOptions simpleSendEmailOptions, ApiCallback<Void> _callback) Send an email (asynchronously) If no senderId or inboxId provided a random email address will be used to send from.
okhttp3.Call	sendEmailSimpleCall(SimpleSendEmailOptions simpleSendEmailOptions, ApiCallback _callback) Build call for sendEmailSimple
ApiResponse<Void>	sendEmailSimpleWithHttpInfo(SimpleSendEmailOptions simpleSendEmailOptions) Send an email If no senderId or inboxId provided a random email address will be used to send from.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonActionsControllerApi

public CommonActionsControllerApi()

CommonActionsControllerApi

public CommonActionsControllerApi(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)

createNewEmailAddressCall

public okhttp3.Call createNewEmailAddressCall(Boolean allowTeamAccess,
                                              Boolean useDomainPool,
                                              OffsetDateTime expiresAt,
                                              Long expiresIn,
                                              String emailAddress,
                                              String inboxType,
                                              String description,
                                              String name,
                                              List<String> tags,
                                              Boolean favourite,
                                              Boolean virtualInbox,
                                              Boolean useShortAddress,
                                              String domainName,
                                              UUID domainId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for createNewEmailAddress

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

_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	-

createNewEmailAddress

public InboxDto createNewEmailAddress(Boolean allowTeamAccess,
                                      Boolean useDomainPool,
                                      OffsetDateTime expiresAt,
                                      Long expiresIn,
                                      String emailAddress,
                                      String inboxType,
                                      String description,
                                      String name,
                                      List<String> tags,
                                      Boolean favourite,
                                      Boolean virtualInbox,
                                      Boolean useShortAddress,
                                      String domainName,
                                      UUID domainId)
                               throws ApiException

Create new random inbox Returns an Inbox with an `id` and an `emailAddress`

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

Returns:

InboxDto

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	-

createNewEmailAddressWithHttpInfo

public ApiResponse<InboxDto> createNewEmailAddressWithHttpInfo(Boolean allowTeamAccess,
                                                               Boolean useDomainPool,
                                                               OffsetDateTime expiresAt,
                                                               Long expiresIn,
                                                               String emailAddress,
                                                               String inboxType,
                                                               String description,
                                                               String name,
                                                               List<String> tags,
                                                               Boolean favourite,
                                                               Boolean virtualInbox,
                                                               Boolean useShortAddress,
                                                               String domainName,
                                                               UUID domainId)
                                                        throws ApiException

Create new random inbox Returns an Inbox with an `id` and an `emailAddress`

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

Returns:

ApiResponse<InboxDto>

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	-

createNewEmailAddressAsync

public okhttp3.Call createNewEmailAddressAsync(Boolean allowTeamAccess,
                                               Boolean useDomainPool,
                                               OffsetDateTime expiresAt,
                                               Long expiresIn,
                                               String emailAddress,
                                               String inboxType,
                                               String description,
                                               String name,
                                               List<String> tags,
                                               Boolean favourite,
                                               Boolean virtualInbox,
                                               Boolean useShortAddress,
                                               String domainName,
                                               UUID domainId,
                                               ApiCallback<InboxDto> _callback)
                                        throws ApiException

Create new random inbox (asynchronously) Returns an Inbox with an `id` and an `emailAddress`

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

_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	-

createRandomInboxCall

public okhttp3.Call createRandomInboxCall(Boolean allowTeamAccess,
                                          Boolean useDomainPool,
                                          OffsetDateTime expiresAt,
                                          Long expiresIn,
                                          String emailAddress,
                                          String inboxType,
                                          String description,
                                          String name,
                                          List<String> tags,
                                          Boolean favourite,
                                          Boolean virtualInbox,
                                          Boolean useShortAddress,
                                          String domainName,
                                          UUID domainId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for createRandomInbox

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

_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	-

createRandomInbox

public InboxDto createRandomInbox(Boolean allowTeamAccess,
                                  Boolean useDomainPool,
                                  OffsetDateTime expiresAt,
                                  Long expiresIn,
                                  String emailAddress,
                                  String inboxType,
                                  String description,
                                  String name,
                                  List<String> tags,
                                  Boolean favourite,
                                  Boolean virtualInbox,
                                  Boolean useShortAddress,
                                  String domainName,
                                  UUID domainId)
                           throws ApiException

Create new random inbox Returns an Inbox with an `id` and an `emailAddress`

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

Returns:

InboxDto

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	-

createRandomInboxWithHttpInfo

public ApiResponse<InboxDto> createRandomInboxWithHttpInfo(Boolean allowTeamAccess,
                                                           Boolean useDomainPool,
                                                           OffsetDateTime expiresAt,
                                                           Long expiresIn,
                                                           String emailAddress,
                                                           String inboxType,
                                                           String description,
                                                           String name,
                                                           List<String> tags,
                                                           Boolean favourite,
                                                           Boolean virtualInbox,
                                                           Boolean useShortAddress,
                                                           String domainName,
                                                           UUID domainId)
                                                    throws ApiException

Create new random inbox Returns an Inbox with an `id` and an `emailAddress`

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

Returns:

ApiResponse<InboxDto>

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	-

createRandomInboxAsync

public okhttp3.Call createRandomInboxAsync(Boolean allowTeamAccess,
                                           Boolean useDomainPool,
                                           OffsetDateTime expiresAt,
                                           Long expiresIn,
                                           String emailAddress,
                                           String inboxType,
                                           String description,
                                           String name,
                                           List<String> tags,
                                           Boolean favourite,
                                           Boolean virtualInbox,
                                           Boolean useShortAddress,
                                           String domainName,
                                           UUID domainId,
                                           ApiCallback<InboxDto> _callback)
                                    throws ApiException

Create new random inbox (asynchronously) Returns an Inbox with an `id` and an `emailAddress`

Parameters:

allowTeamAccess - (optional)

useDomainPool - (optional)

expiresAt - (optional)

expiresIn - (optional)

emailAddress - (optional)

inboxType - (optional)

description - (optional)

name - (optional)

tags - (optional)

favourite - (optional)

virtualInbox - (optional)

useShortAddress - (optional)

domainName - (optional)

domainId - (optional)

_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	-

deleteEmailAddressCall

public okhttp3.Call deleteEmailAddressCall(UUID inboxId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for deleteEmailAddress

Parameters:

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

deleteEmailAddress

public void deleteEmailAddress(UUID inboxId)
                        throws ApiException

Delete inbox email address by inbox id Deletes inbox email address

Parameters:

inboxId - (required)

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	-

deleteEmailAddressWithHttpInfo

public ApiResponse<Void> deleteEmailAddressWithHttpInfo(UUID inboxId)
                                                 throws ApiException

Delete inbox email address by inbox id Deletes inbox email address

Parameters:

inboxId - (required)

Returns:

ApiResponse<Void>

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	-

deleteEmailAddressAsync

public okhttp3.Call deleteEmailAddressAsync(UUID inboxId,
                                            ApiCallback<Void> _callback)
                                     throws ApiException

Delete inbox email address by inbox id (asynchronously) Deletes inbox email address

Parameters:

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

emptyInboxCall

public okhttp3.Call emptyInboxCall(UUID inboxId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for emptyInbox

Parameters:

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

emptyInbox

public void emptyInbox(UUID inboxId)
                throws ApiException

Delete all emails in an inbox Deletes all emails

Parameters:

inboxId - (required)

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	-

emptyInboxWithHttpInfo

public ApiResponse<Void> emptyInboxWithHttpInfo(UUID inboxId)
                                         throws ApiException

Delete all emails in an inbox Deletes all emails

Parameters:

inboxId - (required)

Returns:

ApiResponse<Void>

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	-

emptyInboxAsync

public okhttp3.Call emptyInboxAsync(UUID inboxId,
                                    ApiCallback<Void> _callback)
                             throws ApiException

Delete all emails in an inbox (asynchronously) Deletes all emails

Parameters:

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

sendEmailSimpleCall

public okhttp3.Call sendEmailSimpleCall(SimpleSendEmailOptions simpleSendEmailOptions,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for sendEmailSimple

Parameters:

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

sendEmailSimple

public void sendEmailSimple(SimpleSendEmailOptions simpleSendEmailOptions)
                     throws ApiException

Send an email If no senderId or inboxId provided a random email address will be used to send from.

Parameters:

simpleSendEmailOptions - (required)

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	-

sendEmailSimpleWithHttpInfo

public ApiResponse<Void> sendEmailSimpleWithHttpInfo(SimpleSendEmailOptions simpleSendEmailOptions)
                                              throws ApiException

Send an email If no senderId or inboxId provided a random email address will be used to send from.

Parameters:

simpleSendEmailOptions - (required)

Returns:

ApiResponse<Void>

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	-

sendEmailSimpleAsync

public okhttp3.Call sendEmailSimpleAsync(SimpleSendEmailOptions simpleSendEmailOptions,
                                         ApiCallback<Void> _callback)
                                  throws ApiException

Send an email (asynchronously) If no senderId or inboxId provided a random email address will be used to send from.

Parameters:

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