edu.emory.cci.aiw.cvrg.eureka.services.email

Class FreeMarkerEmailSender

java.lang.Object

edu.emory.cci.aiw.cvrg.eureka.services.email.FreeMarkerEmailSender

All Implemented Interfaces:

EmailSender

public class FreeMarkerEmailSender
extends Object
implements EmailSender

Implements the EmailSender interface with FreeMarker templates.

Author:

hrathod

Constructor Summary

Constructors

Constructor and Description
FreeMarkerEmailSender(ServiceProperties inServiceProperties, javax.mail.Session inSession) Default constructor, creates a FreeMarker configuration object.

Method Summary

Modifier and Type	Method and Description
void	sendActivationMessage(UserEntity inUser) Send an activation email to the user.
void	sendPasswordChangeMessage(UserEntity inUser) Send a password change email to the user.
void	sendPasswordResetMessage(UserEntity inUser, String inNewPassword) Send a password reset email to the user.
void	sendVerificationMessage(UserEntity inUser) Sends a verification email.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeMarkerEmailSender

@Inject
public FreeMarkerEmailSender(ServiceProperties inServiceProperties,
                                     javax.mail.Session inSession)

Default constructor, creates a FreeMarker configuration object. Should be called in the context of a request.

Parameters:

inServiceProperties - The application configuration object.

inSession - The mail session to use when sending a message.

Method Detail

sendVerificationMessage

public void sendVerificationMessage(UserEntity inUser)
                             throws EmailException

Sends a verification email.

Specified by:

sendVerificationMessage in interface EmailSender

Parameters:

inUser - The user to verify.

Throws:

EmailException

sendActivationMessage

public void sendActivationMessage(UserEntity inUser)
                           throws EmailException

Description copied from interface: EmailSender

Send an activation email to the user. The activation email is sent after the user has verified their identity, and as the system administrator is activating the account for use.

Specified by:

sendActivationMessage in interface EmailSender

Parameters:

inUser - To whom the email should be sent.

Throws:

EmailException - Thrown if the email can not be sent for any reason.

sendPasswordChangeMessage

public void sendPasswordChangeMessage(UserEntity inUser)
                               throws EmailException

Description copied from interface: EmailSender

Send a password change email to the user. The password change email is sent any time a user changes their password.

Specified by:

sendPasswordChangeMessage in interface EmailSender

Parameters:

inUser - To whom the email should be sent.

Throws:

EmailException - Thrown if the email can not be properly sent.

sendPasswordResetMessage

public void sendPasswordResetMessage(UserEntity inUser,
                                     String inNewPassword)
                              throws EmailException

Description copied from interface: EmailSender

Send a password reset email to the user. The password reset email is sent when a user forgets his or her password, and asks the system to reset it.

Specified by:

sendPasswordResetMessage in interface EmailSender

Parameters:

inUser - The user who is requesting the password reset.

inNewPassword - The new password, before hashing.

Throws:

EmailException - Thrown if the email can not be sent for any reason.