com.haulmont.cuba.core.app

Interface EmailerAPI

All Known Implementing Classes:

Emailer, TestEmailer

public interface EmailerAPI

Provides application with emailing functionality.
Sending email can be synchronous (caller's thread is blocked until email is delivered to SMTP server) or asynchronous (email is persisted in a DB queue and sent later by scheduled task).
In order to send emails asynchronously, you should register a scheduled task that periodically invokes processQueuedEmails() method.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	loadContentText(SendingMessage sendingMessage) Loads content text for given message.
void	migrateAttachmentsToFileStorage(java.util.List<SendingAttachment> attachments) Migrate list of existing email attachments to be stored in file storage, in a single transaction.
void	migrateEmailsToFileStorage(java.util.List<SendingMessage> messages) Migrate list of existing messages to be stored in file storage, in a single transaction.
java.lang.String	processQueuedEmails() Send emails added to the queue.
void	sendEmail(EmailInfo info) Send email synchronously.
void	sendEmail(java.lang.String address, java.lang.String caption, java.lang.String body, EmailAttachment... attachments) Send email synchronously.
java.util.List<SendingMessage>	sendEmailAsync(EmailInfo info) Send email asynchronously.
java.util.List<SendingMessage>	sendEmailAsync(EmailInfo info, java.lang.Integer attemptsCount, java.util.Date deadline) Send email asynchronously, with limited number of attempts.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

sendEmail

void sendEmail(java.lang.String address,
               java.lang.String caption,
               java.lang.String body,
               EmailAttachment... attachments)
        throws EmailException

Send email synchronously.

Parameters:

address - comma or semicolon separated list of addresses

caption - email subject

body - email body

attachments - email attachments

Throws:

EmailException - in case of any errors

sendEmail

void sendEmail(EmailInfo info)
        throws EmailException

Send email synchronously.

Parameters:

info - email details

Throws:

EmailException - in case of any errors

sendEmailAsync

java.util.List<SendingMessage> sendEmailAsync(EmailInfo info,
                                              @Nullable
                                              java.lang.Integer attemptsCount,
                                              @Nullable
                                              java.util.Date deadline)

Send email asynchronously, with limited number of attempts.

Parameters:

info - email details

attemptsCount - count of attempts to send (1 attempt per scheduler tick). If not specified, EmailerConfig.getDefaultSendingAttemptsCount() is used

deadline - Emailer tries to send message till deadline. If deadline has come and message has not been sent, status of this message is changed to SendingStatus.NOTSENT

Returns:

list of created SendingMessages

sendEmailAsync

java.util.List<SendingMessage> sendEmailAsync(EmailInfo info)

Send email asynchronously.

This method creates a list of SendingMessage instances, saves it to the database and returns immediately. The actual sending is performed by the processQueuedEmails() method which should be invoked by a scheduled task.

Parameters:

info - email details

Returns:

list of created SendingMessages

processQueuedEmails

java.lang.String processQueuedEmails()

Send emails added to the queue.

This method should be called periodically from a scheduled task.

Returns:

short message describing how many emails were sent, or error message

migrateEmailsToFileStorage

void migrateEmailsToFileStorage(java.util.List<SendingMessage> messages)

Migrate list of existing messages to be stored in file storage, in a single transaction.

migrateAttachmentsToFileStorage

void migrateAttachmentsToFileStorage(java.util.List<SendingAttachment> attachments)

Migrate list of existing email attachments to be stored in file storage, in a single transaction.

loadContentText

java.lang.String loadContentText(SendingMessage sendingMessage)

Loads content text for given message.

Returns:

email content text