com.mailslurp.apis

Class EmailControllerApi

java.lang.Object

com.mailslurp.apis.EmailControllerApi

public class EmailControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailControllerApi()
EmailControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteAllEmails() Delete all emails Deletes all emails in your account.
okhttp3.Call	deleteAllEmailsAsync(ApiCallback<Void> _callback) Delete all emails (asynchronously) Deletes all emails in your account.
okhttp3.Call	deleteAllEmailsCall(ApiCallback _callback) Build call for deleteAllEmails
ApiResponse<Void>	deleteAllEmailsWithHttpInfo() Delete all emails Deletes all emails in your account.
void	deleteEmail(UUID emailId) Delete an email Deletes an email and removes it from the inbox.
okhttp3.Call	deleteEmailAsync(UUID emailId, ApiCallback<Void> _callback) Delete an email (asynchronously) Deletes an email and removes it from the inbox.
okhttp3.Call	deleteEmailCall(UUID emailId, ApiCallback _callback) Build call for deleteEmail
ApiResponse<Void>	deleteEmailWithHttpInfo(UUID emailId) Delete an email Deletes an email and removes it from the inbox.
byte[]	downloadAttachment(String attachmentId, UUID emailId, String apiKey) Get email attachment bytes.
okhttp3.Call	downloadAttachmentAsync(String attachmentId, UUID emailId, String apiKey, ApiCallback<byte[]> _callback) Get email attachment bytes.
DownloadAttachmentDto	downloadAttachmentBase64(String attachmentId, UUID emailId) Get email attachment as base64 encoded string (alternative to binary responses) Returns the specified attachment for a given email as a base 64 encoded string.
okhttp3.Call	downloadAttachmentBase64Async(String attachmentId, UUID emailId, ApiCallback<DownloadAttachmentDto> _callback) Get email attachment as base64 encoded string (alternative to binary responses) (asynchronously) Returns the specified attachment for a given email as a base 64 encoded string.
okhttp3.Call	downloadAttachmentBase64Call(String attachmentId, UUID emailId, ApiCallback _callback) Build call for downloadAttachmentBase64
ApiResponse<DownloadAttachmentDto>	downloadAttachmentBase64WithHttpInfo(String attachmentId, UUID emailId) Get email attachment as base64 encoded string (alternative to binary responses) Returns the specified attachment for a given email as a base 64 encoded string.
okhttp3.Call	downloadAttachmentCall(String attachmentId, UUID emailId, String apiKey, ApiCallback _callback) Build call for downloadAttachment
ApiResponse<byte[]>	downloadAttachmentWithHttpInfo(String attachmentId, UUID emailId, String apiKey) Get email attachment bytes.
void	forwardEmail(UUID emailId, ForwardEmailOptions forwardEmailOptions) Forward email Forward an existing email to new recipients.
okhttp3.Call	forwardEmailAsync(UUID emailId, ForwardEmailOptions forwardEmailOptions, ApiCallback<Void> _callback) Forward email (asynchronously) Forward an existing email to new recipients.
okhttp3.Call	forwardEmailCall(UUID emailId, ForwardEmailOptions forwardEmailOptions, ApiCallback _callback) Build call for forwardEmail
ApiResponse<Void>	forwardEmailWithHttpInfo(UUID emailId, ForwardEmailOptions forwardEmailOptions) Forward email Forward an existing email to new recipients.
ApiClient	getApiClient()
AttachmentMetaData	getAttachmentMetaData(String attachmentId, UUID emailId) Get email attachment metadata Returns the metadata such as name and content-type for a given attachment and email.
okhttp3.Call	getAttachmentMetaDataAsync(String attachmentId, UUID emailId, ApiCallback<AttachmentMetaData> _callback) Get email attachment metadata (asynchronously) Returns the metadata such as name and content-type for a given attachment and email.
okhttp3.Call	getAttachmentMetaDataCall(String attachmentId, UUID emailId, ApiCallback _callback) Build call for getAttachmentMetaData
ApiResponse<AttachmentMetaData>	getAttachmentMetaDataWithHttpInfo(String attachmentId, UUID emailId) Get email attachment metadata Returns the metadata such as name and content-type for a given attachment and email.
List<AttachmentMetaData>	getAttachments(UUID emailId) Get all email attachment metadata Returns an array of attachment metadata such as name and content-type for a given email if present.
okhttp3.Call	getAttachmentsAsync(UUID emailId, ApiCallback<List<AttachmentMetaData>> _callback) Get all email attachment metadata (asynchronously) Returns an array of attachment metadata such as name and content-type for a given email if present.
okhttp3.Call	getAttachmentsCall(UUID emailId, ApiCallback _callback) Build call for getAttachments
ApiResponse<List<AttachmentMetaData>>	getAttachmentsWithHttpInfo(UUID emailId) Get all email attachment metadata Returns an array of attachment metadata such as name and content-type for a given email if present.
Email	getEmail(UUID emailId, Boolean decode) Get email content Returns a email summary object with headers and content.
okhttp3.Call	getEmailAsync(UUID emailId, Boolean decode, ApiCallback<Email> _callback) Get email content (asynchronously) Returns a email summary object with headers and content.
okhttp3.Call	getEmailCall(UUID emailId, Boolean decode, ApiCallback _callback) Build call for getEmail
EmailContentMatchResult	getEmailContentMatch(UUID emailId, ContentMatchOptions contentMatchOptions) Get email content regex pattern match results.
okhttp3.Call	getEmailContentMatchAsync(UUID emailId, ContentMatchOptions contentMatchOptions, ApiCallback<EmailContentMatchResult> _callback) Get email content regex pattern match results.
okhttp3.Call	getEmailContentMatchCall(UUID emailId, ContentMatchOptions contentMatchOptions, ApiCallback _callback) Build call for getEmailContentMatch
ApiResponse<EmailContentMatchResult>	getEmailContentMatchWithHttpInfo(UUID emailId, ContentMatchOptions contentMatchOptions) Get email content regex pattern match results.
String	getEmailHTML(UUID emailId, Boolean decode) Get email content as HTML Retrieve email content as HTML response for viewing in browsers.
okhttp3.Call	getEmailHTMLAsync(UUID emailId, Boolean decode, ApiCallback<String> _callback) Get email content as HTML (asynchronously) Retrieve email content as HTML response for viewing in browsers.
okhttp3.Call	getEmailHTMLCall(UUID emailId, Boolean decode, ApiCallback _callback) Build call for getEmailHTML
EmailTextLinesResult	getEmailHTMLQuery(UUID emailId, String htmlSelector) Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text.
okhttp3.Call	getEmailHTMLQueryAsync(UUID emailId, String htmlSelector, ApiCallback<EmailTextLinesResult> _callback) Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously) Parse an email body and return the content as an array of text.
okhttp3.Call	getEmailHTMLQueryCall(UUID emailId, String htmlSelector, ApiCallback _callback) Build call for getEmailHTMLQuery
ApiResponse<EmailTextLinesResult>	getEmailHTMLQueryWithHttpInfo(UUID emailId, String htmlSelector) Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text.
ApiResponse<String>	getEmailHTMLWithHttpInfo(UUID emailId, Boolean decode) Get email content as HTML Retrieve email content as HTML response for viewing in browsers.
PageEmailProjection	getEmailsPaginated(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly) Get all emails By default returns all emails across all inboxes sorted by ascending created at date.
okhttp3.Call	getEmailsPaginatedAsync(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, ApiCallback<PageEmailProjection> _callback) Get all emails (asynchronously) By default returns all emails across all inboxes sorted by ascending created at date.
okhttp3.Call	getEmailsPaginatedCall(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, ApiCallback _callback) Build call for getEmailsPaginated
ApiResponse<PageEmailProjection>	getEmailsPaginatedWithHttpInfo(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly) Get all emails By default returns all emails across all inboxes sorted by ascending created at date.
EmailTextLinesResult	getEmailTextLines(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator) Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings.
okhttp3.Call	getEmailTextLinesAsync(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, ApiCallback<EmailTextLinesResult> _callback) Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously) Parse an email body and return the content as an array of strings.
okhttp3.Call	getEmailTextLinesCall(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, ApiCallback _callback) Build call for getEmailTextLines
ApiResponse<EmailTextLinesResult>	getEmailTextLinesWithHttpInfo(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator) Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings.
ApiResponse<Email>	getEmailWithHttpInfo(UUID emailId, Boolean decode) Get email content Returns a email summary object with headers and content.
Email	getLatestEmail(List<UUID> inboxIds) Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs
okhttp3.Call	getLatestEmailAsync(List<UUID> inboxIds, ApiCallback<Email> _callback) Get latest email (asynchronously) Get the newest email in all inboxes or in a passed set of inbox IDs
okhttp3.Call	getLatestEmailCall(List<UUID> inboxIds, ApiCallback _callback) Build call for getLatestEmail
Email	getLatestEmailInInbox(UUID inboxId) Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs
okhttp3.Call	getLatestEmailInInboxAsync(UUID inboxId, ApiCallback<Email> _callback) Get latest email (asynchronously) Get the newest email in all inboxes or in a passed set of inbox IDs
okhttp3.Call	getLatestEmailInInboxCall(UUID inboxId, ApiCallback _callback) Build call for getLatestEmailInInbox
ApiResponse<Email>	getLatestEmailInInboxWithHttpInfo(UUID inboxId) Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs
ApiResponse<Email>	getLatestEmailWithHttpInfo(List<UUID> inboxIds) Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs
PageEmailProjection	getOrganizationEmailsPaginated(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly) Get all organization emails By default returns all emails across all team inboxes sorted by ascending created at date.
okhttp3.Call	getOrganizationEmailsPaginatedAsync(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, ApiCallback<PageEmailProjection> _callback) Get all organization emails (asynchronously) By default returns all emails across all team inboxes sorted by ascending created at date.
okhttp3.Call	getOrganizationEmailsPaginatedCall(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, ApiCallback _callback) Build call for getOrganizationEmailsPaginated
ApiResponse<PageEmailProjection>	getOrganizationEmailsPaginatedWithHttpInfo(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly) Get all organization emails By default returns all emails across all team inboxes sorted by ascending created at date.
String	getRawEmailContents(UUID emailId) Get raw email string Returns a raw, unparsed, and unprocessed email.
okhttp3.Call	getRawEmailContentsAsync(UUID emailId, ApiCallback<String> _callback) Get raw email string (asynchronously) Returns a raw, unparsed, and unprocessed email.
okhttp3.Call	getRawEmailContentsCall(UUID emailId, ApiCallback _callback) Build call for getRawEmailContents
ApiResponse<String>	getRawEmailContentsWithHttpInfo(UUID emailId) Get raw email string Returns a raw, unparsed, and unprocessed email.
RawEmailJson	getRawEmailJson(UUID emailId) Get raw email in JSON Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
okhttp3.Call	getRawEmailJsonAsync(UUID emailId, ApiCallback<RawEmailJson> _callback) Get raw email in JSON (asynchronously) Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
okhttp3.Call	getRawEmailJsonCall(UUID emailId, ApiCallback _callback) Build call for getRawEmailJson
ApiResponse<RawEmailJson>	getRawEmailJsonWithHttpInfo(UUID emailId) Get raw email in JSON Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response
UnreadCount	getUnreadEmailCount() Get unread email count Get number of emails unread
okhttp3.Call	getUnreadEmailCountAsync(ApiCallback<UnreadCount> _callback) Get unread email count (asynchronously) Get number of emails unread
okhttp3.Call	getUnreadEmailCountCall(ApiCallback _callback) Build call for getUnreadEmailCount
ApiResponse<UnreadCount>	getUnreadEmailCountWithHttpInfo() Get unread email count Get number of emails unread
SentEmailDto	replyToEmail(UUID emailId, ReplyToEmailOptions replyToEmailOptions) Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc.
okhttp3.Call	replyToEmailAsync(UUID emailId, ReplyToEmailOptions replyToEmailOptions, 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	replyToEmailCall(UUID emailId, ReplyToEmailOptions replyToEmailOptions, ApiCallback _callback) Build call for replyToEmail
ApiResponse<SentEmailDto>	replyToEmailWithHttpInfo(UUID emailId, ReplyToEmailOptions replyToEmailOptions) Reply to an email Send the reply to the email sender or reply-to and include same subject cc bcc etc.
void	setApiClient(ApiClient apiClient)
ValidationDto	validateEmail(UUID emailId) Validate email Validate the HTML content of email if HTML is found.
okhttp3.Call	validateEmailAsync(UUID emailId, ApiCallback<ValidationDto> _callback) Validate email (asynchronously) Validate the HTML content of email if HTML is found.
okhttp3.Call	validateEmailCall(UUID emailId, ApiCallback _callback) Build call for validateEmail
ApiResponse<ValidationDto>	validateEmailWithHttpInfo(UUID emailId) Validate email Validate the HTML content of email if HTML is found.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailControllerApi

public EmailControllerApi()

EmailControllerApi

public EmailControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteAllEmailsCall

public okhttp3.Call deleteAllEmailsCall(ApiCallback _callback)
                                 throws ApiException

Build call for deleteAllEmails

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

deleteAllEmails

public void deleteAllEmails()
                     throws ApiException

Delete all emails Deletes all emails in your account. Be careful as emails cannot be recovered

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	-

deleteAllEmailsWithHttpInfo

public ApiResponse<Void> deleteAllEmailsWithHttpInfo()
                                              throws ApiException

Delete all emails Deletes all emails in your account. Be careful as emails cannot be recovered

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	-

deleteAllEmailsAsync

public okhttp3.Call deleteAllEmailsAsync(ApiCallback<Void> _callback)
                                  throws ApiException

Delete all emails (asynchronously) Deletes all emails in your account. Be careful as emails cannot be recovered

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

deleteEmailCall

public okhttp3.Call deleteEmailCall(UUID emailId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for deleteEmail

Parameters:

emailId - ID of email to delete (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	-

deleteEmail

public void deleteEmail(UUID emailId)
                 throws ApiException

Delete an email Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

Parameters:

emailId - ID of email to delete (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	-

deleteEmailWithHttpInfo

public ApiResponse<Void> deleteEmailWithHttpInfo(UUID emailId)
                                          throws ApiException

Delete an email Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

Parameters:

emailId - ID of email to delete (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	-

deleteEmailAsync

public okhttp3.Call deleteEmailAsync(UUID emailId,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Delete an email (asynchronously) Deletes an email and removes it from the inbox. Deleted emails cannot be recovered.

Parameters:

emailId - ID of email to delete (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	-

downloadAttachmentCall

public okhttp3.Call downloadAttachmentCall(String attachmentId,
                                           UUID emailId,
                                           String apiKey,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for downloadAttachment

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

apiKey - Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

downloadAttachment

public byte[] downloadAttachment(String attachmentId,
                                 UUID emailId,
                                 String apiKey)
                          throws ApiException

Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

apiKey - Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)

Returns:

byte[]

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	-

downloadAttachmentWithHttpInfo

public ApiResponse<byte[]> downloadAttachmentWithHttpInfo(String attachmentId,
                                                          UUID emailId,
                                                          String apiKey)
                                                   throws ApiException

Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

apiKey - Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (optional)

Returns:

ApiResponse<byte[]>

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	-

downloadAttachmentAsync

public okhttp3.Call downloadAttachmentAsync(String attachmentId,
                                            UUID emailId,
                                            String apiKey,
                                            ApiCallback<byte[]> _callback)
                                     throws ApiException

Get email attachment bytes. If you have trouble with byte responses try the `downloadAttachmentBase64` response endpoints. (asynchronously) Returns the specified attachment for a given email as a stream / array of bytes. You can find attachment ids in email responses endpoint responses. The response type is application/octet-stream.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

apiKey - Can pass apiKey in url for this request if you wish to download the file in a browser. Content type will be set to original content type of the attachment file. This is so that browsers can download the file correctly. (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

downloadAttachmentBase64Call

public okhttp3.Call downloadAttachmentBase64Call(String attachmentId,
                                                 UUID emailId,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for downloadAttachmentBase64

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (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	-

downloadAttachmentBase64

public DownloadAttachmentDto downloadAttachmentBase64(String attachmentId,
                                                      UUID emailId)
                                               throws ApiException

Get email attachment as base64 encoded string (alternative to binary responses) Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

Returns:

DownloadAttachmentDto

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	-

downloadAttachmentBase64WithHttpInfo

public ApiResponse<DownloadAttachmentDto> downloadAttachmentBase64WithHttpInfo(String attachmentId,
                                                                               UUID emailId)
                                                                        throws ApiException

Get email attachment as base64 encoded string (alternative to binary responses) Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

Returns:

ApiResponse<DownloadAttachmentDto>

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	-

downloadAttachmentBase64Async

public okhttp3.Call downloadAttachmentBase64Async(String attachmentId,
                                                  UUID emailId,
                                                  ApiCallback<DownloadAttachmentDto> _callback)
                                           throws ApiException

Get email attachment as base64 encoded string (alternative to binary responses) (asynchronously) Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (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	-

forwardEmailCall

public okhttp3.Call forwardEmailCall(UUID emailId,
                                     ForwardEmailOptions forwardEmailOptions,
                                     ApiCallback _callback)
                              throws ApiException

Build call for forwardEmail

Parameters:

emailId - ID of email (required)

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

forwardEmail

public void forwardEmail(UUID emailId,
                         ForwardEmailOptions forwardEmailOptions)
                  throws ApiException

Forward email Forward an existing email to new recipients.

Parameters:

emailId - ID of email (required)

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

forwardEmailWithHttpInfo

public ApiResponse<Void> forwardEmailWithHttpInfo(UUID emailId,
                                                  ForwardEmailOptions forwardEmailOptions)
                                           throws ApiException

Forward email Forward an existing email to new recipients.

Parameters:

emailId - ID of email (required)

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

forwardEmailAsync

public okhttp3.Call forwardEmailAsync(UUID emailId,
                                      ForwardEmailOptions forwardEmailOptions,
                                      ApiCallback<Void> _callback)
                               throws ApiException

Forward email (asynchronously) Forward an existing email to new recipients.

Parameters:

emailId - ID of email (required)

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

getAttachmentMetaDataCall

public okhttp3.Call getAttachmentMetaDataCall(String attachmentId,
                                              UUID emailId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getAttachmentMetaData

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (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	-

getAttachmentMetaData

public AttachmentMetaData getAttachmentMetaData(String attachmentId,
                                                UUID emailId)
                                         throws ApiException

Get email attachment metadata Returns the metadata such as name and content-type for a given attachment and email.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

Returns:

AttachmentMetaData

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	-

getAttachmentMetaDataWithHttpInfo

public ApiResponse<AttachmentMetaData> getAttachmentMetaDataWithHttpInfo(String attachmentId,
                                                                         UUID emailId)
                                                                  throws ApiException

Get email attachment metadata Returns the metadata such as name and content-type for a given attachment and email.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (required)

Returns:

ApiResponse<AttachmentMetaData>

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	-

getAttachmentMetaDataAsync

public okhttp3.Call getAttachmentMetaDataAsync(String attachmentId,
                                               UUID emailId,
                                               ApiCallback<AttachmentMetaData> _callback)
                                        throws ApiException

Get email attachment metadata (asynchronously) Returns the metadata such as name and content-type for a given attachment and email.

Parameters:

attachmentId - ID of attachment (required)

emailId - ID of email (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	-

getAttachmentsCall

public okhttp3.Call getAttachmentsCall(UUID emailId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAttachments

Parameters:

emailId - ID of email (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	-

getAttachments

public List<AttachmentMetaData> getAttachments(UUID emailId)
                                        throws ApiException

Get all email attachment metadata Returns an array of attachment metadata such as name and content-type for a given email if present.

Parameters:

emailId - ID of email (required)

Returns:

List<AttachmentMetaData>

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	-

getAttachmentsWithHttpInfo

public ApiResponse<List<AttachmentMetaData>> getAttachmentsWithHttpInfo(UUID emailId)
                                                                 throws ApiException

Get all email attachment metadata Returns an array of attachment metadata such as name and content-type for a given email if present.

Parameters:

emailId - ID of email (required)

Returns:

ApiResponse<List<AttachmentMetaData>>

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	-

getAttachmentsAsync

public okhttp3.Call getAttachmentsAsync(UUID emailId,
                                        ApiCallback<List<AttachmentMetaData>> _callback)
                                 throws ApiException

Get all email attachment metadata (asynchronously) Returns an array of attachment metadata such as name and content-type for a given email if present.

Parameters:

emailId - ID of email (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	-

getEmailCall

public okhttp3.Call getEmailCall(UUID emailId,
                                 Boolean decode,
                                 ApiCallback _callback)
                          throws ApiException

Build call for getEmail

Parameters:

emailId - emailId (required)

decode - Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false)

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

getEmail

public Email getEmail(UUID emailId,
                      Boolean decode)
               throws ApiException

Get email content Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Parameters:

emailId - emailId (required)

decode - Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false)

Returns:

Email

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	-

getEmailWithHttpInfo

public ApiResponse<Email> getEmailWithHttpInfo(UUID emailId,
                                               Boolean decode)
                                        throws ApiException

Get email content Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Parameters:

emailId - emailId (required)

decode - Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false)

Returns:

ApiResponse<Email>

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	-

getEmailAsync

public okhttp3.Call getEmailAsync(UUID emailId,
                                  Boolean decode,
                                  ApiCallback<Email> _callback)
                           throws ApiException

Get email content (asynchronously) Returns a email summary object with headers and content. To retrieve the raw unparsed email use the getRawEmail endpoints

Parameters:

emailId - emailId (required)

decode - Decode email body quoted-printable encoding to plain text. SMTP servers often encode text using quoted-printable format (for instance `=D7`). This can be a pain for testing (optional, default to false)

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

getEmailContentMatchCall

public okhttp3.Call getEmailContentMatchCall(UUID emailId,
                                             ContentMatchOptions contentMatchOptions,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getEmailContentMatch

Parameters:

emailId - ID of email to match against (required)

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

getEmailContentMatch

public EmailContentMatchResult getEmailContentMatch(UUID emailId,
                                                    ContentMatchOptions contentMatchOptions)
                                             throws ApiException

Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

Parameters:

emailId - ID of email to match against (required)

contentMatchOptions - contentMatchOptions (required)

Returns:

EmailContentMatchResult

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	-

getEmailContentMatchWithHttpInfo

public ApiResponse<EmailContentMatchResult> getEmailContentMatchWithHttpInfo(UUID emailId,
                                                                             ContentMatchOptions contentMatchOptions)
                                                                      throws ApiException

Get email content regex pattern match results. Runs regex against email body and returns match groups. Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

Parameters:

emailId - ID of email to match against (required)

contentMatchOptions - contentMatchOptions (required)

Returns:

ApiResponse<EmailContentMatchResult>

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	-

getEmailContentMatchAsync

public okhttp3.Call getEmailContentMatchAsync(UUID emailId,
                                              ContentMatchOptions contentMatchOptions,
                                              ApiCallback<EmailContentMatchResult> _callback)
                                       throws ApiException

Get email content regex pattern match results. Runs regex against email body and returns match groups. (asynchronously) Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.

Parameters:

emailId - ID of email to match against (required)

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

getEmailHTMLCall

public okhttp3.Call getEmailHTMLCall(UUID emailId,
                                     Boolean decode,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getEmailHTML

Parameters:

emailId - emailId (required)

decode - decode (optional, default to false)

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

getEmailHTML

public String getEmailHTML(UUID emailId,
                           Boolean decode)
                    throws ApiException

Get email content as HTML Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`

Parameters:

emailId - emailId (required)

decode - decode (optional, default to false)

Returns:

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

getEmailHTMLWithHttpInfo

public ApiResponse<String> getEmailHTMLWithHttpInfo(UUID emailId,
                                                    Boolean decode)
                                             throws ApiException

Get email content as HTML Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`

Parameters:

emailId - emailId (required)

decode - decode (optional, default to false)

Returns:

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

getEmailHTMLAsync

public okhttp3.Call getEmailHTMLAsync(UUID emailId,
                                      Boolean decode,
                                      ApiCallback<String> _callback)
                               throws ApiException

Get email content as HTML (asynchronously) Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`

Parameters:

emailId - emailId (required)

decode - decode (optional, default to false)

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

getEmailHTMLQueryCall

public okhttp3.Call getEmailHTMLQueryCall(UUID emailId,
                                          String htmlSelector,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getEmailHTMLQuery

Parameters:

emailId - ID of email to perform HTML query on (required)

htmlSelector - HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getEmailHTMLQuery

public EmailTextLinesResult getEmailHTMLQuery(UUID emailId,
                                              String htmlSelector)
                                       throws ApiException

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

Parameters:

emailId - ID of email to perform HTML query on (required)

htmlSelector - HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (optional)

Returns:

EmailTextLinesResult

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	-

getEmailHTMLQueryWithHttpInfo

public ApiResponse<EmailTextLinesResult> getEmailHTMLQueryWithHttpInfo(UUID emailId,
                                                                       String htmlSelector)
                                                                throws ApiException

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

Parameters:

emailId - ID of email to perform HTML query on (required)

htmlSelector - HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (optional)

Returns:

ApiResponse<EmailTextLinesResult>

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	-

getEmailHTMLQueryAsync

public okhttp3.Call getEmailHTMLQueryAsync(UUID emailId,
                                           String htmlSelector,
                                           ApiCallback<EmailTextLinesResult> _callback)
                                    throws ApiException

Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously) Parse an email body and return the content as an array of text. HTML parsing uses JSoup which supports JQuery/CSS style selectors

Parameters:

emailId - ID of email to perform HTML query on (required)

htmlSelector - HTML selector to search for. Uses JQuery/JSoup/CSS style selector like '.my-div' to match content. See https://jsoup.org/apidocs/org/jsoup/select/Selector.html for more information. (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getEmailTextLinesCall

public okhttp3.Call getEmailTextLinesCall(UUID emailId,
                                          Boolean decodeHtmlEntities,
                                          String lineSeparator,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getEmailTextLines

Parameters:

emailId - ID of email to fetch text for (required)

decodeHtmlEntities - Decode HTML entities (optional)

lineSeparator - Line separator character (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getEmailTextLines

public EmailTextLinesResult getEmailTextLines(UUID emailId,
                                              Boolean decodeHtmlEntities,
                                              String lineSeparator)
                                       throws ApiException

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

Parameters:

emailId - ID of email to fetch text for (required)

decodeHtmlEntities - Decode HTML entities (optional)

lineSeparator - Line separator character (optional)

Returns:

EmailTextLinesResult

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	-

getEmailTextLinesWithHttpInfo

public ApiResponse<EmailTextLinesResult> getEmailTextLinesWithHttpInfo(UUID emailId,
                                                                       Boolean decodeHtmlEntities,
                                                                       String lineSeparator)
                                                                throws ApiException

Parse and return text from an email, stripping HTML and decoding encoded characters Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

Parameters:

emailId - ID of email to fetch text for (required)

decodeHtmlEntities - Decode HTML entities (optional)

lineSeparator - Line separator character (optional)

Returns:

ApiResponse<EmailTextLinesResult>

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	-

getEmailTextLinesAsync

public okhttp3.Call getEmailTextLinesAsync(UUID emailId,
                                           Boolean decodeHtmlEntities,
                                           String lineSeparator,
                                           ApiCallback<EmailTextLinesResult> _callback)
                                    throws ApiException

Parse and return text from an email, stripping HTML and decoding encoded characters (asynchronously) Parse an email body and return the content as an array of strings. HTML parsing uses JSoup and UNIX line separators.

Parameters:

emailId - ID of email to fetch text for (required)

decodeHtmlEntities - Decode HTML entities (optional)

lineSeparator - Line separator character (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getEmailsPaginatedCall

public okhttp3.Call getEmailsPaginatedCall(List<UUID> inboxId,
                                           Integer page,
                                           Integer size,
                                           String sort,
                                           Boolean unreadOnly,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getEmailsPaginated

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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

getEmailsPaginated

public PageEmailProjection getEmailsPaginated(List<UUID> inboxId,
                                              Integer page,
                                              Integer size,
                                              String sort,
                                              Boolean unreadOnly)
                                       throws ApiException

Get all emails By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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	-

getEmailsPaginatedWithHttpInfo

public ApiResponse<PageEmailProjection> getEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
                                                                       Integer page,
                                                                       Integer size,
                                                                       String sort,
                                                                       Boolean unreadOnly)
                                                                throws ApiException

Get all emails By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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	-

getEmailsPaginatedAsync

public okhttp3.Call getEmailsPaginatedAsync(List<UUID> inboxId,
                                            Integer page,
                                            Integer size,
                                            String sort,
                                            Boolean unreadOnly,
                                            ApiCallback<PageEmailProjection> _callback)
                                     throws ApiException

Get all emails (asynchronously) By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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

getLatestEmailCall

public okhttp3.Call getLatestEmailCall(List<UUID> inboxIds,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getLatestEmail

Parameters:

inboxIds - Optional set of inboxes to filter by. Only get the latest email from these inbox IDs (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getLatestEmail

public Email getLatestEmail(List<UUID> inboxIds)
                     throws ApiException

Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

inboxIds - Optional set of inboxes to filter by. Only get the latest email from these inbox IDs (optional)

Returns:

Email

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	-

getLatestEmailWithHttpInfo

public ApiResponse<Email> getLatestEmailWithHttpInfo(List<UUID> inboxIds)
                                              throws ApiException

Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

inboxIds - Optional set of inboxes to filter by. Only get the latest email from these inbox IDs (optional)

Returns:

ApiResponse<Email>

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	-

getLatestEmailAsync

public okhttp3.Call getLatestEmailAsync(List<UUID> inboxIds,
                                        ApiCallback<Email> _callback)
                                 throws ApiException

Get latest email (asynchronously) Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

inboxIds - Optional set of inboxes to filter by. Only get the latest email from these inbox IDs (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getLatestEmailInInboxCall

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

Build call for getLatestEmailInInbox

Parameters:

inboxId - ID of the inbox you want to get the latest email from (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getLatestEmailInInbox

public Email getLatestEmailInInbox(UUID inboxId)
                            throws ApiException

Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

inboxId - ID of the inbox you want to get the latest email from (optional)

Returns:

Email

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	-

getLatestEmailInInboxWithHttpInfo

public ApiResponse<Email> getLatestEmailInInboxWithHttpInfo(UUID inboxId)
                                                     throws ApiException

Get latest email Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

inboxId - ID of the inbox you want to get the latest email from (optional)

Returns:

ApiResponse<Email>

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	-

getLatestEmailInInboxAsync

public okhttp3.Call getLatestEmailInInboxAsync(UUID inboxId,
                                               ApiCallback<Email> _callback)
                                        throws ApiException

Get latest email (asynchronously) Get the newest email in all inboxes or in a passed set of inbox IDs

Parameters:

inboxId - ID of the inbox you want to get the latest email from (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	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getOrganizationEmailsPaginatedCall

public okhttp3.Call getOrganizationEmailsPaginatedCall(List<UUID> inboxId,
                                                       Integer page,
                                                       Integer size,
                                                       String sort,
                                                       Boolean unreadOnly,
                                                       ApiCallback _callback)
                                                throws ApiException

Build call for getOrganizationEmailsPaginated

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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

getOrganizationEmailsPaginated

public PageEmailProjection getOrganizationEmailsPaginated(List<UUID> inboxId,
                                                          Integer page,
                                                          Integer size,
                                                          String sort,
                                                          Boolean unreadOnly)
                                                   throws ApiException

Get all organization emails By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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	-

getOrganizationEmailsPaginatedWithHttpInfo

public ApiResponse<PageEmailProjection> getOrganizationEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
                                                                                   Integer page,
                                                                                   Integer size,
                                                                                   String sort,
                                                                                   Boolean unreadOnly)
                                                                            throws ApiException

Get all organization emails By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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	-

getOrganizationEmailsPaginatedAsync

public okhttp3.Call getOrganizationEmailsPaginatedAsync(List<UUID> inboxId,
                                                        Integer page,
                                                        Integer size,
                                                        String sort,
                                                        Boolean unreadOnly,
                                                        ApiCallback<PageEmailProjection> _callback)
                                                 throws ApiException

Get all organization emails (asynchronously) By default returns all emails across all team inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages

Parameters:

inboxId - Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account. (optional)

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

size - Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)

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

unreadOnly - Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)

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

getRawEmailContentsCall

public okhttp3.Call getRawEmailContentsCall(UUID emailId,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getRawEmailContents

Parameters:

emailId - ID of email (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	text/plain raw email	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getRawEmailContents

public String getRawEmailContents(UUID emailId)
                           throws ApiException

Get raw email string Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Parameters:

emailId - ID of email (required)

Returns:

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
200	text/plain raw email	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getRawEmailContentsWithHttpInfo

public ApiResponse<String> getRawEmailContentsWithHttpInfo(UUID emailId)
                                                    throws ApiException

Get raw email string Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Parameters:

emailId - ID of email (required)

Returns:

ApiResponse<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
200	text/plain raw email	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getRawEmailContentsAsync

public okhttp3.Call getRawEmailContentsAsync(UUID emailId,
                                             ApiCallback<String> _callback)
                                      throws ApiException

Get raw email string (asynchronously) Returns a raw, unparsed, and unprocessed email. If your client has issues processing the response it is likely due to the response content-type which is text/plain. If you need a JSON response content-type use the getRawEmailJson endpoint

Parameters:

emailId - ID of email (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	text/plain raw email	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

getRawEmailJsonCall

public okhttp3.Call getRawEmailJsonCall(UUID emailId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getRawEmailJson

Parameters:

emailId - ID of email (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	-

getRawEmailJson

public RawEmailJson getRawEmailJson(UUID emailId)
                             throws ApiException

Get raw email in JSON Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

Parameters:

emailId - ID of email (required)

Returns:

RawEmailJson

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	-

getRawEmailJsonWithHttpInfo

public ApiResponse<RawEmailJson> getRawEmailJsonWithHttpInfo(UUID emailId)
                                                      throws ApiException

Get raw email in JSON Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

Parameters:

emailId - ID of email (required)

Returns:

ApiResponse<RawEmailJson>

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	-

getRawEmailJsonAsync

public okhttp3.Call getRawEmailJsonAsync(UUID emailId,
                                         ApiCallback<RawEmailJson> _callback)
                                  throws ApiException

Get raw email in JSON (asynchronously) Returns a raw, unparsed, and unprocessed email wrapped in a JSON response object for easier handling when compared with the getRawEmail text/plain response

Parameters:

emailId - ID of email (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	-

getUnreadEmailCountCall

public okhttp3.Call getUnreadEmailCountCall(ApiCallback _callback)
                                     throws ApiException

Build call for getUnreadEmailCount

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	-

getUnreadEmailCount

public UnreadCount getUnreadEmailCount()
                                throws ApiException

Get unread email count Get number of emails unread

Returns:

UnreadCount

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	-

getUnreadEmailCountWithHttpInfo

public ApiResponse<UnreadCount> getUnreadEmailCountWithHttpInfo()
                                                         throws ApiException

Get unread email count Get number of emails unread

Returns:

ApiResponse<UnreadCount>

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	-

getUnreadEmailCountAsync

public okhttp3.Call getUnreadEmailCountAsync(ApiCallback<UnreadCount> _callback)
                                      throws ApiException

Get unread email count (asynchronously) Get number of emails unread

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	-

replyToEmailCall

public okhttp3.Call replyToEmailCall(UUID emailId,
                                     ReplyToEmailOptions replyToEmailOptions,
                                     ApiCallback _callback)
                              throws ApiException

Build call for replyToEmail

Parameters:

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

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

replyToEmail

public SentEmailDto replyToEmail(UUID emailId,
                                 ReplyToEmailOptions replyToEmailOptions)
                          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:

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

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

replyToEmailWithHttpInfo

public ApiResponse<SentEmailDto> replyToEmailWithHttpInfo(UUID emailId,
                                                          ReplyToEmailOptions replyToEmailOptions)
                                                   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:

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

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

replyToEmailAsync

public okhttp3.Call replyToEmailAsync(UUID emailId,
                                      ReplyToEmailOptions replyToEmailOptions,
                                      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:

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

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

validateEmailCall

public okhttp3.Call validateEmailCall(UUID emailId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for validateEmail

Parameters:

emailId - ID of email (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	-

validateEmail

public ValidationDto validateEmail(UUID emailId)
                            throws ApiException

Validate email Validate the HTML content of email if HTML is found. Considered valid if no HTML.

Parameters:

emailId - ID of email (required)

Returns:

ValidationDto

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	-

validateEmailWithHttpInfo

public ApiResponse<ValidationDto> validateEmailWithHttpInfo(UUID emailId)
                                                     throws ApiException

Validate email Validate the HTML content of email if HTML is found. Considered valid if no HTML.

Parameters:

emailId - ID of email (required)

Returns:

ApiResponse<ValidationDto>

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	-

validateEmailAsync

public okhttp3.Call validateEmailAsync(UUID emailId,
                                       ApiCallback<ValidationDto> _callback)
                                throws ApiException

Validate email (asynchronously) Validate the HTML content of email if HTML is found. Considered valid if no HTML.

Parameters:

emailId - ID of email (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	-