Package org.cyclos.impl.utils.notifications

Class MailHandlerImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseNetworkedHandlerImpl

org.cyclos.impl.utils.notifications.MailHandlerImpl

All Implemented Interfaces:

MailHandler, MailHandlerImplementor

public class MailHandlerImpl
extends BaseNetworkedHandlerImpl
implements MailHandlerImplementor

Implementation for MailHandler

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
MailHandlerImpl()

Method Summary

Modifier and Type	Method	Description
String	applyTemplate(ApplyMailTemplateParams params)	Applies the configured e-mail template.
MailProcessingContext	createMailProcessingContext(String toName, String toEmail, String subject, String body, ConfigurationAccessor configurationAccessor, FileInfo... attachments)	Returns the context for sending an e-mail with the given information.
protected MailProcessingContext	createMailProcessingContext(BasicUser from, BasicUser to, MailContext context, MailContentProducer producer, FileInfo... attachments)	Creates the context to process the mail with the given information and makes some validations.
JavaMailSender	getMailSender()	Returns a JavaMailSender for the current configuration
JavaMailSender	getMailSender(Configuration configuration)	Returns a JavaMailSender for the given configuration
JavaMailSender	getMailSender(ConfigurationAccessor configuration)	Returns a JavaMailSender for the given configuration accessor
protected void	processMailProcessingContext(MailProcessingContext mail)
void	send(String toName, String toEmail, String subject, String body, FileInfo... attachments)	Sends a new e-mail with the given information.
void	send(BasicUser from, BasicUser to, MailContext context, MailContentProducer producer, FileInfo... attachments)	Creates a new e-mail pending to be sent by MailProcessingPollingTask. If context is FORWARD_INTERNAL_MESSAGE: The "From name" of the message will be the name of the given from user The "From address" of the message will be the one declared in the configuration of the given from user. The "Reply-to address" of the message will be the address of the given from user. If context is NEW_EMAIL_VALIDATION: The "To address" will be the new email
boolean	sendNow(MailProcessingContext mail, JavaMailSender mailSender)	Actually send the e-mail

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

MailHandlerImpl

public MailHandlerImpl()

Method Detail

applyTemplate

public String applyTemplate(ApplyMailTemplateParams params)

Description copied from interface: MailHandler

Applies the configured e-mail template. Variables in the form {name} are replaced. All profile field variables are supported (see ProfileFieldHandler#getProfileFieldVariables(BasicUser)), plus others, such as: subject, message, salutation, unsubscribe, applicationName, date, dateTime, day, month and year.

Specified by:

applyTemplate in interface MailHandler

createMailProcessingContext

public MailProcessingContext createMailProcessingContext(String toName,
                                                         String toEmail,
                                                         String subject,
                                                         String body,
                                                         ConfigurationAccessor configurationAccessor,
                                                         FileInfo... attachments)

Description copied from interface: MailHandler

Returns the context for sending an e-mail with the given information.

Specified by:

createMailProcessingContext in interface MailHandler

Parameters:

toName - Name of the receiver.

toEmail - Email of the receiver.

subject - Subject of the e-mail

body - Body of the e-mail

configurationAccessor - The configuration accessor to get the from name/e-mail

attachments - The e-mail attachments

getMailSender

public JavaMailSender getMailSender()

Description copied from interface: MailHandler

Returns a JavaMailSender for the current configuration

Specified by:

getMailSender in interface MailHandler

getMailSender

public JavaMailSender getMailSender(Configuration configuration)

Description copied from interface: MailHandler

Returns a JavaMailSender for the given configuration

Specified by:

getMailSender in interface MailHandler

getMailSender

public JavaMailSender getMailSender(ConfigurationAccessor configuration)

Description copied from interface: MailHandler

Returns a JavaMailSender for the given configuration accessor

Specified by:

getMailSender in interface MailHandler

send

public void send(BasicUser from,
                 BasicUser to,
                 MailContext context,
                 MailContentProducer producer,
                 FileInfo... attachments)

Description copied from interface: MailHandler

Creates a new e-mail pending to be sent by MailProcessingPollingTask.
If context is FORWARD_INTERNAL_MESSAGE:

The "From name" of the message will be the name of the given from user The "From address" of the message will be the one declared in the configuration of the given from user. The "Reply-to address" of the message will be the address of the given from user. If context is NEW_EMAIL_VALIDATION: The "To address" will be the new email

Specified by:

send in interface MailHandler

send

public void send(String toName,
                 String toEmail,
                 String subject,
                 String body,
                 FileInfo... attachments)

Description copied from interface: MailHandler

Sends a new e-mail with the given information.

Specified by:

send in interface MailHandler

Parameters:

toName - Name of the receiver.

toEmail - Email of the receiver.

subject - Subject of the e-mail

body - Body of the e-mail

attachments - The e-mail attachments

sendNow

public boolean sendNow(MailProcessingContext mail,
                       JavaMailSender mailSender)

Description copied from interface: MailHandlerImplementor

Actually send the e-mail

Specified by:

sendNow in interface MailHandlerImplementor

Returns:

false means the email was not send because an error has occurred otherwise true

createMailProcessingContext

protected MailProcessingContext createMailProcessingContext(BasicUser from,
                                                            BasicUser to,
                                                            MailContext context,
                                                            MailContentProducer producer,
                                                            FileInfo... attachments)

Creates the context to process the mail with the given information and makes some validations.

processMailProcessingContext

protected void processMailProcessingContext(MailProcessingContext mail)