com.mailslurp.apis

Class AliasControllerApi

java.lang.Object

com.mailslurp.apis.AliasControllerApi

public class AliasControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AliasControllerApi()
AliasControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AliasDto	createAlias(CreateAliasOptions createAliasOptions) Create an email alias.
okhttp3.Call	createAliasAsync(CreateAliasOptions createAliasOptions, ApiCallback<AliasDto> _callback) Create an email alias.
okhttp3.Call	createAliasCall(CreateAliasOptions createAliasOptions, ApiCallback _callback) Build call for createAlias
ApiResponse<AliasDto>	createAliasWithHttpInfo(CreateAliasOptions createAliasOptions) Create an email alias.
void	deleteAlias(UUID aliasId) Delete an email alias
okhttp3.Call	deleteAliasAsync(UUID aliasId, ApiCallback<Void> _callback) Delete an email alias (asynchronously)
okhttp3.Call	deleteAliasCall(UUID aliasId, ApiCallback _callback) Build call for deleteAlias
ApiResponse<Void>	deleteAliasWithHttpInfo(UUID aliasId) Delete an email alias
AliasDto	getAlias(UUID aliasId) Get an email alias Get an email alias by ID
okhttp3.Call	getAliasAsync(UUID aliasId, ApiCallback<AliasDto> _callback) Get an email alias (asynchronously) Get an email alias by ID
okhttp3.Call	getAliasCall(UUID aliasId, ApiCallback _callback) Build call for getAlias
PageEmailProjection	getAliasEmails(UUID aliasId, Integer page, Integer size, String sort) Get emails for an alias Get paginated emails for an alias by ID
okhttp3.Call	getAliasEmailsAsync(UUID aliasId, Integer page, Integer size, String sort, ApiCallback<PageEmailProjection> _callback) Get emails for an alias (asynchronously) Get paginated emails for an alias by ID
okhttp3.Call	getAliasEmailsCall(UUID aliasId, Integer page, Integer size, String sort, ApiCallback _callback) Build call for getAliasEmails
ApiResponse<PageEmailProjection>	getAliasEmailsWithHttpInfo(UUID aliasId, Integer page, Integer size, String sort) Get emails for an alias Get paginated emails for an alias by ID
PageAlias	getAliases(Integer page, Integer size, String sort) Get all email aliases you have created Get all email aliases in paginated form
okhttp3.Call	getAliasesAsync(Integer page, Integer size, String sort, ApiCallback<PageAlias> _callback) Get all email aliases you have created (asynchronously) Get all email aliases in paginated form
okhttp3.Call	getAliasesCall(Integer page, Integer size, String sort, ApiCallback _callback) Build call for getAliases
ApiResponse<PageAlias>	getAliasesWithHttpInfo(Integer page, Integer size, String sort) Get all email aliases you have created Get all email aliases in paginated form
PageThreadProjection	getAliasThreads(UUID aliasId, Integer page, Integer size, String sort) Get threads created for an alias Returns threads created for an email alias in paginated form
okhttp3.Call	getAliasThreadsAsync(UUID aliasId, Integer page, Integer size, String sort, ApiCallback<PageThreadProjection> _callback) Get threads created for an alias (asynchronously) Returns threads created for an email alias in paginated form
okhttp3.Call	getAliasThreadsCall(UUID aliasId, Integer page, Integer size, String sort, ApiCallback _callback) Build call for getAliasThreads
ApiResponse<PageThreadProjection>	getAliasThreadsWithHttpInfo(UUID aliasId, Integer page, Integer size, String sort) Get threads created for an alias Returns threads created for an email alias in paginated form
ApiResponse<AliasDto>	getAliasWithHttpInfo(UUID aliasId) Get an email alias Get an email alias by ID
ApiClient	getApiClient()
SentEmailDto	replyToAliasEmail(UUID aliasId, UUID emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions) Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc.
okhttp3.Call	replyToAliasEmailAsync(UUID aliasId, UUID emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions, ApiCallback<SentEmailDto> _callback) Reply to an email (asynchronously) Send the reply to the email sender or reply-to and include same subject cc bcc etc.
okhttp3.Call	replyToAliasEmailCall(UUID aliasId, UUID emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions, ApiCallback _callback) Build call for replyToAliasEmail
ApiResponse<SentEmailDto>	replyToAliasEmailWithHttpInfo(UUID aliasId, UUID emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions) Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc.
SentEmailDto	sendAliasEmail(UUID aliasId, SendEmailOptions sendEmailOptions) Send an email from an alias inbox Send an email from an alias.
okhttp3.Call	sendAliasEmailAsync(UUID aliasId, SendEmailOptions sendEmailOptions, ApiCallback<SentEmailDto> _callback) Send an email from an alias inbox (asynchronously) Send an email from an alias.
okhttp3.Call	sendAliasEmailCall(UUID aliasId, SendEmailOptions sendEmailOptions, ApiCallback _callback) Build call for sendAliasEmail
ApiResponse<SentEmailDto>	sendAliasEmailWithHttpInfo(UUID aliasId, SendEmailOptions sendEmailOptions) Send an email from an alias inbox Send an email from an alias.
void	setApiClient(ApiClient apiClient)
void	updateAlias(UUID aliasId, UpdateAliasOptions updateAliasOptions) Update an email alias
okhttp3.Call	updateAliasAsync(UUID aliasId, UpdateAliasOptions updateAliasOptions, ApiCallback<Void> _callback) Update an email alias (asynchronously)
okhttp3.Call	updateAliasCall(UUID aliasId, UpdateAliasOptions updateAliasOptions, ApiCallback _callback) Build call for updateAlias
ApiResponse<Void>	updateAliasWithHttpInfo(UUID aliasId, UpdateAliasOptions updateAliasOptions) Update an email alias

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasControllerApi

public AliasControllerApi()

AliasControllerApi

public AliasControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAliasCall

public okhttp3.Call createAliasCall(CreateAliasOptions createAliasOptions,
                                    ApiCallback _callback)
                             throws ApiException

Build call for createAlias

Parameters:

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

createAlias

public AliasDto createAlias(CreateAliasOptions createAliasOptions)
                     throws ApiException

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Parameters:

createAliasOptions - createAliasOptions (required)

Returns:

AliasDto

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	-

createAliasWithHttpInfo

public ApiResponse<AliasDto> createAliasWithHttpInfo(CreateAliasOptions createAliasOptions)
                                              throws ApiException

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Parameters:

createAliasOptions - createAliasOptions (required)

Returns:

ApiResponse<AliasDto>

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	-

createAliasAsync

public okhttp3.Call createAliasAsync(CreateAliasOptions createAliasOptions,
                                     ApiCallback<AliasDto> _callback)
                              throws ApiException

Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. (asynchronously) Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached

Parameters:

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

deleteAliasCall

public okhttp3.Call deleteAliasCall(UUID aliasId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for deleteAlias

Parameters:

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

deleteAlias

public void deleteAlias(UUID aliasId)
                 throws ApiException

Delete an email alias

Parameters:

aliasId - aliasId (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	-
401	Unauthorized	-
403	Forbidden	-

deleteAliasWithHttpInfo

public ApiResponse<Void> deleteAliasWithHttpInfo(UUID aliasId)
                                          throws ApiException

Delete an email alias

Parameters:

aliasId - aliasId (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	-
401	Unauthorized	-
403	Forbidden	-

deleteAliasAsync

public okhttp3.Call deleteAliasAsync(UUID aliasId,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Delete an email alias (asynchronously)

Parameters:

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

getAliasCall

public okhttp3.Call getAliasCall(UUID aliasId,
                                 ApiCallback _callback)
                          throws ApiException

Build call for getAlias

Parameters:

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

getAlias

public AliasDto getAlias(UUID aliasId)
                  throws ApiException

Get an email alias Get an email alias by ID

Parameters:

aliasId - aliasId (required)

Returns:

AliasDto

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	-

getAliasWithHttpInfo

public ApiResponse<AliasDto> getAliasWithHttpInfo(UUID aliasId)
                                           throws ApiException

Get an email alias Get an email alias by ID

Parameters:

aliasId - aliasId (required)

Returns:

ApiResponse<AliasDto>

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	-

getAliasAsync

public okhttp3.Call getAliasAsync(UUID aliasId,
                                  ApiCallback<AliasDto> _callback)
                           throws ApiException

Get an email alias (asynchronously) Get an email alias by ID

Parameters:

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

getAliasEmailsCall

public okhttp3.Call getAliasEmailsCall(UUID aliasId,
                                       Integer page,
                                       Integer size,
                                       String sort,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAliasEmails

Parameters:

aliasId - aliasId (required)

page - Optional page index alias email list pagination (optional, default to 0)

size - Optional page size alias email list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

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

getAliasEmails

public PageEmailProjection getAliasEmails(UUID aliasId,
                                          Integer page,
                                          Integer size,
                                          String sort)
                                   throws ApiException

Get emails for an alias Get paginated emails for an alias by ID

Parameters:

aliasId - aliasId (required)

page - Optional page index alias email list pagination (optional, default to 0)

size - Optional page size alias email list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

PageEmailProjection

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	-

getAliasEmailsWithHttpInfo

public ApiResponse<PageEmailProjection> getAliasEmailsWithHttpInfo(UUID aliasId,
                                                                   Integer page,
                                                                   Integer size,
                                                                   String sort)
                                                            throws ApiException

Get emails for an alias Get paginated emails for an alias by ID

Parameters:

aliasId - aliasId (required)

page - Optional page index alias email list pagination (optional, default to 0)

size - Optional page size alias email list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

ApiResponse<PageEmailProjection>

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	-

getAliasEmailsAsync

public okhttp3.Call getAliasEmailsAsync(UUID aliasId,
                                        Integer page,
                                        Integer size,
                                        String sort,
                                        ApiCallback<PageEmailProjection> _callback)
                                 throws ApiException

Get emails for an alias (asynchronously) Get paginated emails for an alias by ID

Parameters:

aliasId - aliasId (required)

page - Optional page index alias email list pagination (optional, default to 0)

size - Optional page size alias email list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

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

getAliasThreadsCall

public okhttp3.Call getAliasThreadsCall(UUID aliasId,
                                        Integer page,
                                        Integer size,
                                        String sort,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getAliasThreads

Parameters:

aliasId - aliasId (required)

page - Optional page index in thread list pagination (optional, default to 0)

size - Optional page size in thread list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

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

getAliasThreads

public PageThreadProjection getAliasThreads(UUID aliasId,
                                            Integer page,
                                            Integer size,
                                            String sort)
                                     throws ApiException

Get threads created for an alias Returns threads created for an email alias in paginated form

Parameters:

aliasId - aliasId (required)

page - Optional page index in thread list pagination (optional, default to 0)

size - Optional page size in thread list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

PageThreadProjection

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	-

getAliasThreadsWithHttpInfo

public ApiResponse<PageThreadProjection> getAliasThreadsWithHttpInfo(UUID aliasId,
                                                                     Integer page,
                                                                     Integer size,
                                                                     String sort)
                                                              throws ApiException

Get threads created for an alias Returns threads created for an email alias in paginated form

Parameters:

aliasId - aliasId (required)

page - Optional page index in thread list pagination (optional, default to 0)

size - Optional page size in thread list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

ApiResponse<PageThreadProjection>

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	-

getAliasThreadsAsync

public okhttp3.Call getAliasThreadsAsync(UUID aliasId,
                                         Integer page,
                                         Integer size,
                                         String sort,
                                         ApiCallback<PageThreadProjection> _callback)
                                  throws ApiException

Get threads created for an alias (asynchronously) Returns threads created for an email alias in paginated form

Parameters:

aliasId - aliasId (required)

page - Optional page index in thread list pagination (optional, default to 0)

size - Optional page size in thread list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

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

getAliasesCall

public okhttp3.Call getAliasesCall(Integer page,
                                   Integer size,
                                   String sort,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getAliases

Parameters:

page - Optional page index in alias list pagination (optional, default to 0)

size - Optional page size in alias list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

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

getAliases

public PageAlias getAliases(Integer page,
                            Integer size,
                            String sort)
                     throws ApiException

Get all email aliases you have created Get all email aliases in paginated form

Parameters:

page - Optional page index in alias list pagination (optional, default to 0)

size - Optional page size in alias list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

PageAlias

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	-

getAliasesWithHttpInfo

public ApiResponse<PageAlias> getAliasesWithHttpInfo(Integer page,
                                                     Integer size,
                                                     String sort)
                                              throws ApiException

Get all email aliases you have created Get all email aliases in paginated form

Parameters:

page - Optional page index in alias list pagination (optional, default to 0)

size - Optional page size in alias list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

Returns:

ApiResponse<PageAlias>

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	-

getAliasesAsync

public okhttp3.Call getAliasesAsync(Integer page,
                                    Integer size,
                                    String sort,
                                    ApiCallback<PageAlias> _callback)
                             throws ApiException

Get all email aliases you have created (asynchronously) Get all email aliases in paginated form

Parameters:

page - Optional page index in alias list pagination (optional, default to 0)

size - Optional page size in alias list pagination (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

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

replyToAliasEmailCall

public okhttp3.Call replyToAliasEmailCall(UUID aliasId,
                                          UUID emailId,
                                          ReplyToAliasEmailOptions replyToAliasEmailOptions,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for replyToAliasEmail

Parameters:

aliasId - ID of the alias that email belongs to (required)

emailId - ID of the email that should be replied to (required)

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

replyToAliasEmail

public SentEmailDto replyToAliasEmail(UUID aliasId,
                                      UUID emailId,
                                      ReplyToAliasEmailOptions replyToAliasEmailOptions)
                               throws ApiException

Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.

Parameters:

aliasId - ID of the alias that email belongs to (required)

emailId - ID of the email that should be replied to (required)

replyToAliasEmailOptions - replyToAliasEmailOptions (required)

Returns:

SentEmailDto

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	-

replyToAliasEmailWithHttpInfo

public ApiResponse<SentEmailDto> replyToAliasEmailWithHttpInfo(UUID aliasId,
                                                               UUID emailId,
                                                               ReplyToAliasEmailOptions replyToAliasEmailOptions)
                                                        throws ApiException

Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.

Parameters:

aliasId - ID of the alias that email belongs to (required)

emailId - ID of the email that should be replied to (required)

replyToAliasEmailOptions - replyToAliasEmailOptions (required)

Returns:

ApiResponse<SentEmailDto>

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	-

replyToAliasEmailAsync

public okhttp3.Call replyToAliasEmailAsync(UUID aliasId,
                                           UUID emailId,
                                           ReplyToAliasEmailOptions replyToAliasEmailOptions,
                                           ApiCallback<SentEmailDto> _callback)
                                    throws ApiException

Reply to an email (asynchronously) Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails `to`, `cc`, and `bcc`.

Parameters:

aliasId - ID of the alias that email belongs to (required)

emailId - ID of the email that should be replied to (required)

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

sendAliasEmailCall

public okhttp3.Call sendAliasEmailCall(UUID aliasId,
                                       SendEmailOptions sendEmailOptions,
                                       ApiCallback _callback)
                                throws ApiException

Build call for sendAliasEmail

Parameters:

aliasId - aliasId (required)

sendEmailOptions - Options for the email to be sent (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
200	OK	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

sendAliasEmail

public SentEmailDto sendAliasEmail(UUID aliasId,
                                   SendEmailOptions sendEmailOptions)
                            throws ApiException

Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Parameters:

aliasId - aliasId (required)

sendEmailOptions - Options for the email to be sent (optional)

Returns:

SentEmailDto

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	-

sendAliasEmailWithHttpInfo

public ApiResponse<SentEmailDto> sendAliasEmailWithHttpInfo(UUID aliasId,
                                                            SendEmailOptions sendEmailOptions)
                                                     throws ApiException

Send an email from an alias inbox Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Parameters:

aliasId - aliasId (required)

sendEmailOptions - Options for the email to be sent (optional)

Returns:

ApiResponse<SentEmailDto>

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	-

sendAliasEmailAsync

public okhttp3.Call sendAliasEmailAsync(UUID aliasId,
                                        SendEmailOptions sendEmailOptions,
                                        ApiCallback<SentEmailDto> _callback)
                                 throws ApiException

Send an email from an alias inbox (asynchronously) Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

Parameters:

aliasId - aliasId (required)

sendEmailOptions - Options for the email to be sent (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
200	OK	-
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

updateAliasCall

public okhttp3.Call updateAliasCall(UUID aliasId,
                                    UpdateAliasOptions updateAliasOptions,
                                    ApiCallback _callback)
                             throws ApiException

Build call for updateAlias

Parameters:

aliasId - aliasId (required)

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

updateAlias

public void updateAlias(UUID aliasId,
                        UpdateAliasOptions updateAliasOptions)
                 throws ApiException

Update an email alias

Parameters:

aliasId - aliasId (required)

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

updateAliasWithHttpInfo

public ApiResponse<Void> updateAliasWithHttpInfo(UUID aliasId,
                                                 UpdateAliasOptions updateAliasOptions)
                                          throws ApiException

Update an email alias

Parameters:

aliasId - aliasId (required)

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

updateAliasAsync

public okhttp3.Call updateAliasAsync(UUID aliasId,
                                     UpdateAliasOptions updateAliasOptions,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Update an email alias (asynchronously)

Parameters:

aliasId - aliasId (required)

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