uk.ac.ed.epcc.webapp.email

Class Emailer

java.lang.Object

uk.ac.ed.epcc.webapp.email.Emailer

public class Emailer
extends java.lang.Object

Emailer Class that sends emails. all emails sent by the Web-app are funneled through this class so we can enforce debugging modes that allow us to debug with a copy of the main database without sending spurious emails to users. All dependencies on javax.mail are also routed through this class to reduce dependencies. We could implement encrypted emails or crytographic signing here if we wanted.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Emailer.PasswordAuth
static class	Emailer.SendAction

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	DEBUG_SEND
static java.lang.String	DEFAULT_ENCODING Default string encoding to use.
static java.lang.String	EMAIL_BYPASS_FORCE_ADDRESS
static Feature	EMAIL_DEFERRED_SEND
static java.lang.String	EMAIL_FORCE_ADDRESS
static java.lang.String	EMAIL_FROM_ADDRESS
static java.lang.String	EMAIL_FROM_NAME
static Feature	EMAILS_FEATURE
static Feature	HTML_ALTERNATIVE
static Feature	PASSWORD_RESET_SERVLET
static java.lang.String	SUPRESS_EMAIL_ATTR Name of an AppContext attribute to supress emails from the current request.

Constructor Summary

Constructors

Constructor and Description
Emailer(AppContext c)

Method Summary

Modifier and Type	Method and Description
static boolean	checkAddress(java.lang.String email) check the validity of an Email address
static boolean	checkAddressList(java.lang.String list)
void	doSend(MimeMessage m) Send the message This might use the CleanupService to send at the end of a transaction
MimeMessage	doSendNow(MimeMessage m) Send the message now.
static void	errorEmail(AppContext conn, Logger log, java.lang.String subject, java.lang.String text) General email error report
static void	errorEmail(AppContext conn, Logger log, java.lang.Throwable e, java.util.Map props, java.lang.String additional_info) Send an error email This is called within EmailLogger so logging should always go through the provided logger.
protected AppContext	getContext()
java.lang.String	getEmail(AppUser recipient)
java.lang.String	getEncoding()
Logger	getLogger()
protected Session	getSession()
static Session	getSession(AppContext conn)
static void	infoEmail(AppContext conn, java.lang.String text) General email information report
MimeMessage	makeBlankEmail(AppContext conn, java.lang.String[] notify_emails, InternetAddress from, java.lang.String subject) make a blank email as a starting point
java.lang.String	mapRecipients(java.lang.String sendto)
static boolean	needsEncoding(java.lang.String subject) should we specify an encoding for the string
void	newEmailRequest(AppUser person, EmailChangeRequestFactory.EmailChangeRequest req) Send an email requesting confirmation of a new Email address.
void	newPassword(AppUser person, PasswordAuthComposite comp) Send an email with the person new password
void	newRemoteHostLogin(AppUser person, java.lang.String host)
void	newSignup(AppUser person, java.lang.String new_password)
void	notificationEmail(AppUser person, java.util.Set<java.lang.String> notices)
static java.util.Set<InternetAddress>	parseEmailList(java.lang.String list)
void	passwordChanged(AppUser person) Notify user their password has been changed.
void	passwordFailsExceeded(AppUser person) Notify user their password has been locked-out.
static java.lang.String[]	splitEmailList(java.lang.String list)
boolean	supressSend(Address a)
void	templateEmail(java.lang.String[] notify_emails, TemplateFile email_template) send an email from a template file to multiple recipients
MimeMessage	templateMessage(AppUser recipient, java.util.Hashtable headers, TemplateFile email_template)
MimeMessage	templateMessage(AppUser recipient, TemplateFile email_template) Send an email based on a template file to a AppUser
MimeMessage	templateMessage(java.lang.String[] notify_emails, java.util.Hashtable headers, InternetAddress from, boolean multipart, TemplateFile email_template)
MimeMessage	templateMessage(java.lang.String[] notify_emails, java.util.Hashtable headers, TemplateFile email_template) make an email from a template file to multiple recipients with custom headers
MimeMessage	templateMessage(java.lang.String[] notify_emails, java.lang.String header_prefix, java.util.Hashtable headers, InternetAddress from, boolean multipart, TemplateFile email_template, java.util.Map<java.lang.String,java.lang.String> params)
MimeMessage	templateMessage(java.lang.String[] notify_emails, TemplateFile email_template) make an email from a template file to multiple recipients
MimeMessage	templateMessage(java.lang.String sendto, java.util.Hashtable h, TemplateFile email_template)
MimeMessage	templateMessage(java.lang.String sendto, java.util.Hashtable h, TemplateFile email_template, java.util.Map<java.lang.String,java.lang.String> params)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

Default string encoding to use.

See Also:

Constant Field Values

SUPRESS_EMAIL_ATTR

public static final java.lang.String SUPRESS_EMAIL_ATTR

Name of an AppContext attribute to supress emails from the current request.

See Also:

Constant Field Values

EMAIL_FROM_NAME

public static final java.lang.String EMAIL_FROM_NAME

See Also:

Constant Field Values

EMAIL_FROM_ADDRESS

public static final java.lang.String EMAIL_FROM_ADDRESS

See Also:

Constant Field Values

EMAIL_FORCE_ADDRESS

public static final java.lang.String EMAIL_FORCE_ADDRESS

See Also:

Constant Field Values

EMAIL_BYPASS_FORCE_ADDRESS

public static final java.lang.String EMAIL_BYPASS_FORCE_ADDRESS

See Also:

Constant Field Values

EMAILS_FEATURE

public static final Feature EMAILS_FEATURE

PASSWORD_RESET_SERVLET

public static final Feature PASSWORD_RESET_SERVLET

EMAIL_DEFERRED_SEND

public static final Feature EMAIL_DEFERRED_SEND

HTML_ALTERNATIVE

public static final Feature HTML_ALTERNATIVE

DEBUG_SEND

public static final Feature DEBUG_SEND

Constructor Detail

Emailer

public Emailer(AppContext c)

Method Detail

getContext

protected AppContext getContext()

newPassword

public void newPassword(AppUser person,
                        PasswordAuthComposite comp)
                 throws java.lang.Exception

Send an email with the person new password

Parameters:

person -

new_password -

Throws:

java.lang.Exception

newEmailRequest

public void newEmailRequest(AppUser person,
                            EmailChangeRequestFactory.EmailChangeRequest req)
                     throws java.lang.Exception

Send an email requesting confirmation of a new Email address.

Parameters:

person -

req -

Throws:

java.lang.Exception

newRemoteHostLogin

public void newRemoteHostLogin(AppUser person,
                               java.lang.String host)
                        throws java.lang.Exception

Throws:

java.lang.Exception

passwordChanged

public void passwordChanged(AppUser person)
                     throws java.lang.Exception

Notify user their password has been changed.

Parameters:

person -

new_password -

Throws:

java.lang.Exception

passwordFailsExceeded

public void passwordFailsExceeded(AppUser person)
                           throws java.lang.Exception

Notify user their password has been locked-out.

Parameters:

person -

new_password -

Throws:

java.lang.Exception

newSignup

public void newSignup(AppUser person,
                      java.lang.String new_password)
               throws java.lang.Exception

Throws:

java.lang.Exception

notificationEmail

public void notificationEmail(AppUser person,
                              java.util.Set<java.lang.String> notices)
                       throws java.lang.Exception

Throws:

java.lang.Exception

templateMessage

public MimeMessage templateMessage(java.lang.String sendto,
                                   java.util.Hashtable h,
                                   TemplateFile email_template)
                            throws java.io.IOException,
                                   MessagingException,
                                   InvalidArgument

Throws:

java.io.IOException

MessagingException

InvalidArgument

templateMessage

public MimeMessage templateMessage(java.lang.String sendto,
                                   java.util.Hashtable h,
                                   TemplateFile email_template,
                                   java.util.Map<java.lang.String,java.lang.String> params)
                            throws java.io.IOException,
                                   MessagingException,
                                   InvalidArgument

Throws:

java.io.IOException

MessagingException

InvalidArgument

mapRecipients

public java.lang.String mapRecipients(java.lang.String sendto)

getEmail

public java.lang.String getEmail(AppUser recipient)

templateMessage

public MimeMessage templateMessage(AppUser recipient,
                                   TemplateFile email_template)
                            throws java.io.IOException,
                                   MessagingException,
                                   InvalidArgument

Send an email based on a template file to a AppUser

Parameters:

sendto -

email_template -

Returns:

MimeMessage

Throws:

java.io.IOException

MessagingException

InvalidArgument

templateMessage

public MimeMessage templateMessage(AppUser recipient,
                                   java.util.Hashtable headers,
                                   TemplateFile email_template)
                            throws java.io.IOException,
                                   MessagingException,
                                   InvalidArgument

Throws:

java.io.IOException

MessagingException

InvalidArgument

supressSend

public boolean supressSend(Address a)

doSend

public void doSend(MimeMessage m)
            throws MessagingException

Send the message This might use the CleanupService to send at the end of a transaction

Parameters:

m -

Throws:

MessagingException

doSendNow

public MimeMessage doSendNow(MimeMessage m)
                      throws MessagingException

Send the message now. The sent message is returned so it can be logged.

Parameters:

m -

Returns:

Throws:

MessagingException

templateMessage

public MimeMessage templateMessage(java.lang.String[] notify_emails,
                                   java.util.Hashtable headers,
                                   TemplateFile email_template)
                            throws MessagingException,
                                   java.io.UnsupportedEncodingException,
                                   InvalidArgument

make an email from a template file to multiple recipients with custom headers

Parameters:

notify_emails - destination addresses

headers - Hashtable of extra header info

email_template - TemplateFile to sue to generate message

Returns:

MimeMessage sent

Throws:

java.io.UnsupportedEncodingException

MessagingException

InvalidArgument

templateMessage

public MimeMessage templateMessage(java.lang.String[] notify_emails,
                                   java.util.Hashtable headers,
                                   InternetAddress from,
                                   boolean multipart,
                                   TemplateFile email_template)
                            throws MessagingException,
                                   java.io.UnsupportedEncodingException,
                                   InvalidArgument

Throws:

MessagingException

java.io.UnsupportedEncodingException

InvalidArgument

templateMessage

public MimeMessage templateMessage(java.lang.String[] notify_emails,
                                   java.lang.String header_prefix,
                                   java.util.Hashtable headers,
                                   InternetAddress from,
                                   boolean multipart,
                                   TemplateFile email_template,
                                   java.util.Map<java.lang.String,java.lang.String> params)
                            throws MessagingException,
                                   java.io.UnsupportedEncodingException,
                                   InvalidArgument

Throws:

MessagingException

java.io.UnsupportedEncodingException

InvalidArgument

getEncoding

public java.lang.String getEncoding()

makeBlankEmail

public MimeMessage makeBlankEmail(AppContext conn,
                                  java.lang.String[] notify_emails,
                                  InternetAddress from,
                                  java.lang.String subject)
                           throws MessagingException,
                                  AddressException,
                                  java.io.UnsupportedEncodingException

make a blank email as a starting point

Parameters:

conn - AppContext

notify_emails -

from - Address to send from, may be blank

subject -

Returns:

Throws:

MessagingException

AddressException

java.io.UnsupportedEncodingException

getLogger

public Logger getLogger()

needsEncoding

public static boolean needsEncoding(java.lang.String subject)

should we specify an encoding for the string

Parameters:

subject -

Returns:

getSession

protected Session getSession()

Parameters:

conn -

log -

Returns:

getSession

public static Session getSession(AppContext conn)

templateEmail

public void templateEmail(java.lang.String[] notify_emails,
                          TemplateFile email_template)
                   throws java.io.UnsupportedEncodingException,
                          MessagingException,
                          InvalidArgument

send an email from a template file to multiple recipients

Parameters:

notify_emails -

email_template -

Throws:

java.io.UnsupportedEncodingException

MessagingException

InvalidArgument

templateMessage

public MimeMessage templateMessage(java.lang.String[] notify_emails,
                                   TemplateFile email_template)
                            throws java.io.UnsupportedEncodingException,
                                   MessagingException,
                                   InvalidArgument

make an email from a template file to multiple recipients

Parameters:

notify_emails -

email_template -

Returns:

message

Throws:

java.io.UnsupportedEncodingException

MessagingException

InvalidArgument

checkAddress

public static boolean checkAddress(java.lang.String email)

check the validity of an Email address

Parameters:

email - String containing address

Returns:

true if address parses ok

errorEmail

public static void errorEmail(AppContext conn,
                              Logger log,
                              java.lang.String subject,
                              java.lang.String text)

General email error report

Parameters:

conn -

text -

errorEmail

public static void errorEmail(AppContext conn,
                              Logger log,
                              java.lang.Throwable e,
                              java.util.Map props,
                              java.lang.String additional_info)
                       throws java.lang.Exception

Send an error email This is called within EmailLogger so logging should always go through the provided logger. We need to be careful to recover from errors if we can so that we can still send some email even if some things are failing

Parameters:

conn -

log - Logger (optional)

props -

e -

additional_info -

Throws:

java.lang.Exception

infoEmail

public static void infoEmail(AppContext conn,
                             java.lang.String text)

General email information report

Parameters:

conn -

text -

splitEmailList

public static java.lang.String[] splitEmailList(java.lang.String list)

parseEmailList

public static java.util.Set<InternetAddress> parseEmailList(java.lang.String list)
                                                     throws AddressException

Throws:

AddressException

checkAddressList

public static boolean checkAddressList(java.lang.String list)