org.cyclos.impl.utils.notifications

Interface MailHandler

public interface MailHandler

A service that sends e-mails.

Author:

luis, ameyer

Method Summary

Modifier and Type	Method and Description
java.lang.String	applyTemplate(org.cyclos.impl.utils.notifications.ApplyMailTemplateParams params) Applies the configured e-mail template.
org.springframework.mail.javamail.JavaMailSender	getMailSender() Returns a JavaMailSender for the current configuration
org.springframework.mail.javamail.JavaMailSender	getMailSender(Configuration configuration) Returns a JavaMailSender for the given configuration
void	send(BasicUser from, BasicUser to, org.cyclos.impl.utils.notifications.MailContentProducer producer) Calls the method send(BasicUser, BasicUser, MailContext, MailContentProducer) passing null as MailContext
void	send(BasicUser from, BasicUser to, MailContext context, org.cyclos.impl.utils.notifications.MailContentProducer producer) Creates a new mail pending to be sent by MailProcessingPollingTask.
void	send(java.lang.String toName, java.lang.String toEmail, java.lang.String subject, java.lang.String body) Sends a new mail with the given information.

Method Detail

applyTemplate

java.lang.String applyTemplate(org.cyclos.impl.utils.notifications.ApplyMailTemplateParams params)

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.

getMailSender

org.springframework.mail.javamail.JavaMailSender getMailSender()

Returns a JavaMailSender for the current configuration

getMailSender

org.springframework.mail.javamail.JavaMailSender getMailSender(Configuration configuration)

Returns a JavaMailSender for the given configuration

send

void send(BasicUser from,
          BasicUser to,
          org.cyclos.impl.utils.notifications.MailContentProducer producer)

Calls the method send(BasicUser, BasicUser, MailContext, MailContentProducer) passing null as MailContext

send

void send(BasicUser from,
          BasicUser to,
          MailContext context,
          org.cyclos.impl.utils.notifications.MailContentProducer producer)

Creates a new 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

send

void send(java.lang.String toName,
          java.lang.String toEmail,
          java.lang.String subject,
          java.lang.String body)

Sends a new mail with the given information.

Parameters:

toName - Name of the receiver.

toEmail - Email of the receiver.

subject - Subject of the mail

body - Body of the mail