io.swagger.client.api

Class EmailsApi

java.lang.Object

io.swagger.client.api.EmailsApi

public class EmailsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailsApi()
EmailsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EmailSend	emailsMergePost(EmailMergeMessage body) Send bulk merge email
com.squareup.okhttp.Call	emailsMergePostAsync(EmailMergeMessage body, ApiCallback<EmailSend> callback) Send bulk merge email (asynchronously)
com.squareup.okhttp.Call	emailsMergePostCall(EmailMergeMessage body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailsMergePost
ApiResponse<EmailSend>	emailsMergePostWithHttpInfo(EmailMergeMessage body) Send bulk merge email
Email	emailsMsgidViewGet(String msgid) View email
com.squareup.okhttp.Call	emailsMsgidViewGetAsync(String msgid, ApiCallback<Email> callback) View email (asynchronously)
com.squareup.okhttp.Call	emailsMsgidViewGetCall(String msgid, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailsMsgidViewGet
ApiResponse<Email>	emailsMsgidViewGetWithHttpInfo(String msgid) View email
EmailSend	emailsTransactionalPost(EmailTransactionalMessage body) Send transactional message (recipients will be known to each other)
com.squareup.okhttp.Call	emailsTransactionalPostAsync(EmailTransactionalMessage body, ApiCallback<EmailSend> callback) Send transactional message (recipients will be known to each other) (asynchronously)
com.squareup.okhttp.Call	emailsTransactionalPostCall(EmailTransactionalMessage body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailsTransactionalPost
ApiResponse<EmailSend>	emailsTransactionalPostWithHttpInfo(EmailTransactionalMessage body) Send transactional message (recipients will be known to each other)
void	emailsTransactionidCancelPost(String transactionid) Cancels emails that are waiting to be sent.
com.squareup.okhttp.Call	emailsTransactionidCancelPostAsync(String transactionid, ApiCallback<Void> callback) Cancels emails that are waiting to be sent.
com.squareup.okhttp.Call	emailsTransactionidCancelPostCall(String transactionid, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailsTransactionidCancelPost
ApiResponse<Void>	emailsTransactionidCancelPostWithHttpInfo(String transactionid) Cancels emails that are waiting to be sent.
EmailJobStatus	emailsTransactionidStatusGet(String transactionid, Boolean showFailed, Boolean showSent, Boolean showDelivered, Boolean showPending, Boolean showOpened, Boolean showClicked, Boolean showAbuse, Boolean showUnsubscribed, Boolean showErrors, Boolean showMessageIDs) Get email batch status
com.squareup.okhttp.Call	emailsTransactionidStatusGetAsync(String transactionid, Boolean showFailed, Boolean showSent, Boolean showDelivered, Boolean showPending, Boolean showOpened, Boolean showClicked, Boolean showAbuse, Boolean showUnsubscribed, Boolean showErrors, Boolean showMessageIDs, ApiCallback<EmailJobStatus> callback) Get email batch status (asynchronously)
com.squareup.okhttp.Call	emailsTransactionidStatusGetCall(String transactionid, Boolean showFailed, Boolean showSent, Boolean showDelivered, Boolean showPending, Boolean showOpened, Boolean showClicked, Boolean showAbuse, Boolean showUnsubscribed, Boolean showErrors, Boolean showMessageIDs, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for emailsTransactionidStatusGet
ApiResponse<EmailJobStatus>	emailsTransactionidStatusGetWithHttpInfo(String transactionid, Boolean showFailed, Boolean showSent, Boolean showDelivered, Boolean showPending, Boolean showOpened, Boolean showClicked, Boolean showAbuse, Boolean showUnsubscribed, Boolean showErrors, Boolean showMessageIDs) Get email batch status
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailsApi

public EmailsApi()

EmailsApi

public EmailsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

emailsMergePostCall

public com.squareup.okhttp.Call emailsMergePostCall(EmailMergeMessage body,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for emailsMergePost

Parameters:

body - Content of message, HTML encoded (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailsMergePost

public EmailSend emailsMergePost(EmailMergeMessage body)
                          throws ApiException

Send bulk merge email

Parameters:

body - Content of message, HTML encoded (required)

Returns:

EmailSend

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsMergePostWithHttpInfo

public ApiResponse<EmailSend> emailsMergePostWithHttpInfo(EmailMergeMessage body)
                                                   throws ApiException

Send bulk merge email

Parameters:

body - Content of message, HTML encoded (required)

Returns:

ApiResponse<EmailSend>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsMergePostAsync

public com.squareup.okhttp.Call emailsMergePostAsync(EmailMergeMessage body,
                                                     ApiCallback<EmailSend> callback)
                                              throws ApiException

Send bulk merge email (asynchronously)

Parameters:

body - Content of message, HTML encoded (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

emailsMsgidViewGetCall

public com.squareup.okhttp.Call emailsMsgidViewGetCall(String msgid,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for emailsMsgidViewGet

Parameters:

msgid - Message identifier (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailsMsgidViewGet

public Email emailsMsgidViewGet(String msgid)
                         throws ApiException

View email

Parameters:

msgid - Message identifier (required)

Returns:

Email

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsMsgidViewGetWithHttpInfo

public ApiResponse<Email> emailsMsgidViewGetWithHttpInfo(String msgid)
                                                  throws ApiException

View email

Parameters:

msgid - Message identifier (required)

Returns:

ApiResponse<Email>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsMsgidViewGetAsync

public com.squareup.okhttp.Call emailsMsgidViewGetAsync(String msgid,
                                                        ApiCallback<Email> callback)
                                                 throws ApiException

View email (asynchronously)

Parameters:

msgid - Message identifier (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

emailsTransactionalPostCall

public com.squareup.okhttp.Call emailsTransactionalPostCall(EmailTransactionalMessage body,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for emailsTransactionalPost

Parameters:

body - Content of message, HTML encoded (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailsTransactionalPost

public EmailSend emailsTransactionalPost(EmailTransactionalMessage body)
                                  throws ApiException

Send transactional message (recipients will be known to each other)

Parameters:

body - Content of message, HTML encoded (required)

Returns:

EmailSend

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsTransactionalPostWithHttpInfo

public ApiResponse<EmailSend> emailsTransactionalPostWithHttpInfo(EmailTransactionalMessage body)
                                                           throws ApiException

Send transactional message (recipients will be known to each other)

Parameters:

body - Content of message, HTML encoded (required)

Returns:

ApiResponse<EmailSend>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsTransactionalPostAsync

public com.squareup.okhttp.Call emailsTransactionalPostAsync(EmailTransactionalMessage body,
                                                             ApiCallback<EmailSend> callback)
                                                      throws ApiException

Send transactional message (recipients will be known to each other) (asynchronously)

Parameters:

body - Content of message, HTML encoded (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

emailsTransactionidCancelPostCall

public com.squareup.okhttp.Call emailsTransactionidCancelPostCall(String transactionid,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for emailsTransactionidCancelPost

Parameters:

transactionid - ID number of transaction (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailsTransactionidCancelPost

public void emailsTransactionidCancelPost(String transactionid)
                                   throws ApiException

Cancels emails that are waiting to be sent.

Parameters:

transactionid - ID number of transaction (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsTransactionidCancelPostWithHttpInfo

public ApiResponse<Void> emailsTransactionidCancelPostWithHttpInfo(String transactionid)
                                                            throws ApiException

Cancels emails that are waiting to be sent.

Parameters:

transactionid - ID number of transaction (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsTransactionidCancelPostAsync

public com.squareup.okhttp.Call emailsTransactionidCancelPostAsync(String transactionid,
                                                                   ApiCallback<Void> callback)
                                                            throws ApiException

Cancels emails that are waiting to be sent. (asynchronously)

Parameters:

transactionid - ID number of transaction (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

emailsTransactionidStatusGetCall

public com.squareup.okhttp.Call emailsTransactionidStatusGetCall(String transactionid,
                                                                 Boolean showFailed,
                                                                 Boolean showSent,
                                                                 Boolean showDelivered,
                                                                 Boolean showPending,
                                                                 Boolean showOpened,
                                                                 Boolean showClicked,
                                                                 Boolean showAbuse,
                                                                 Boolean showUnsubscribed,
                                                                 Boolean showErrors,
                                                                 Boolean showMessageIDs,
                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                          throws ApiException

Build call for emailsTransactionidStatusGet

Parameters:

transactionid - Transaction identifier (required)

showFailed - Include Bounced email addresses. (optional, default to False)

showSent - Include Sent email addresses. (optional, default to False)

showDelivered - Include all delivered email addresses. (optional, default to False)

showPending - Include Ready to send email addresses. (optional, default to False)

showOpened - Include Opened email addresses. (optional, default to False)

showClicked - Include Clicked email addresses. (optional, default to False)

showAbuse - Include Reported as abuse email addresses. (optional, default to False)

showUnsubscribed - Include Unsubscribed email addresses. (optional, default to False)

showErrors - Include error messages for bounced emails. (optional, default to False)

showMessageIDs - Include all MessageIDs for this transaction (optional, default to False)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

emailsTransactionidStatusGet

public EmailJobStatus emailsTransactionidStatusGet(String transactionid,
                                                   Boolean showFailed,
                                                   Boolean showSent,
                                                   Boolean showDelivered,
                                                   Boolean showPending,
                                                   Boolean showOpened,
                                                   Boolean showClicked,
                                                   Boolean showAbuse,
                                                   Boolean showUnsubscribed,
                                                   Boolean showErrors,
                                                   Boolean showMessageIDs)
                                            throws ApiException

Get email batch status

Parameters:

transactionid - Transaction identifier (required)

showFailed - Include Bounced email addresses. (optional, default to False)

showSent - Include Sent email addresses. (optional, default to False)

showDelivered - Include all delivered email addresses. (optional, default to False)

showPending - Include Ready to send email addresses. (optional, default to False)

showOpened - Include Opened email addresses. (optional, default to False)

showClicked - Include Clicked email addresses. (optional, default to False)

showAbuse - Include Reported as abuse email addresses. (optional, default to False)

showUnsubscribed - Include Unsubscribed email addresses. (optional, default to False)

showErrors - Include error messages for bounced emails. (optional, default to False)

showMessageIDs - Include all MessageIDs for this transaction (optional, default to False)

Returns:

EmailJobStatus

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsTransactionidStatusGetWithHttpInfo

public ApiResponse<EmailJobStatus> emailsTransactionidStatusGetWithHttpInfo(String transactionid,
                                                                            Boolean showFailed,
                                                                            Boolean showSent,
                                                                            Boolean showDelivered,
                                                                            Boolean showPending,
                                                                            Boolean showOpened,
                                                                            Boolean showClicked,
                                                                            Boolean showAbuse,
                                                                            Boolean showUnsubscribed,
                                                                            Boolean showErrors,
                                                                            Boolean showMessageIDs)
                                                                     throws ApiException

Get email batch status

Parameters:

transactionid - Transaction identifier (required)

showFailed - Include Bounced email addresses. (optional, default to False)

showSent - Include Sent email addresses. (optional, default to False)

showDelivered - Include all delivered email addresses. (optional, default to False)

showPending - Include Ready to send email addresses. (optional, default to False)

showOpened - Include Opened email addresses. (optional, default to False)

showClicked - Include Clicked email addresses. (optional, default to False)

showAbuse - Include Reported as abuse email addresses. (optional, default to False)

showUnsubscribed - Include Unsubscribed email addresses. (optional, default to False)

showErrors - Include error messages for bounced emails. (optional, default to False)

showMessageIDs - Include all MessageIDs for this transaction (optional, default to False)

Returns:

ApiResponse<EmailJobStatus>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

emailsTransactionidStatusGetAsync

public com.squareup.okhttp.Call emailsTransactionidStatusGetAsync(String transactionid,
                                                                  Boolean showFailed,
                                                                  Boolean showSent,
                                                                  Boolean showDelivered,
                                                                  Boolean showPending,
                                                                  Boolean showOpened,
                                                                  Boolean showClicked,
                                                                  Boolean showAbuse,
                                                                  Boolean showUnsubscribed,
                                                                  Boolean showErrors,
                                                                  Boolean showMessageIDs,
                                                                  ApiCallback<EmailJobStatus> callback)
                                                           throws ApiException

Get email batch status (asynchronously)

Parameters:

transactionid - Transaction identifier (required)

showFailed - Include Bounced email addresses. (optional, default to False)

showSent - Include Sent email addresses. (optional, default to False)

showDelivered - Include all delivered email addresses. (optional, default to False)

showPending - Include Ready to send email addresses. (optional, default to False)

showOpened - Include Opened email addresses. (optional, default to False)

showClicked - Include Clicked email addresses. (optional, default to False)

showAbuse - Include Reported as abuse email addresses. (optional, default to False)

showUnsubscribed - Include Unsubscribed email addresses. (optional, default to False)

showErrors - Include error messages for bounced emails. (optional, default to False)

showMessageIDs - Include all MessageIDs for this transaction (optional, default to False)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object