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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Emailer.EmailSendTask
protected static class	Emailer.MessagePersistingContext

Field Summary

Fields

Modifier and Type	Field and Description
protected Authentication	authentication
protected static java.lang.String	BODY_FILE_EXTENSION
protected java.util.concurrent.atomic.AtomicInteger	callCount
protected EmailerConfig	config
protected EmailSenderAPI	emailSender
protected FileStorageAPI	fileStorage
protected org.springframework.core.task.TaskExecutor	mailSendTaskExecutor
protected Metadata	metadata
protected Persistence	persistence
protected Resources	resources
protected TimeSource	timeSource
protected UserSessionSource	userSessionSource

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
protected boolean	applicationNotStartedYet()
protected java.lang.String	bodyTextFromByteArray(byte[] bodyContent)
protected byte[]	bodyTextToBytes(SendingMessage message)
protected SendingMessage	convertToSendingMessage(java.lang.String address, java.lang.String from, java.lang.String cc, java.lang.String bcc, java.lang.String caption, java.lang.String body, java.lang.String bodyContentType, java.util.List<EmailHeader> headers, EmailAttachment[] attachments, java.lang.Integer attemptsCount, java.util.Date deadline)
protected FileDescriptor	createAttachmentFileDescriptor(SendingAttachment attachment)
protected FileDescriptor	createBodyFileDescriptor(SendingMessage message, byte[] bodyBytes)
protected SendingMessage	createClone(SendingMessage srcMessage)
protected java.lang.String	getContentBodyType(SendingMessage sendingMessage)
protected java.lang.String	getEmailerLogin()
protected boolean	isNeedToRetry(java.lang.Exception e)
protected void	loadBodyAndAttachments(SendingMessage message)
java.lang.String	loadContentText(SendingMessage sendingMessage) Loads content text for given message.
protected java.util.List<SendingMessage>	loadEmailsToSend()
protected void	markAsNonSent(SendingMessage sendingMessage)
protected void	markAsSent(SendingMessage sendingMessage)
protected void	migrateAttachment(EntityManager em, SendingAttachment attachment)
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.
protected void	migrateMessage(EntityManager em, SendingMessage msg)
protected void	persistAndSendEmail(EmailInfo emailInfo)
protected SendingMessage	persistMessageIfPossible(SendingMessage sendingMessage)
protected void	persistMessages(java.util.List<SendingMessage> sendingMessageList, SendingStatus status)
protected void	persistSendingMessage(EntityManager em, SendingMessage message, Emailer.MessagePersistingContext context)
protected void	prepareEmailInfo(EmailInfo emailInfo)
protected void	processBodyTemplate(EmailInfo info)
java.lang.String	processQueuedEmails() Send emails added to the queue.
protected void	removeOrphanFiles(Emailer.MessagePersistingContext context)
protected void	replaceRecipientIfNecessary(SendingMessage msg)
protected void	returnToQueue(SendingMessage sendingMessage)
void	sendEmail(EmailInfo info) Send email synchronously.
void	sendEmail(java.lang.String addresses, java.lang.String caption, java.lang.String body, EmailAttachment... attachments) Use EmailerAPI.sendEmail(EmailInfo) instead.
void	sendEmail(java.lang.String addresses, java.lang.String caption, java.lang.String body, java.lang.String bodyContentType, EmailAttachment... attachments) Use EmailerAPI.sendEmail(EmailInfo) instead.
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.
protected java.lang.String	sendQueuedEmails()
protected void	sendSendingMessage(SendingMessage sendingMessage)
void	setConfig(Configuration configuration)
protected boolean	shouldMarkNotSent(SendingMessage sendingMessage)
protected java.util.List<SendingMessage>	splitEmail(EmailInfo info, java.lang.Integer attemptsCount, java.util.Date deadline)
protected void	submitExecutorTask(SendingMessage msg)
protected SendingAttachment	toSendingAttachment(EmailAttachment ea)
void	updateSession() Updates Properties for JavaMail Session

Methods inherited from class java.lang.Object

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

Field Detail

BODY_FILE_EXTENSION

protected static final java.lang.String BODY_FILE_EXTENSION

See Also:

Constant Field Values

config

protected EmailerConfig config

callCount

protected java.util.concurrent.atomic.AtomicInteger callCount

mailSendTaskExecutor

protected org.springframework.core.task.TaskExecutor mailSendTaskExecutor

userSessionSource

@Inject
protected UserSessionSource userSessionSource

timeSource

@Inject
protected TimeSource timeSource

persistence

@Inject
protected Persistence persistence

metadata

@Inject
protected Metadata metadata

authentication

@Inject
protected Authentication authentication

emailSender

@Inject
protected EmailSenderAPI emailSender

resources

@Inject
protected Resources resources

fileStorage

@Inject
protected FileStorageAPI fileStorage

Constructor Detail

Emailer

public Emailer()

Method Detail

setConfig

@Inject
public void setConfig(Configuration configuration)

getEmailerLogin

protected java.lang.String getEmailerLogin()

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

Use EmailerAPI.sendEmail(EmailInfo) instead.

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(java.lang.String addresses,
                      java.lang.String caption,
                      java.lang.String body,
                      java.lang.String bodyContentType,
                      EmailAttachment... attachments)
               throws EmailException

Description copied from interface: EmailerAPI

Use EmailerAPI.sendEmail(EmailInfo) instead.

Send email synchronously.

Specified by:

sendEmail in interface EmailerAPI

Parameters:

addresses - comma or semicolon separated list of addresses

caption - email subject

body - email body

bodyContentType - email body like "text/plain; charset=UTF-8" or "text/html; charset=UTF-8", etc

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

prepareEmailInfo

protected void prepareEmailInfo(EmailInfo emailInfo)

processBodyTemplate

protected void processBodyTemplate(EmailInfo info)

splitEmail

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

sendSendingMessage

protected void sendSendingMessage(SendingMessage sendingMessage)

persistAndSendEmail

protected void persistAndSendEmail(EmailInfo emailInfo)
                            throws EmailException

Throws:

EmailException

persistMessageIfPossible

@Nullable
protected SendingMessage persistMessageIfPossible(SendingMessage sendingMessage)

createClone

protected SendingMessage createClone(SendingMessage srcMessage)

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

applicationNotStartedYet

protected boolean applicationNotStartedYet()

sendQueuedEmails

protected java.lang.String sendQueuedEmails()

shouldMarkNotSent

protected boolean shouldMarkNotSent(SendingMessage sendingMessage)

submitExecutorTask

protected void submitExecutorTask(SendingMessage msg)

loadEmailsToSend

protected java.util.List<SendingMessage> loadEmailsToSend()

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

updateSession

public void updateSession()

Description copied from interface: EmailerAPI

Updates Properties for JavaMail Session

Specified by:

updateSession in interface EmailerAPI

loadBodyAndAttachments

protected void loadBodyAndAttachments(SendingMessage message)

persistMessages

protected void persistMessages(java.util.List<SendingMessage> sendingMessageList,
                               SendingStatus status)

removeOrphanFiles

protected void removeOrphanFiles(Emailer.MessagePersistingContext context)

persistSendingMessage

protected void persistSendingMessage(EntityManager em,
                                     SendingMessage message,
                                     Emailer.MessagePersistingContext context)
                              throws FileStorageException

Throws:

FileStorageException

createAttachmentFileDescriptor

protected FileDescriptor createAttachmentFileDescriptor(SendingAttachment attachment)

createBodyFileDescriptor

protected FileDescriptor createBodyFileDescriptor(SendingMessage message,
                                                  byte[] bodyBytes)

returnToQueue

protected void returnToQueue(SendingMessage sendingMessage)

markAsSent

protected void markAsSent(SendingMessage sendingMessage)

markAsNonSent

protected void markAsNonSent(SendingMessage sendingMessage)

convertToSendingMessage

protected SendingMessage convertToSendingMessage(java.lang.String address,
                                                 java.lang.String from,
                                                 java.lang.String cc,
                                                 java.lang.String bcc,
                                                 java.lang.String caption,
                                                 java.lang.String body,
                                                 java.lang.String bodyContentType,
                                                 @Nullable
                                                 java.util.List<EmailHeader> headers,
                                                 @Nullable
                                                 EmailAttachment[] attachments,
                                                 @Nullable
                                                 java.lang.Integer attemptsCount,
                                                 @Nullable
                                                 java.util.Date deadline)

getContentBodyType

protected java.lang.String getContentBodyType(SendingMessage sendingMessage)

replaceRecipientIfNecessary

protected void replaceRecipientIfNecessary(SendingMessage msg)

toSendingAttachment

protected SendingAttachment toSendingAttachment(EmailAttachment ea)

bodyTextToBytes

protected byte[] bodyTextToBytes(SendingMessage message)

bodyTextFromByteArray

protected java.lang.String bodyTextFromByteArray(byte[] bodyContent)

isNeedToRetry

protected boolean isNeedToRetry(java.lang.Exception e)

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

migrateMessage

protected void migrateMessage(EntityManager em,
                              SendingMessage msg)

migrateAttachment

protected void migrateAttachment(EntityManager em,
                                 SendingAttachment attachment)