com.haulmont.cuba.core.app

Class Emailer

java.lang.Object

com.haulmont.cuba.core.app.Emailer

All Implemented Interfaces:

EmailerAPI

Direct Known Subclasses:

TestEmailer

@Component(value="cuba_Emailer")
public class Emailer
extends java.lang.Object
implements EmailerAPI

Field Summary

Fields inherited from interface com.haulmont.cuba.core.app.EmailerAPI

NAME

Constructor Summary

Constructors

Constructor and Description
Emailer()

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 addresses, 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.
void	setConfig(Configuration configuration)

Methods inherited from class java.lang.Object

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

Constructor Detail

Emailer

public Emailer()

Method Detail

setConfig

@Inject
public void setConfig(Configuration configuration)

sendEmail

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

Description copied from interface: EmailerAPI

Send email synchronously.

Specified by:

sendEmail in interface EmailerAPI

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

body - email body

attachments - email attachments

Throws:

EmailException - in case of any errors

sendEmail

public void sendEmail(EmailInfo info)
               throws EmailException

Description copied from interface: EmailerAPI

Send email synchronously.

Specified by:

sendEmail in interface EmailerAPI

Parameters:

info - email details

Throws:

EmailException - in case of any errors

sendEmailAsync

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

Description copied from interface: EmailerAPI

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 EmailerAPI.processQueuedEmails() method which should be invoked by a scheduled task.

Specified by:

sendEmailAsync in interface EmailerAPI

Parameters:

info - email details

Returns:

list of created SendingMessages

sendEmailAsync

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

Description copied from interface: EmailerAPI

Send email asynchronously, with limited number of attempts.

Specified by:

sendEmailAsync in interface EmailerAPI

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

processQueuedEmails

public java.lang.String processQueuedEmails()

Description copied from interface: EmailerAPI

Send emails added to the queue.

This method should be called periodically from a scheduled task.

Specified by:

processQueuedEmails in interface EmailerAPI

Returns:

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

loadContentText

public java.lang.String loadContentText(SendingMessage sendingMessage)

Description copied from interface: EmailerAPI

Loads content text for given message.

Specified by:

loadContentText in interface EmailerAPI

Returns:

email content text

migrateEmailsToFileStorage

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

Description copied from interface: EmailerAPI

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

Specified by:

migrateEmailsToFileStorage in interface EmailerAPI

migrateAttachmentsToFileStorage

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

Description copied from interface: EmailerAPI

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

Specified by:

migrateAttachmentsToFileStorage in interface EmailerAPI