public class EmailControllerApi extends Object
Constructor and Description |
---|
EmailControllerApi() |
EmailControllerApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
EmailPreview |
applyImapFlagOperation(UUID emailId,
ImapFlagOperationOptions imapFlagOperationOptions)
Set IMAP flags associated with a message.
|
okhttp3.Call |
applyImapFlagOperationAsync(UUID emailId,
ImapFlagOperationOptions imapFlagOperationOptions,
ApiCallback<EmailPreview> _callback)
Set IMAP flags associated with a message.
|
okhttp3.Call |
applyImapFlagOperationCall(UUID emailId,
ImapFlagOperationOptions imapFlagOperationOptions,
ApiCallback _callback)
Build call for applyImapFlagOperation
|
ApiResponse<EmailPreview> |
applyImapFlagOperationWithHttpInfo(UUID emailId,
ImapFlagOperationOptions imapFlagOperationOptions)
Set IMAP flags associated with a message.
|
void |
deleteAllEmails()
Delete all emails in all inboxes.
|
okhttp3.Call |
deleteAllEmailsAsync(ApiCallback<Void> _callback)
Delete all emails in all inboxes.
|
okhttp3.Call |
deleteAllEmailsCall(ApiCallback _callback)
Build call for deleteAllEmails
|
ApiResponse<Void> |
deleteAllEmailsWithHttpInfo()
Delete all emails in all inboxes.
|
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(UUID emailId,
String attachmentId,
String apiKey)
Get email attachment bytes.
|
okhttp3.Call |
downloadAttachmentAsync(UUID emailId,
String attachmentId,
String apiKey,
ApiCallback<byte[]> _callback)
Get email attachment bytes.
|
DownloadAttachmentDto |
downloadAttachmentBase64(UUID emailId,
String attachmentId)
Get email attachment as base64 encoded string as an alternative to binary responses.
|
okhttp3.Call |
downloadAttachmentBase64Async(UUID emailId,
String attachmentId,
ApiCallback<DownloadAttachmentDto> _callback)
Get email attachment as base64 encoded string as an alternative to binary responses.
|
okhttp3.Call |
downloadAttachmentBase64Call(UUID emailId,
String attachmentId,
ApiCallback _callback)
Build call for downloadAttachmentBase64
|
ApiResponse<DownloadAttachmentDto> |
downloadAttachmentBase64WithHttpInfo(UUID emailId,
String attachmentId)
Get email attachment as base64 encoded string as an alternative to binary responses.
|
okhttp3.Call |
downloadAttachmentCall(UUID emailId,
String attachmentId,
String apiKey,
ApiCallback _callback)
Build call for downloadAttachment
|
ApiResponse<byte[]> |
downloadAttachmentWithHttpInfo(UUID emailId,
String attachmentId,
String apiKey)
Get email attachment bytes.
|
String |
downloadBody(UUID emailId)
Get email body as string.
|
okhttp3.Call |
downloadBodyAsync(UUID emailId,
ApiCallback<String> _callback)
Get email body as string.
|
byte[] |
downloadBodyBytes(UUID emailId)
Get email body in bytes.
|
okhttp3.Call |
downloadBodyBytesAsync(UUID emailId,
ApiCallback<byte[]> _callback)
Get email body in bytes.
|
okhttp3.Call |
downloadBodyBytesCall(UUID emailId,
ApiCallback _callback)
Build call for downloadBodyBytes
|
ApiResponse<byte[]> |
downloadBodyBytesWithHttpInfo(UUID emailId)
Get email body in bytes.
|
okhttp3.Call |
downloadBodyCall(UUID emailId,
ApiCallback _callback)
Build call for downloadBody
|
ApiResponse<String> |
downloadBodyWithHttpInfo(UUID emailId)
Get email body as string.
|
SentEmailDto |
forwardEmail(UUID emailId,
ForwardEmailOptions forwardEmailOptions)
Forward email to recipients
Forward an existing email to new recipients.
|
okhttp3.Call |
forwardEmailAsync(UUID emailId,
ForwardEmailOptions forwardEmailOptions,
ApiCallback<SentEmailDto> _callback)
Forward email to recipients (asynchronously)
Forward an existing email to new recipients.
|
okhttp3.Call |
forwardEmailCall(UUID emailId,
ForwardEmailOptions forwardEmailOptions,
ApiCallback _callback)
Build call for forwardEmail
|
ApiResponse<SentEmailDto> |
forwardEmailWithHttpInfo(UUID emailId,
ForwardEmailOptions forwardEmailOptions)
Forward email to recipients
Forward an existing email to new recipients.
|
ApiClient |
getApiClient() |
AttachmentMetaData |
getAttachmentMetaData(UUID emailId,
String attachmentId)
Get email attachment metadata.
|
okhttp3.Call |
getAttachmentMetaDataAsync(UUID emailId,
String attachmentId,
ApiCallback<AttachmentMetaData> _callback)
Get email attachment metadata.
|
okhttp3.Call |
getAttachmentMetaDataCall(UUID emailId,
String attachmentId,
ApiCallback _callback)
Build call for getAttachmentMetaData
|
ApiResponse<AttachmentMetaData> |
getAttachmentMetaDataWithHttpInfo(UUID emailId,
String attachmentId)
Get email attachment metadata.
|
String |
getCustomBaseUrl() |
Email |
getEmail(UUID emailId,
Boolean decode)
Get email content including headers and body.
|
okhttp3.Call |
getEmailAsync(UUID emailId,
Boolean decode,
ApiCallback<Email> _callback)
Get email content including headers and body.
|
List<AttachmentMetaData> |
getEmailAttachments(UUID emailId)
Get all email attachment metadata.
|
okhttp3.Call |
getEmailAttachmentsAsync(UUID emailId,
ApiCallback<List<AttachmentMetaData>> _callback)
Get all email attachment metadata.
|
okhttp3.Call |
getEmailAttachmentsCall(UUID emailId,
ApiCallback _callback)
Build call for getEmailAttachments
|
ApiResponse<List<AttachmentMetaData>> |
getEmailAttachmentsWithHttpInfo(UUID emailId)
Get all email attachment metadata.
|
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.
|
CountDto |
getEmailCount()
Get email count
|
okhttp3.Call |
getEmailCountAsync(ApiCallback<CountDto> _callback)
Get email count (asynchronously)
|
okhttp3.Call |
getEmailCountCall(ApiCallback _callback)
Build call for getEmailCount
|
ApiResponse<CountDto> |
getEmailCountWithHttpInfo()
Get email count
|
String |
getEmailHTML(UUID emailId,
Boolean decode)
Get email content as HTML.
|
okhttp3.Call |
getEmailHTMLAsync(UUID emailId,
Boolean decode,
ApiCallback<String> _callback)
Get email content as HTML.
|
okhttp3.Call |
getEmailHTMLCall(UUID emailId,
Boolean decode,
ApiCallback _callback)
Build call for getEmailHTML
|
EmailHtmlDto |
getEmailHTMLJson(UUID emailId,
Boolean decode)
Get email content as HTML in JSON wrapper.
|
okhttp3.Call |
getEmailHTMLJsonAsync(UUID emailId,
Boolean decode,
ApiCallback<EmailHtmlDto> _callback)
Get email content as HTML in JSON wrapper.
|
okhttp3.Call |
getEmailHTMLJsonCall(UUID emailId,
Boolean decode,
ApiCallback _callback)
Build call for getEmailHTMLJson
|
ApiResponse<EmailHtmlDto> |
getEmailHTMLJsonWithHttpInfo(UUID emailId,
Boolean decode)
Get email content as HTML in JSON wrapper.
|
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.
|
EmailLinksResult |
getEmailLinks(UUID emailId)
Parse and return list of links found in an email (only works for HTML content)
HTML parsing uses JSoup and UNIX line separators.
|
okhttp3.Call |
getEmailLinksAsync(UUID emailId,
ApiCallback<EmailLinksResult> _callback)
Parse and return list of links found in an email (only works for HTML content) (asynchronously)
HTML parsing uses JSoup and UNIX line separators.
|
okhttp3.Call |
getEmailLinksCall(UUID emailId,
ApiCallback _callback)
Build call for getEmailLinks
|
ApiResponse<EmailLinksResult> |
getEmailLinksWithHttpInfo(UUID emailId)
Parse and return list of links found in an email (only works for HTML content)
HTML parsing uses JSoup and UNIX line separators.
|
EmailPreviewUrls |
getEmailPreviewURLs(UUID emailId)
Get email URLs for viewing in browser or downloading
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
|
okhttp3.Call |
getEmailPreviewURLsAsync(UUID emailId,
ApiCallback<EmailPreviewUrls> _callback)
Get email URLs for viewing in browser or downloading (asynchronously)
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
|
okhttp3.Call |
getEmailPreviewURLsCall(UUID emailId,
ApiCallback _callback)
Build call for getEmailPreviewURLs
|
ApiResponse<EmailPreviewUrls> |
getEmailPreviewURLsWithHttpInfo(UUID emailId)
Get email URLs for viewing in browser or downloading
Get a list of URLs for email content as text/html or raw SMTP message for viewing the message in a browser.
|
PageEmailProjection |
getEmailsPaginated(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all emails in all inboxes in paginated form.
|
okhttp3.Call |
getEmailsPaginatedAsync(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageEmailProjection> _callback)
Get all emails in all inboxes in paginated form.
|
okhttp3.Call |
getEmailsPaginatedCall(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getEmailsPaginated
|
ApiResponse<PageEmailProjection> |
getEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all emails in all inboxes in paginated form.
|
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 including headers and body.
|
GravatarUrl |
getGravatarUrlForEmailAddress(String emailAddress,
String size)
Get gravatar url for email address
|
okhttp3.Call |
getGravatarUrlForEmailAddressAsync(String emailAddress,
String size,
ApiCallback<GravatarUrl> _callback)
(asynchronously)
Get gravatar url for email address
|
okhttp3.Call |
getGravatarUrlForEmailAddressCall(String emailAddress,
String size,
ApiCallback _callback)
Build call for getGravatarUrlForEmailAddress
|
ApiResponse<GravatarUrl> |
getGravatarUrlForEmailAddressWithHttpInfo(String emailAddress,
String size)
Get gravatar url for email address
|
int |
getHostIndex() |
Email |
getLatestEmail(List<UUID> inboxIds)
Get latest email in all inboxes.
|
okhttp3.Call |
getLatestEmailAsync(List<UUID> inboxIds,
ApiCallback<Email> _callback)
Get latest email in all inboxes.
|
okhttp3.Call |
getLatestEmailCall(List<UUID> inboxIds,
ApiCallback _callback)
Build call for getLatestEmail
|
Email |
getLatestEmailInInbox1(UUID inboxId)
Get latest email in an inbox.
|
okhttp3.Call |
getLatestEmailInInbox1Async(UUID inboxId,
ApiCallback<Email> _callback)
Get latest email in an inbox.
|
okhttp3.Call |
getLatestEmailInInbox1Call(UUID inboxId,
ApiCallback _callback)
Build call for getLatestEmailInInbox1
|
ApiResponse<Email> |
getLatestEmailInInbox1WithHttpInfo(UUID inboxId)
Get latest email in an inbox.
|
ApiResponse<Email> |
getLatestEmailWithHttpInfo(List<UUID> inboxIds)
Get latest email in all inboxes.
|
PageEmailProjection |
getOrganizationEmailsPaginated(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all organization emails.
|
okhttp3.Call |
getOrganizationEmailsPaginatedAsync(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback<PageEmailProjection> _callback)
Get all organization emails.
|
okhttp3.Call |
getOrganizationEmailsPaginatedCall(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before,
ApiCallback _callback)
Build call for getOrganizationEmailsPaginated
|
ApiResponse<PageEmailProjection> |
getOrganizationEmailsPaginatedWithHttpInfo(List<UUID> inboxId,
Integer page,
Integer size,
String sort,
Boolean unreadOnly,
String searchFilter,
OffsetDateTime since,
OffsetDateTime before)
Get all organization emails.
|
String |
getRawEmailContents(UUID emailId)
Get raw email string.
|
okhttp3.Call |
getRawEmailContentsAsync(UUID emailId,
ApiCallback<String> _callback)
Get raw email string.
|
okhttp3.Call |
getRawEmailContentsCall(UUID emailId,
ApiCallback _callback)
Build call for getRawEmailContents
|
ApiResponse<String> |
getRawEmailContentsWithHttpInfo(UUID emailId)
Get raw email string.
|
RawEmailJson |
getRawEmailJson(UUID emailId)
Get raw email in JSON.
|
okhttp3.Call |
getRawEmailJsonAsync(UUID emailId,
ApiCallback<RawEmailJson> _callback)
Get raw email in JSON.
|
okhttp3.Call |
getRawEmailJsonCall(UUID emailId,
ApiCallback _callback)
Build call for getRawEmailJson
|
ApiResponse<RawEmailJson> |
getRawEmailJsonWithHttpInfo(UUID emailId)
Get raw email in JSON.
|
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.
|
EmailPreview |
markAsRead(UUID emailId,
Boolean read)
Mark an email as read on unread
Marks an email as read or unread.
|
okhttp3.Call |
markAsReadAsync(UUID emailId,
Boolean read,
ApiCallback<EmailPreview> _callback)
Mark an email as read on unread (asynchronously)
Marks an email as read or unread.
|
okhttp3.Call |
markAsReadCall(UUID emailId,
Boolean read,
ApiCallback _callback)
Build call for markAsRead
|
ApiResponse<EmailPreview> |
markAsReadWithHttpInfo(UUID emailId,
Boolean read)
Mark an email as read on unread
Marks an email as read or 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 |
sendEmailSourceOptional(SendEmailOptions sendEmailOptions,
UUID inboxId,
Boolean useDomainPool,
Boolean virtualSend)
Send email
Alias for `InboxController.sendEmail` method - see original method for full details.
|
okhttp3.Call |
sendEmailSourceOptionalAsync(SendEmailOptions sendEmailOptions,
UUID inboxId,
Boolean useDomainPool,
Boolean virtualSend,
ApiCallback<Void> _callback)
Send email (asynchronously)
Alias for `InboxController.sendEmail` method - see original method for full details.
|
okhttp3.Call |
sendEmailSourceOptionalCall(SendEmailOptions sendEmailOptions,
UUID inboxId,
Boolean useDomainPool,
Boolean virtualSend,
ApiCallback _callback)
Build call for sendEmailSourceOptional
|
ApiResponse<Void> |
sendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions,
UUID inboxId,
Boolean useDomainPool,
Boolean virtualSend)
Send email
Alias for `InboxController.sendEmail` method - see original method for full details.
|
void |
setApiClient(ApiClient apiClient) |
void |
setCustomBaseUrl(String customBaseUrl) |
void |
setHostIndex(int hostIndex) |
ValidationDto |
validateEmail(UUID emailId)
Validate email HTML contents
Validate the HTML content of email if HTML is found.
|
okhttp3.Call |
validateEmailAsync(UUID emailId,
ApiCallback<ValidationDto> _callback)
Validate email HTML contents (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 HTML contents
Validate the HTML content of email if HTML is found.
|
public EmailControllerApi()
public EmailControllerApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public int getHostIndex()
public void setHostIndex(int hostIndex)
public String getCustomBaseUrl()
public void setCustomBaseUrl(String customBaseUrl)
public okhttp3.Call applyImapFlagOperationCall(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions, ApiCallback _callback) throws ApiException
emailId
- (required)imapFlagOperationOptions
- (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailPreview applyImapFlagOperation(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions) throws ApiException
emailId
- (required)imapFlagOperationOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailPreview> applyImapFlagOperationWithHttpInfo(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions) throws ApiException
emailId
- (required)imapFlagOperationOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call applyImapFlagOperationAsync(UUID emailId, ImapFlagOperationOptions imapFlagOperationOptions, ApiCallback<EmailPreview> _callback) throws ApiException
emailId
- (required)imapFlagOperationOptions
- (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call deleteAllEmailsCall(ApiCallback _callback) throws ApiException
_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
204 | No Content | - |
public void deleteAllEmails() throws ApiException
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
204 | No Content | - |
public ApiResponse<Void> deleteAllEmailsWithHttpInfo() throws ApiException
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
204 | No Content | - |
public okhttp3.Call deleteAllEmailsAsync(ApiCallback<Void> _callback) throws ApiException
_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
204 | No Content | - |
public okhttp3.Call deleteEmailCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email to delete (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
204 | No Content | - |
public void deleteEmail(UUID emailId) throws ApiException
emailId
- ID of email to delete (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
204 | No Content | - |
public ApiResponse<Void> deleteEmailWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email to delete (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
204 | No Content | - |
public okhttp3.Call deleteEmailAsync(UUID emailId, ApiCallback<Void> _callback) throws ApiException
emailId
- ID of email to delete (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
204 | No Content | - |
public okhttp3.Call downloadAttachmentCall(UUID emailId, String attachmentId, String apiKey, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (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 progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
0 | default response | - |
public byte[] downloadAttachment(UUID emailId, String attachmentId, String apiKey) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
0 | default response | - |
public ApiResponse<byte[]> downloadAttachmentWithHttpInfo(UUID emailId, String attachmentId, String apiKey) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
0 | default response | - |
public okhttp3.Call downloadAttachmentAsync(UUID emailId, String attachmentId, String apiKey, ApiCallback<byte[]> _callback) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
0 | default response | - |
public okhttp3.Call downloadAttachmentBase64Call(UUID emailId, String attachmentId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public DownloadAttachmentDto downloadAttachmentBase64(UUID emailId, String attachmentId) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<DownloadAttachmentDto> downloadAttachmentBase64WithHttpInfo(UUID emailId, String attachmentId) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call downloadAttachmentBase64Async(UUID emailId, String attachmentId, ApiCallback<DownloadAttachmentDto> _callback) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call downloadBodyCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public String downloadBody(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<String> downloadBodyWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call downloadBodyAsync(UUID emailId, ApiCallback<String> _callback) throws ApiException
emailId
- ID of email (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call downloadBodyBytesCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
0 | default response | - |
public byte[] downloadBodyBytes(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
0 | default response | - |
public ApiResponse<byte[]> downloadBodyBytesWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
0 | default response | - |
public okhttp3.Call downloadBodyBytesAsync(UUID emailId, ApiCallback<byte[]> _callback) throws ApiException
emailId
- ID of email (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
0 | default response | - |
public okhttp3.Call forwardEmailCall(UUID emailId, ForwardEmailOptions forwardEmailOptions, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)forwardEmailOptions
- (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
201 | Created | - |
public SentEmailDto forwardEmail(UUID emailId, ForwardEmailOptions forwardEmailOptions) throws ApiException
emailId
- ID of email (required)forwardEmailOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
201 | Created | - |
public ApiResponse<SentEmailDto> forwardEmailWithHttpInfo(UUID emailId, ForwardEmailOptions forwardEmailOptions) throws ApiException
emailId
- ID of email (required)forwardEmailOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
201 | Created | - |
public okhttp3.Call forwardEmailAsync(UUID emailId, ForwardEmailOptions forwardEmailOptions, ApiCallback<SentEmailDto> _callback) throws ApiException
emailId
- ID of email (required)forwardEmailOptions
- (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
201 | Created | - |
public okhttp3.Call getAttachmentMetaDataCall(UUID emailId, String attachmentId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public AttachmentMetaData getAttachmentMetaData(UUID emailId, String attachmentId) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<AttachmentMetaData> getAttachmentMetaDataWithHttpInfo(UUID emailId, String attachmentId) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getAttachmentMetaDataAsync(UUID emailId, String attachmentId, ApiCallback<AttachmentMetaData> _callback) throws ApiException
emailId
- ID of email (required)attachmentId
- ID of attachment (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailCall(UUID emailId, Boolean decode, ApiCallback _callback) throws ApiException
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 progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public Email getEmail(UUID emailId, Boolean decode) throws ApiException
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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<Email> getEmailWithHttpInfo(UUID emailId, Boolean decode) throws ApiException
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)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailAsync(UUID emailId, Boolean decode, ApiCallback<Email> _callback) throws ApiException
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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailAttachmentsCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public List<AttachmentMetaData> getEmailAttachments(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<List<AttachmentMetaData>> getEmailAttachmentsWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailAttachmentsAsync(UUID emailId, ApiCallback<List<AttachmentMetaData>> _callback) throws ApiException
emailId
- ID of email (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailContentMatchCall(UUID emailId, ContentMatchOptions contentMatchOptions, ApiCallback _callback) throws ApiException
emailId
- ID of email to match against (required)contentMatchOptions
- (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailContentMatchResult getEmailContentMatch(UUID emailId, ContentMatchOptions contentMatchOptions) throws ApiException
emailId
- ID of email to match against (required)contentMatchOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailContentMatchResult> getEmailContentMatchWithHttpInfo(UUID emailId, ContentMatchOptions contentMatchOptions) throws ApiException
emailId
- ID of email to match against (required)contentMatchOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailContentMatchAsync(UUID emailId, ContentMatchOptions contentMatchOptions, ApiCallback<EmailContentMatchResult> _callback) throws ApiException
emailId
- ID of email to match against (required)contentMatchOptions
- (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailCountCall(ApiCallback _callback) throws ApiException
_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public CountDto getEmailCount() throws ApiException
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<CountDto> getEmailCountWithHttpInfo() throws ApiException
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailCountAsync(ApiCallback<CountDto> _callback) throws ApiException
_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailHTMLCall(UUID emailId, Boolean decode, ApiCallback _callback) throws ApiException
emailId
- (required)decode
- (optional, default to false)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public String getEmailHTML(UUID emailId, Boolean decode) throws ApiException
emailId
- (required)decode
- (optional, default to false)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<String> getEmailHTMLWithHttpInfo(UUID emailId, Boolean decode) throws ApiException
emailId
- (required)decode
- (optional, default to false)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailHTMLAsync(UUID emailId, Boolean decode, ApiCallback<String> _callback) throws ApiException
emailId
- (required)decode
- (optional, default to false)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailHTMLJsonCall(UUID emailId, Boolean decode, ApiCallback _callback) throws ApiException
emailId
- (required)decode
- (optional, default to false)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailHtmlDto getEmailHTMLJson(UUID emailId, Boolean decode) throws ApiException
emailId
- (required)decode
- (optional, default to false)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailHtmlDto> getEmailHTMLJsonWithHttpInfo(UUID emailId, Boolean decode) throws ApiException
emailId
- (required)decode
- (optional, default to false)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailHTMLJsonAsync(UUID emailId, Boolean decode, ApiCallback<EmailHtmlDto> _callback) throws ApiException
emailId
- (required)decode
- (optional, default to false)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailHTMLQueryCall(UUID emailId, String htmlSelector, ApiCallback _callback) throws ApiException
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. (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailTextLinesResult getEmailHTMLQuery(UUID emailId, String htmlSelector) throws ApiException
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. (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailTextLinesResult> getEmailHTMLQueryWithHttpInfo(UUID emailId, String htmlSelector) throws ApiException
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. (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailHTMLQueryAsync(UUID emailId, String htmlSelector, ApiCallback<EmailTextLinesResult> _callback) throws ApiException
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. (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailLinksCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email to fetch text for (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailLinksResult getEmailLinks(UUID emailId) throws ApiException
emailId
- ID of email to fetch text for (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailLinksResult> getEmailLinksWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email to fetch text for (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailLinksAsync(UUID emailId, ApiCallback<EmailLinksResult> _callback) throws ApiException
emailId
- ID of email to fetch text for (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailPreviewURLsCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailPreviewUrls getEmailPreviewURLs(UUID emailId) throws ApiException
emailId
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailPreviewUrls> getEmailPreviewURLsWithHttpInfo(UUID emailId) throws ApiException
emailId
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailPreviewURLsAsync(UUID emailId, ApiCallback<EmailPreviewUrls> _callback) throws ApiException
emailId
- (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailTextLinesCall(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, ApiCallback _callback) throws ApiException
emailId
- ID of email to fetch text for (required)decodeHtmlEntities
- Decode HTML entities (optional)lineSeparator
- Line separator character (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailTextLinesResult getEmailTextLines(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator) throws ApiException
emailId
- ID of email to fetch text for (required)decodeHtmlEntities
- Decode HTML entities (optional)lineSeparator
- Line separator character (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailTextLinesResult> getEmailTextLinesWithHttpInfo(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator) throws ApiException
emailId
- ID of email to fetch text for (required)decodeHtmlEntities
- Decode HTML entities (optional)lineSeparator
- Line separator character (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailTextLinesAsync(UUID emailId, Boolean decodeHtmlEntities, String lineSeparator, ApiCallback<EmailTextLinesResult> _callback) throws ApiException
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 finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailsPaginatedCall(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
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)searchFilter
- Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public PageEmailProjection getEmailsPaginated(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
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)searchFilter
- Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<PageEmailProjection> getEmailsPaginatedWithHttpInfo(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
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)searchFilter
- Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getEmailsPaginatedAsync(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageEmailProjection> _callback) throws ApiException
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)searchFilter
- Optional search filter. Searches email recipients, sender, subject, email address and ID. Does not search email body (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getGravatarUrlForEmailAddressCall(String emailAddress, String size, ApiCallback _callback) throws ApiException
emailAddress
- (required)size
- (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public GravatarUrl getGravatarUrlForEmailAddress(String emailAddress, String size) throws ApiException
emailAddress
- (required)size
- (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<GravatarUrl> getGravatarUrlForEmailAddressWithHttpInfo(String emailAddress, String size) throws ApiException
emailAddress
- (required)size
- (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getGravatarUrlForEmailAddressAsync(String emailAddress, String size, ApiCallback<GravatarUrl> _callback) throws ApiException
emailAddress
- (required)size
- (optional)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getLatestEmailCall(List<UUID> inboxIds, ApiCallback _callback) throws ApiException
inboxIds
- Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public Email getLatestEmail(List<UUID> inboxIds) throws ApiException
inboxIds
- Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<Email> getLatestEmailWithHttpInfo(List<UUID> inboxIds) throws ApiException
inboxIds
- Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getLatestEmailAsync(List<UUID> inboxIds, ApiCallback<Email> _callback) throws ApiException
inboxIds
- Optional set of inboxes to filter by. Only get the latest email from these inbox IDs. If not provided will search across all inboxes (optional)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getLatestEmailInInbox1Call(UUID inboxId, ApiCallback _callback) throws ApiException
inboxId
- ID of the inbox you want to get the latest email from (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public Email getLatestEmailInInbox1(UUID inboxId) throws ApiException
inboxId
- ID of the inbox you want to get the latest email from (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<Email> getLatestEmailInInbox1WithHttpInfo(UUID inboxId) throws ApiException
inboxId
- ID of the inbox you want to get the latest email from (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getLatestEmailInInbox1Async(UUID inboxId, ApiCallback<Email> _callback) throws ApiException
inboxId
- ID of the inbox you want to get the latest email from (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getOrganizationEmailsPaginatedCall(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) throws ApiException
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)searchFilter
- Optional search filter search filter for emails. (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public PageEmailProjection getOrganizationEmailsPaginated(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
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)searchFilter
- Optional search filter search filter for emails. (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<PageEmailProjection> getOrganizationEmailsPaginatedWithHttpInfo(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before) throws ApiException
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)searchFilter
- Optional search filter search filter for emails. (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getOrganizationEmailsPaginatedAsync(List<UUID> inboxId, Integer page, Integer size, String sort, Boolean unreadOnly, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageEmailProjection> _callback) throws ApiException
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)searchFilter
- Optional search filter search filter for emails. (optional)since
- Optional filter emails received after given date time (optional)before
- Optional filter emails received before given date time (optional)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getRawEmailContentsCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public String getRawEmailContents(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<String> getRawEmailContentsWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getRawEmailContentsAsync(UUID emailId, ApiCallback<String> _callback) throws ApiException
emailId
- ID of email (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getRawEmailJsonCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public RawEmailJson getRawEmailJson(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<RawEmailJson> getRawEmailJsonWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getRawEmailJsonAsync(UUID emailId, ApiCallback<RawEmailJson> _callback) throws ApiException
emailId
- ID of email (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getUnreadEmailCountCall(ApiCallback _callback) throws ApiException
_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public UnreadCount getUnreadEmailCount() throws ApiException
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<UnreadCount> getUnreadEmailCountWithHttpInfo() throws ApiException
ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call getUnreadEmailCountAsync(ApiCallback<UnreadCount> _callback) throws ApiException
_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call markAsReadCall(UUID emailId, Boolean read, ApiCallback _callback) throws ApiException
emailId
- (required)read
- What value to assign to email read property. Default true. (optional, default to true)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public EmailPreview markAsRead(UUID emailId, Boolean read) throws ApiException
emailId
- (required)read
- What value to assign to email read property. Default true. (optional, default to true)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<EmailPreview> markAsReadWithHttpInfo(UUID emailId, Boolean read) throws ApiException
emailId
- (required)read
- What value to assign to email read property. Default true. (optional, default to true)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call markAsReadAsync(UUID emailId, Boolean read, ApiCallback<EmailPreview> _callback) throws ApiException
emailId
- (required)read
- What value to assign to email read property. Default true. (optional, default to true)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call replyToEmailCall(UUID emailId, ReplyToEmailOptions replyToEmailOptions, ApiCallback _callback) throws ApiException
emailId
- ID of the email that should be replied to (required)replyToEmailOptions
- (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public SentEmailDto replyToEmail(UUID emailId, ReplyToEmailOptions replyToEmailOptions) throws ApiException
emailId
- ID of the email that should be replied to (required)replyToEmailOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public ApiResponse<SentEmailDto> replyToEmailWithHttpInfo(UUID emailId, ReplyToEmailOptions replyToEmailOptions) throws ApiException
emailId
- ID of the email that should be replied to (required)replyToEmailOptions
- (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call replyToEmailAsync(UUID emailId, ReplyToEmailOptions replyToEmailOptions, ApiCallback<SentEmailDto> _callback) throws ApiException
emailId
- ID of the email that should be replied to (required)replyToEmailOptions
- (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
200 | OK | - |
public okhttp3.Call sendEmailSourceOptionalCall(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend, ApiCallback _callback) throws ApiException
sendEmailOptions
- (required)inboxId
- ID of the inbox you want to send the email from (optional)useDomainPool
- Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)virtualSend
- Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
201 | Created | - |
public void sendEmailSourceOptional(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend) throws ApiException
sendEmailOptions
- (required)inboxId
- ID of the inbox you want to send the email from (optional)useDomainPool
- Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)virtualSend
- Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
201 | Created | - |
public ApiResponse<Void> sendEmailSourceOptionalWithHttpInfo(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend) throws ApiException
sendEmailOptions
- (required)inboxId
- ID of the inbox you want to send the email from (optional)useDomainPool
- Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)virtualSend
- Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
201 | Created | - |
public okhttp3.Call sendEmailSourceOptionalAsync(SendEmailOptions sendEmailOptions, UUID inboxId, Boolean useDomainPool, Boolean virtualSend, ApiCallback<Void> _callback) throws ApiException
sendEmailOptions
- (required)inboxId
- ID of the inbox you want to send the email from (optional)useDomainPool
- Use domain pool. Optionally create inbox to send from using the mailslurp domain pool. (optional)virtualSend
- Optionally create inbox to send from that is a virtual inbox and won't send to external addresses (optional)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
201 | Created | - |
public okhttp3.Call validateEmailCall(UUID emailId, ApiCallback _callback) throws ApiException
emailId
- ID of email (required)_callback
- Callback for upload/download progressApiException
- If fail to serialize the request body objectStatus Code | Description | Response Headers |
201 | Created | - |
public ValidationDto validateEmail(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
201 | Created | - |
public ApiResponse<ValidationDto> validateEmailWithHttpInfo(UUID emailId) throws ApiException
emailId
- ID of email (required)ApiException
- If fail to call the API, e.g. server error or cannot deserialize the response bodyStatus Code | Description | Response Headers |
201 | Created | - |
public okhttp3.Call validateEmailAsync(UUID emailId, ApiCallback<ValidationDto> _callback) throws ApiException
emailId
- ID of email (required)_callback
- The callback to be executed when the API call finishesApiException
- If fail to process the API call, e.g. serializing the request body objectStatus Code | Description | Response Headers |
201 | Created | - |
Copyright © 2023. All rights reserved.