com.mailslurp.apis

Class SentEmailsControllerApi

java.lang.Object

com.mailslurp.apis.SentEmailsControllerApi

public class SentEmailsControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SentEmailsControllerApi()
SentEmailsControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteAllSentEmails() Delete all sent email receipts
okhttp3.Call	deleteAllSentEmailsAsync(ApiCallback<Void> _callback) Delete all sent email receipts (asynchronously)
okhttp3.Call	deleteAllSentEmailsCall(ApiCallback _callback) Build call for deleteAllSentEmails
ApiResponse<Void>	deleteAllSentEmailsWithHttpInfo() Delete all sent email receipts
void	deleteSentEmail(UUID id) Delete sent email receipt
okhttp3.Call	deleteSentEmailAsync(UUID id, ApiCallback<Void> _callback) Delete sent email receipt (asynchronously)
okhttp3.Call	deleteSentEmailCall(UUID id, ApiCallback _callback) Build call for deleteSentEmail
ApiResponse<Void>	deleteSentEmailWithHttpInfo(UUID id) Delete sent email receipt
PageTrackingPixelProjection	getAllSentTrackingPixels(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all sent email tracking pixels in paginated form
okhttp3.Call	getAllSentTrackingPixelsAsync(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageTrackingPixelProjection> _callback) (asynchronously) Get all sent email tracking pixels in paginated form
okhttp3.Call	getAllSentTrackingPixelsCall(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getAllSentTrackingPixels
ApiResponse<PageTrackingPixelProjection>	getAllSentTrackingPixelsWithHttpInfo(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all sent email tracking pixels in paginated form
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
String	getRawSentEmailContents(UUID emailId) Get raw sent email string.
okhttp3.Call	getRawSentEmailContentsAsync(UUID emailId, ApiCallback<String> _callback) Get raw sent email string.
okhttp3.Call	getRawSentEmailContentsCall(UUID emailId, ApiCallback _callback) Build call for getRawSentEmailContents
ApiResponse<String>	getRawSentEmailContentsWithHttpInfo(UUID emailId) Get raw sent email string.
RawEmailJson	getRawSentEmailJson(UUID emailId) Get raw sent email in JSON.
okhttp3.Call	getRawSentEmailJsonAsync(UUID emailId, ApiCallback<RawEmailJson> _callback) Get raw sent email in JSON.
okhttp3.Call	getRawSentEmailJsonCall(UUID emailId, ApiCallback _callback) Build call for getRawSentEmailJson
ApiResponse<RawEmailJson>	getRawSentEmailJsonWithHttpInfo(UUID emailId) Get raw sent email in JSON.
DeliveryStatusDto	getSentDeliveryStatus(UUID deliveryId) Get a sent email delivery status
okhttp3.Call	getSentDeliveryStatusAsync(UUID deliveryId, ApiCallback<DeliveryStatusDto> _callback) (asynchronously) Get a sent email delivery status
okhttp3.Call	getSentDeliveryStatusCall(UUID deliveryId, ApiCallback _callback) Build call for getSentDeliveryStatus
PageDeliveryStatus	getSentDeliveryStatuses(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get all sent email delivery statuses
okhttp3.Call	getSentDeliveryStatusesAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageDeliveryStatus> _callback) (asynchronously) Get all sent email delivery statuses
PageDeliveryStatus	getSentDeliveryStatusesBySentId(UUID sentId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get all sent email delivery statuses
okhttp3.Call	getSentDeliveryStatusesBySentIdAsync(UUID sentId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageDeliveryStatus> _callback) (asynchronously) Get all sent email delivery statuses
okhttp3.Call	getSentDeliveryStatusesBySentIdCall(UUID sentId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSentDeliveryStatusesBySentId
ApiResponse<PageDeliveryStatus>	getSentDeliveryStatusesBySentIdWithHttpInfo(UUID sentId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get all sent email delivery statuses
okhttp3.Call	getSentDeliveryStatusesCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSentDeliveryStatuses
ApiResponse<PageDeliveryStatus>	getSentDeliveryStatusesWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get all sent email delivery statuses
ApiResponse<DeliveryStatusDto>	getSentDeliveryStatusWithHttpInfo(UUID deliveryId) Get a sent email delivery status
SentEmailDto	getSentEmail(UUID id) Get sent email receipt
okhttp3.Call	getSentEmailAsync(UUID id, ApiCallback<SentEmailDto> _callback) Get sent email receipt (asynchronously)
okhttp3.Call	getSentEmailCall(UUID id, ApiCallback _callback) Build call for getSentEmail
String	getSentEmailHTMLContent(UUID id) Get sent email HTML content
okhttp3.Call	getSentEmailHTMLContentAsync(UUID id, ApiCallback<String> _callback) Get sent email HTML content (asynchronously)
okhttp3.Call	getSentEmailHTMLContentCall(UUID id, ApiCallback _callback) Build call for getSentEmailHTMLContent
ApiResponse<String>	getSentEmailHTMLContentWithHttpInfo(UUID id) Get sent email HTML content
EmailPreviewUrls	getSentEmailPreviewURLs(UUID id) Get sent email URL for viewing in browser or downloading Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
okhttp3.Call	getSentEmailPreviewURLsAsync(UUID id, ApiCallback<EmailPreviewUrls> _callback) Get sent email URL for viewing in browser or downloading (asynchronously) Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
okhttp3.Call	getSentEmailPreviewURLsCall(UUID id, ApiCallback _callback) Build call for getSentEmailPreviewURLs
ApiResponse<EmailPreviewUrls>	getSentEmailPreviewURLsWithHttpInfo(UUID id) Get sent email URL for viewing in browser or downloading Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.
PageSentEmailProjection	getSentEmails(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all sent emails in paginated form
okhttp3.Call	getSentEmailsAsync(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageSentEmailProjection> _callback) Get all sent emails in paginated form (asynchronously)
okhttp3.Call	getSentEmailsCall(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSentEmails
ApiResponse<PageSentEmailProjection>	getSentEmailsWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all sent emails in paginated form
PageSentEmailWithQueueProjection	getSentEmailsWithQueueResults(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get results of email sent with queues in paginated form
okhttp3.Call	getSentEmailsWithQueueResultsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageSentEmailWithQueueProjection> _callback) Get results of email sent with queues in paginated form (asynchronously)
okhttp3.Call	getSentEmailsWithQueueResultsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSentEmailsWithQueueResults
ApiResponse<PageSentEmailWithQueueProjection>	getSentEmailsWithQueueResultsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get results of email sent with queues in paginated form
PageTrackingPixelProjection	getSentEmailTrackingPixels(UUID id, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all tracking pixels for a sent email in paginated form
okhttp3.Call	getSentEmailTrackingPixelsAsync(UUID id, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageTrackingPixelProjection> _callback) (asynchronously) Get all tracking pixels for a sent email in paginated form
okhttp3.Call	getSentEmailTrackingPixelsCall(UUID id, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSentEmailTrackingPixels
ApiResponse<PageTrackingPixelProjection>	getSentEmailTrackingPixelsWithHttpInfo(UUID id, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all tracking pixels for a sent email in paginated form
ApiResponse<SentEmailDto>	getSentEmailWithHttpInfo(UUID id) Get sent email receipt
PageSentEmailProjection	getSentOrganizationEmails(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all sent organization emails in paginated form
okhttp3.Call	getSentOrganizationEmailsAsync(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageSentEmailProjection> _callback) (asynchronously) Get all sent organization emails in paginated form
okhttp3.Call	getSentOrganizationEmailsCall(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getSentOrganizationEmails
ApiResponse<PageSentEmailProjection>	getSentOrganizationEmailsWithHttpInfo(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before) Get all sent organization emails in paginated form
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
DeliveryStatusDto	waitForDeliveryStatuses(UUID sentId, UUID inboxId, Long timeout, Integer index, OffsetDateTime since, OffsetDateTime before) Wait for delivery statuses
okhttp3.Call	waitForDeliveryStatusesAsync(UUID sentId, UUID inboxId, Long timeout, Integer index, OffsetDateTime since, OffsetDateTime before, ApiCallback<DeliveryStatusDto> _callback) (asynchronously) Wait for delivery statuses
okhttp3.Call	waitForDeliveryStatusesCall(UUID sentId, UUID inboxId, Long timeout, Integer index, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for waitForDeliveryStatuses
ApiResponse<DeliveryStatusDto>	waitForDeliveryStatusesWithHttpInfo(UUID sentId, UUID inboxId, Long timeout, Integer index, OffsetDateTime since, OffsetDateTime before) Wait for delivery statuses

Methods inherited from class java.lang.Object

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

Constructor Detail

SentEmailsControllerApi

public SentEmailsControllerApi()

SentEmailsControllerApi

public SentEmailsControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

deleteAllSentEmailsCall

public okhttp3.Call deleteAllSentEmailsCall(ApiCallback _callback)
                                     throws ApiException

Build call for deleteAllSentEmails

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	-

deleteAllSentEmails

public void deleteAllSentEmails()
                         throws ApiException

Delete all sent email receipts

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	-

deleteAllSentEmailsWithHttpInfo

public ApiResponse<Void> deleteAllSentEmailsWithHttpInfo()
                                                  throws ApiException

Delete all sent email receipts

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	-

deleteAllSentEmailsAsync

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

Delete all sent email receipts (asynchronously)

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	-

deleteSentEmailCall

public okhttp3.Call deleteSentEmailCall(UUID id,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for deleteSentEmail

Parameters:

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

deleteSentEmail

public void deleteSentEmail(UUID id)
                     throws ApiException

Delete sent email receipt

Parameters:

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

deleteSentEmailWithHttpInfo

public ApiResponse<Void> deleteSentEmailWithHttpInfo(UUID id)
                                              throws ApiException

Delete sent email receipt

Parameters:

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

deleteSentEmailAsync

public okhttp3.Call deleteSentEmailAsync(UUID id,
                                         ApiCallback<Void> _callback)
                                  throws ApiException

Delete sent email receipt (asynchronously)

Parameters:

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

getAllSentTrackingPixelsCall

public okhttp3.Call getAllSentTrackingPixelsCall(Integer page,
                                                 Integer size,
                                                 String sort,
                                                 String searchFilter,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getAllSentTrackingPixels

Parameters:

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getAllSentTrackingPixels

public PageTrackingPixelProjection getAllSentTrackingPixels(Integer page,
                                                            Integer size,
                                                            String sort,
                                                            String searchFilter,
                                                            OffsetDateTime since,
                                                            OffsetDateTime before)
                                                     throws ApiException

Get all sent email tracking pixels in paginated form

Parameters:

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageTrackingPixelProjection

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	-

getAllSentTrackingPixelsWithHttpInfo

public ApiResponse<PageTrackingPixelProjection> getAllSentTrackingPixelsWithHttpInfo(Integer page,
                                                                                     Integer size,
                                                                                     String sort,
                                                                                     String searchFilter,
                                                                                     OffsetDateTime since,
                                                                                     OffsetDateTime before)
                                                                              throws ApiException

Get all sent email tracking pixels in paginated form

Parameters:

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageTrackingPixelProjection>

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	-

getAllSentTrackingPixelsAsync

public okhttp3.Call getAllSentTrackingPixelsAsync(Integer page,
                                                  Integer size,
                                                  String sort,
                                                  String searchFilter,
                                                  OffsetDateTime since,
                                                  OffsetDateTime before,
                                                  ApiCallback<PageTrackingPixelProjection> _callback)
                                           throws ApiException

(asynchronously) Get all sent email tracking pixels in paginated form

Parameters:

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getRawSentEmailContentsCall

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

Build call for getRawSentEmailContents

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	-

getRawSentEmailContents

public String getRawSentEmailContents(UUID emailId)
                               throws ApiException

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. Returns a raw, unparsed, and unprocessed sent 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 getRawSentEmailJson 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	OK	-

getRawSentEmailContentsWithHttpInfo

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

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. Returns a raw, unparsed, and unprocessed sent 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 getRawSentEmailJson 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	OK	-

getRawSentEmailContentsAsync

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

Get raw sent email string. Returns unparsed raw SMTP message with headers and body. (asynchronously) Returns a raw, unparsed, and unprocessed sent 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 getRawSentEmailJson 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	OK	-

getRawSentEmailJsonCall

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

Build call for getRawSentEmailJson

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	-

getRawSentEmailJson

public RawEmailJson getRawSentEmailJson(UUID emailId)
                                 throws ApiException

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail 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	-

getRawSentEmailJsonWithHttpInfo

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

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail 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	-

getRawSentEmailJsonAsync

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

Get raw sent email in JSON. Unparsed SMTP message in JSON wrapper format. (asynchronously) Returns a raw, unparsed, and unprocessed sent email wrapped in a JSON response object for easier handling when compared with the getRawSentEmail 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	-

getSentDeliveryStatusCall

public okhttp3.Call getSentDeliveryStatusCall(UUID deliveryId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getSentDeliveryStatus

Parameters:

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

getSentDeliveryStatus

public DeliveryStatusDto getSentDeliveryStatus(UUID deliveryId)
                                        throws ApiException

Get a sent email delivery status

Parameters:

deliveryId - (required)

Returns:

DeliveryStatusDto

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	-

getSentDeliveryStatusWithHttpInfo

public ApiResponse<DeliveryStatusDto> getSentDeliveryStatusWithHttpInfo(UUID deliveryId)
                                                                 throws ApiException

Get a sent email delivery status

Parameters:

deliveryId - (required)

Returns:

ApiResponse<DeliveryStatusDto>

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	-

getSentDeliveryStatusAsync

public okhttp3.Call getSentDeliveryStatusAsync(UUID deliveryId,
                                               ApiCallback<DeliveryStatusDto> _callback)
                                        throws ApiException

(asynchronously) Get a sent email delivery status

Parameters:

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

getSentDeliveryStatusesCall

public okhttp3.Call getSentDeliveryStatusesCall(Integer page,
                                                Integer size,
                                                String sort,
                                                OffsetDateTime since,
                                                OffsetDateTime before,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getSentDeliveryStatuses

Parameters:

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentDeliveryStatuses

public PageDeliveryStatus getSentDeliveryStatuses(Integer page,
                                                  Integer size,
                                                  String sort,
                                                  OffsetDateTime since,
                                                  OffsetDateTime before)
                                           throws ApiException

Get all sent email delivery statuses

Parameters:

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageDeliveryStatus

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	-

getSentDeliveryStatusesWithHttpInfo

public ApiResponse<PageDeliveryStatus> getSentDeliveryStatusesWithHttpInfo(Integer page,
                                                                           Integer size,
                                                                           String sort,
                                                                           OffsetDateTime since,
                                                                           OffsetDateTime before)
                                                                    throws ApiException

Get all sent email delivery statuses

Parameters:

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageDeliveryStatus>

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	-

getSentDeliveryStatusesAsync

public okhttp3.Call getSentDeliveryStatusesAsync(Integer page,
                                                 Integer size,
                                                 String sort,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before,
                                                 ApiCallback<PageDeliveryStatus> _callback)
                                          throws ApiException

(asynchronously) Get all sent email delivery statuses

Parameters:

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentDeliveryStatusesBySentIdCall

public okhttp3.Call getSentDeliveryStatusesBySentIdCall(UUID sentId,
                                                        Integer page,
                                                        Integer size,
                                                        String sort,
                                                        OffsetDateTime since,
                                                        OffsetDateTime before,
                                                        ApiCallback _callback)
                                                 throws ApiException

Build call for getSentDeliveryStatusesBySentId

Parameters:

sentId - ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentDeliveryStatusesBySentId

public PageDeliveryStatus getSentDeliveryStatusesBySentId(UUID sentId,
                                                          Integer page,
                                                          Integer size,
                                                          String sort,
                                                          OffsetDateTime since,
                                                          OffsetDateTime before)
                                                   throws ApiException

Get all sent email delivery statuses

Parameters:

sentId - ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageDeliveryStatus

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	-

getSentDeliveryStatusesBySentIdWithHttpInfo

public ApiResponse<PageDeliveryStatus> getSentDeliveryStatusesBySentIdWithHttpInfo(UUID sentId,
                                                                                   Integer page,
                                                                                   Integer size,
                                                                                   String sort,
                                                                                   OffsetDateTime since,
                                                                                   OffsetDateTime before)
                                                                            throws ApiException

Get all sent email delivery statuses

Parameters:

sentId - ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageDeliveryStatus>

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	-

getSentDeliveryStatusesBySentIdAsync

public okhttp3.Call getSentDeliveryStatusesBySentIdAsync(UUID sentId,
                                                         Integer page,
                                                         Integer size,
                                                         String sort,
                                                         OffsetDateTime since,
                                                         OffsetDateTime before,
                                                         ApiCallback<PageDeliveryStatus> _callback)
                                                  throws ApiException

(asynchronously) Get all sent email delivery statuses

Parameters:

sentId - ID of the sent email that you want to get the delivery status of. Sent email object is returned when sending an email (required)

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

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

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentEmailCall

public okhttp3.Call getSentEmailCall(UUID id,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getSentEmail

Parameters:

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

getSentEmail

public SentEmailDto getSentEmail(UUID id)
                          throws ApiException

Get sent email receipt

Parameters:

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

getSentEmailWithHttpInfo

public ApiResponse<SentEmailDto> getSentEmailWithHttpInfo(UUID id)
                                                   throws ApiException

Get sent email receipt

Parameters:

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

getSentEmailAsync

public okhttp3.Call getSentEmailAsync(UUID id,
                                      ApiCallback<SentEmailDto> _callback)
                               throws ApiException

Get sent email receipt (asynchronously)

Parameters:

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

getSentEmailHTMLContentCall

public okhttp3.Call getSentEmailHTMLContentCall(UUID id,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getSentEmailHTMLContent

Parameters:

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

getSentEmailHTMLContent

public String getSentEmailHTMLContent(UUID id)
                               throws ApiException

Get sent email HTML content

Parameters:

id - (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	OK	-

getSentEmailHTMLContentWithHttpInfo

public ApiResponse<String> getSentEmailHTMLContentWithHttpInfo(UUID id)
                                                        throws ApiException

Get sent email HTML content

Parameters:

id - (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	OK	-

getSentEmailHTMLContentAsync

public okhttp3.Call getSentEmailHTMLContentAsync(UUID id,
                                                 ApiCallback<String> _callback)
                                          throws ApiException

Get sent email HTML content (asynchronously)

Parameters:

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

getSentEmailPreviewURLsCall

public okhttp3.Call getSentEmailPreviewURLsCall(UUID id,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getSentEmailPreviewURLs

Parameters:

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

getSentEmailPreviewURLs

public EmailPreviewUrls getSentEmailPreviewURLs(UUID id)
                                         throws ApiException

Get sent email URL for viewing in browser or downloading Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.

Parameters:

id - (required)

Returns:

EmailPreviewUrls

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	-

getSentEmailPreviewURLsWithHttpInfo

public ApiResponse<EmailPreviewUrls> getSentEmailPreviewURLsWithHttpInfo(UUID id)
                                                                  throws ApiException

Get sent email URL for viewing in browser or downloading Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.

Parameters:

id - (required)

Returns:

ApiResponse<EmailPreviewUrls>

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	-

getSentEmailPreviewURLsAsync

public okhttp3.Call getSentEmailPreviewURLsAsync(UUID id,
                                                 ApiCallback<EmailPreviewUrls> _callback)
                                          throws ApiException

Get sent email URL for viewing in browser or downloading (asynchronously) Get a list of URLs for sent email content as text/html or raw SMTP message for viewing the message in a browser.

Parameters:

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

getSentEmailTrackingPixelsCall

public okhttp3.Call getSentEmailTrackingPixelsCall(UUID id,
                                                   Integer page,
                                                   Integer size,
                                                   String sort,
                                                   String searchFilter,
                                                   OffsetDateTime since,
                                                   OffsetDateTime before,
                                                   ApiCallback _callback)
                                            throws ApiException

Build call for getSentEmailTrackingPixels

Parameters:

id - (required)

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentEmailTrackingPixels

public PageTrackingPixelProjection getSentEmailTrackingPixels(UUID id,
                                                              Integer page,
                                                              Integer size,
                                                              String sort,
                                                              String searchFilter,
                                                              OffsetDateTime since,
                                                              OffsetDateTime before)
                                                       throws ApiException

Get all tracking pixels for a sent email in paginated form

Parameters:

id - (required)

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageTrackingPixelProjection

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	-

getSentEmailTrackingPixelsWithHttpInfo

public ApiResponse<PageTrackingPixelProjection> getSentEmailTrackingPixelsWithHttpInfo(UUID id,
                                                                                       Integer page,
                                                                                       Integer size,
                                                                                       String sort,
                                                                                       String searchFilter,
                                                                                       OffsetDateTime since,
                                                                                       OffsetDateTime before)
                                                                                throws ApiException

Get all tracking pixels for a sent email in paginated form

Parameters:

id - (required)

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageTrackingPixelProjection>

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	-

getSentEmailTrackingPixelsAsync

public okhttp3.Call getSentEmailTrackingPixelsAsync(UUID id,
                                                    Integer page,
                                                    Integer size,
                                                    String sort,
                                                    String searchFilter,
                                                    OffsetDateTime since,
                                                    OffsetDateTime before,
                                                    ApiCallback<PageTrackingPixelProjection> _callback)
                                             throws ApiException

(asynchronously) Get all tracking pixels for a sent email in paginated form

Parameters:

id - (required)

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

size - Optional page size in sent email tracking pixel list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentEmailsCall

public okhttp3.Call getSentEmailsCall(UUID inboxId,
                                      Integer page,
                                      Integer size,
                                      String sort,
                                      String searchFilter,
                                      OffsetDateTime since,
                                      OffsetDateTime before,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getSentEmails

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentEmails

public PageSentEmailProjection getSentEmails(UUID inboxId,
                                             Integer page,
                                             Integer size,
                                             String sort,
                                             String searchFilter,
                                             OffsetDateTime since,
                                             OffsetDateTime before)
                                      throws ApiException

Get all sent emails in paginated form

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageSentEmailProjection

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	-

getSentEmailsWithHttpInfo

public ApiResponse<PageSentEmailProjection> getSentEmailsWithHttpInfo(UUID inboxId,
                                                                      Integer page,
                                                                      Integer size,
                                                                      String sort,
                                                                      String searchFilter,
                                                                      OffsetDateTime since,
                                                                      OffsetDateTime before)
                                                               throws ApiException

Get all sent emails in paginated form

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageSentEmailProjection>

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	-

getSentEmailsAsync

public okhttp3.Call getSentEmailsAsync(UUID inboxId,
                                       Integer page,
                                       Integer size,
                                       String sort,
                                       String searchFilter,
                                       OffsetDateTime since,
                                       OffsetDateTime before,
                                       ApiCallback<PageSentEmailProjection> _callback)
                                throws ApiException

Get all sent emails in paginated form (asynchronously)

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentEmailsWithQueueResultsCall

public okhttp3.Call getSentEmailsWithQueueResultsCall(Integer page,
                                                      Integer size,
                                                      String sort,
                                                      OffsetDateTime since,
                                                      OffsetDateTime before,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for getSentEmailsWithQueueResults

Parameters:

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentEmailsWithQueueResults

public PageSentEmailWithQueueProjection getSentEmailsWithQueueResults(Integer page,
                                                                      Integer size,
                                                                      String sort,
                                                                      OffsetDateTime since,
                                                                      OffsetDateTime before)
                                                               throws ApiException

Get results of email sent with queues in paginated form

Parameters:

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageSentEmailWithQueueProjection

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	-

getSentEmailsWithQueueResultsWithHttpInfo

public ApiResponse<PageSentEmailWithQueueProjection> getSentEmailsWithQueueResultsWithHttpInfo(Integer page,
                                                                                               Integer size,
                                                                                               String sort,
                                                                                               OffsetDateTime since,
                                                                                               OffsetDateTime before)
                                                                                        throws ApiException

Get results of email sent with queues in paginated form

Parameters:

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageSentEmailWithQueueProjection>

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	-

getSentEmailsWithQueueResultsAsync

public okhttp3.Call getSentEmailsWithQueueResultsAsync(Integer page,
                                                       Integer size,
                                                       String sort,
                                                       OffsetDateTime since,
                                                       OffsetDateTime before,
                                                       ApiCallback<PageSentEmailWithQueueProjection> _callback)
                                                throws ApiException

Get results of email sent with queues in paginated form (asynchronously)

Parameters:

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

size - Optional page size in inbox sent email list pagination (optional, default to 20)

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

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentOrganizationEmailsCall

public okhttp3.Call getSentOrganizationEmailsCall(UUID inboxId,
                                                  Integer page,
                                                  Integer size,
                                                  String sort,
                                                  String searchFilter,
                                                  OffsetDateTime since,
                                                  OffsetDateTime before,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getSentOrganizationEmails

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

getSentOrganizationEmails

public PageSentEmailProjection getSentOrganizationEmails(UUID inboxId,
                                                         Integer page,
                                                         Integer size,
                                                         String sort,
                                                         String searchFilter,
                                                         OffsetDateTime since,
                                                         OffsetDateTime before)
                                                  throws ApiException

Get all sent organization emails in paginated form

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageSentEmailProjection

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	-

getSentOrganizationEmailsWithHttpInfo

public ApiResponse<PageSentEmailProjection> getSentOrganizationEmailsWithHttpInfo(UUID inboxId,
                                                                                  Integer page,
                                                                                  Integer size,
                                                                                  String sort,
                                                                                  String searchFilter,
                                                                                  OffsetDateTime since,
                                                                                  OffsetDateTime before)
                                                                           throws ApiException

Get all sent organization emails in paginated form

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageSentEmailProjection>

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	-

getSentOrganizationEmailsAsync

public okhttp3.Call getSentOrganizationEmailsAsync(UUID inboxId,
                                                   Integer page,
                                                   Integer size,
                                                   String sort,
                                                   String searchFilter,
                                                   OffsetDateTime since,
                                                   OffsetDateTime before,
                                                   ApiCallback<PageSentEmailProjection> _callback)
                                            throws ApiException

(asynchronously) Get all sent organization emails in paginated form

Parameters:

inboxId - Optional inboxId to filter sender of sent emails by (optional)

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

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

waitForDeliveryStatusesCall

public okhttp3.Call waitForDeliveryStatusesCall(UUID sentId,
                                                UUID inboxId,
                                                Long timeout,
                                                Integer index,
                                                OffsetDateTime since,
                                                OffsetDateTime before,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for waitForDeliveryStatuses

Parameters:

sentId - Optional sent email ID filter (optional)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

index - Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-

waitForDeliveryStatuses

public DeliveryStatusDto waitForDeliveryStatuses(UUID sentId,
                                                 UUID inboxId,
                                                 Long timeout,
                                                 Integer index,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before)
                                          throws ApiException

Wait for delivery statuses

Parameters:

sentId - Optional sent email ID filter (optional)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

index - Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

DeliveryStatusDto

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	-

waitForDeliveryStatusesWithHttpInfo

public ApiResponse<DeliveryStatusDto> waitForDeliveryStatusesWithHttpInfo(UUID sentId,
                                                                          UUID inboxId,
                                                                          Long timeout,
                                                                          Integer index,
                                                                          OffsetDateTime since,
                                                                          OffsetDateTime before)
                                                                   throws ApiException

Wait for delivery statuses

Parameters:

sentId - Optional sent email ID filter (optional)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

index - Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<DeliveryStatusDto>

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	-

waitForDeliveryStatusesAsync

public okhttp3.Call waitForDeliveryStatusesAsync(UUID sentId,
                                                 UUID inboxId,
                                                 Long timeout,
                                                 Integer index,
                                                 OffsetDateTime since,
                                                 OffsetDateTime before,
                                                 ApiCallback<DeliveryStatusDto> _callback)
                                          throws ApiException

(asynchronously) Wait for delivery statuses

Parameters:

sentId - Optional sent email ID filter (optional)

inboxId - Optional inbox ID filter (optional)

timeout - Optional timeout milliseconds (optional)

index - Zero based index of the delivery status to wait for. If 1 delivery status already and you want to wait for the 2nd pass index=1 (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (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	-