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

Interface EmailSender

All Known Implementing Classes:

FreeMarkerEmailSender

public interface EmailSender

An interface that defines how emails can be sent out from the application.

Author:

hrathod

Method Summary

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

Method Detail

sendVerificationMessage

void sendVerificationMessage(UserEntity user)
                      throws EmailException

Send a verification email to the user. The verification email contains a link which the user can click to verify their registration with the application.

Parameters:

user - To whom the email should be sent.

Throws:

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

sendActivationMessage

void sendActivationMessage(UserEntity user)
                    throws EmailException

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.

Parameters:

user - To whom the email should be sent.

Throws:

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

sendPasswordChangeMessage

void sendPasswordChangeMessage(UserEntity user)
                        throws EmailException

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

Parameters:

user - To whom the email should be sent.

Throws:

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

sendPasswordResetMessage

void sendPasswordResetMessage(UserEntity user,
                              String newPassword)
                       throws EmailException

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.

Parameters:

user - The user who is requesting the password reset.

newPassword - The new password, before hashing.

Throws:

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