com.infobip.api

Class SendEmailApi

java.lang.Object

com.infobip.api.SendEmailApi

public class SendEmailApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SendEmailApi.APIsendEmailRequest

Constructor Summary

Constructors

Constructor and Description
SendEmailApi()
SendEmailApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
EmailReportsResult	getEmailDeliveryReports(String bulkId, String messageId, Integer limit) Email delivery reports.
okhttp3.Call	getEmailDeliveryReportsAsync(String bulkId, String messageId, Integer limit, ApiCallback<EmailReportsResult> _callback) Email delivery reports (asynchronously).
okhttp3.Call	getEmailDeliveryReportsCall(String bulkId, String messageId, Integer limit, ApiCallback _callback) Build call for getEmailDeliveryReports.
ApiResponse<EmailReportsResult>	getEmailDeliveryReportsWithHttpInfo(String bulkId, String messageId, Integer limit) Email delivery reports.
EmailLogsResponse	getEmailLogs(List<String> messageId, String from, String to, String bulkId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit) Get email logs.
okhttp3.Call	getEmailLogsAsync(List<String> messageId, String from, String to, String bulkId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit, ApiCallback<EmailLogsResponse> _callback) Get email logs (asynchronously).
okhttp3.Call	getEmailLogsCall(List<String> messageId, String from, String to, String bulkId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit, ApiCallback _callback) Build call for getEmailLogs.
ApiResponse<EmailLogsResponse>	getEmailLogsWithHttpInfo(List<String> messageId, String from, String to, String bulkId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit) Get email logs.
SendEmailApi.APIsendEmailRequest	sendEmail(String from, String to, String subject) Send fully featured email.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SendEmailApi

public SendEmailApi()

SendEmailApi

public SendEmailApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getEmailDeliveryReportsCall

public okhttp3.Call getEmailDeliveryReportsCall(String bulkId,
                                                String messageId,
                                                Integer limit,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getEmailDeliveryReports.

Parameters:

bulkId - Bulk ID for which report is requested. (optional)

messageId - The ID that uniquely identifies the sent email. (optional)

limit - Maximum number of reports. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getEmailDeliveryReports

public EmailReportsResult getEmailDeliveryReports(String bulkId,
                                                  String messageId,
                                                  Integer limit)
                                           throws ApiException

Email delivery reports. Get one-time delivery reports for all sent emails.

Parameters:

bulkId - Bulk ID for which report is requested. (optional)

messageId - The ID that uniquely identifies the sent email. (optional)

limit - Maximum number of reports. (optional)

Returns:

EmailReportsResult

Throws:

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

getEmailDeliveryReportsWithHttpInfo

public ApiResponse<EmailReportsResult> getEmailDeliveryReportsWithHttpInfo(String bulkId,
                                                                           String messageId,
                                                                           Integer limit)
                                                                    throws ApiException

Email delivery reports. Get one-time delivery reports for all sent emails.

Parameters:

bulkId - Bulk ID for which report is requested. (optional)

messageId - The ID that uniquely identifies the sent email. (optional)

limit - Maximum number of reports. (optional)

Returns:

ApiResponse<EmailReportsResult>

Throws:

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

getEmailDeliveryReportsAsync

public okhttp3.Call getEmailDeliveryReportsAsync(String bulkId,
                                                 String messageId,
                                                 Integer limit,
                                                 ApiCallback<EmailReportsResult> _callback)
                                          throws ApiException

Email delivery reports (asynchronously). Get one-time delivery reports for all sent emails.

Parameters:

bulkId - Bulk ID for which report is requested. (optional)

messageId - The ID that uniquely identifies the sent email. (optional)

limit - Maximum number of reports. (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

getEmailLogsCall

public okhttp3.Call getEmailLogsCall(List<String> messageId,
                                     String from,
                                     String to,
                                     String bulkId,
                                     String generalStatus,
                                     OffsetDateTime sentSince,
                                     OffsetDateTime sentUntil,
                                     Integer limit,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getEmailLogs.

Parameters:

messageId - The ID that uniquely identifies the sent email. (optional)

from - (optional, default to )

to - (optional, default to )

bulkId - (optional, default to )

generalStatus - (optional, default to )

sentSince - (optional)

sentUntil - (optional)

limit - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getEmailLogs

public EmailLogsResponse getEmailLogs(List<String> messageId,
                                      String from,
                                      String to,
                                      String bulkId,
                                      String generalStatus,
                                      OffsetDateTime sentSince,
                                      OffsetDateTime sentUntil,
                                      Integer limit)
                               throws ApiException

Get email logs. This method allows you to get email logs of sent Email messagesId for request. Email logs are available for the last 48 hours!

Parameters:

messageId - The ID that uniquely identifies the sent email. (optional)

from - (optional, default to )

to - (optional, default to )

bulkId - (optional, default to )

generalStatus - (optional, default to )

sentSince - (optional)

sentUntil - (optional)

limit - (optional)

Returns:

EmailLogsResponse

Throws:

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

getEmailLogsWithHttpInfo

public ApiResponse<EmailLogsResponse> getEmailLogsWithHttpInfo(List<String> messageId,
                                                               String from,
                                                               String to,
                                                               String bulkId,
                                                               String generalStatus,
                                                               OffsetDateTime sentSince,
                                                               OffsetDateTime sentUntil,
                                                               Integer limit)
                                                        throws ApiException

Get email logs. This method allows you to get email logs of sent Email messagesId for request. Email logs are available for the last 48 hours!

Parameters:

messageId - The ID that uniquely identifies the sent email. (optional)

from - (optional, default to )

to - (optional, default to )

bulkId - (optional, default to )

generalStatus - (optional, default to )

sentSince - (optional)

sentUntil - (optional)

limit - (optional)

Returns:

ApiResponse<EmailLogsResponse>

Throws:

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

getEmailLogsAsync

public okhttp3.Call getEmailLogsAsync(List<String> messageId,
                                      String from,
                                      String to,
                                      String bulkId,
                                      String generalStatus,
                                      OffsetDateTime sentSince,
                                      OffsetDateTime sentUntil,
                                      Integer limit,
                                      ApiCallback<EmailLogsResponse> _callback)
                               throws ApiException

Get email logs (asynchronously). This method allows you to get email logs of sent Email messagesId for request. Email logs are available for the last 48 hours!

Parameters:

messageId - The ID that uniquely identifies the sent email. (optional)

from - (optional, default to )

to - (optional, default to )

bulkId - (optional, default to )

generalStatus - (optional, default to )

sentSince - (optional)

sentUntil - (optional)

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

sendEmail

public SendEmailApi.APIsendEmailRequest sendEmail(String from,
                                                  String to,
                                                  String subject)

Send fully featured email. Send an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled.

Parameters:

from - Email address with optional sender name. (required)

to - Email address of the recipient. (required)

subject - Message subject. (required)

Returns:

APIsendEmailRequest +

See Also:

Learn more about Email channel and use cases.