com.dpslink.base.mail

Class MailMessage

java.lang.Object

com.dpslink.base.mail.MailMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FlashMailMessage

public class MailMessage
extends java.lang.Object
implements java.io.Serializable

Utility class for sending text and/or html formatted emails.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	ivAlternate The current email's alternate format file.
protected java.util.ArrayList<javax.mail.internet.MimeBodyPart>	ivAttachments The current email's file attachments.
protected java.lang.Object	ivContent The current email's content.
protected java.lang.String	ivContentType The current email's content type.
protected boolean	ivDebugMode The current debug mode.
protected javax.mail.internet.MimeMessage	ivMessage The current email's message object.
protected java.io.File	ivPreferred The current email's preferred format file.
protected boolean	ivSampleMode The current sample mode.
protected javax.mail.Session	ivSession The current STMP server session.
protected java.lang.String	ivSmtpHost The current STMP host address.
private int	ivSmtpPort The current SMTP host port.
protected java.lang.String	ivSmtpPwd The current STMP host password.
private boolean	ivSmtpTLS The current SMTP host TLS flag.
private java.lang.String	ivSmtpType The current SMTP host type (transport).
protected java.lang.String	ivSmtpUser The current STMP host user id.
protected java.lang.String	ivTemplate The current email's template file name.
protected java.lang.String	ivType The current email's type.
static java.lang.String	MSG_ALERT The message type for a site error notification message.
static java.lang.String	MSG_GENERIC The message type for a generic text message.
static java.lang.String	MSG_SITEMON The message type for a site monitor message.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MailMessage() Constructs a MailMessage object.
	MailMessage(java.lang.String type) Constructs a MailMessage object.

Method Summary

Modifier and Type	Method and Description
protected void	addDebugRecipient() Adds the debug TO name and address (if configured) to the email's list of BCC recipients.
void	addFileAttachment(java.io.File file) Adds a file attachment to the email.
void	addFileAttachment(javax.mail.internet.MimeBodyPart attachment) Adds a file attachment to the email.
void	addFileAttachment(java.lang.String path) Adds a file attachment to the email.
void	addFrom(java.lang.Object from) Adds to the email's list of from addresses using the given object (User, ArrayList, etc.).
void	addFrom(java.lang.String name, java.lang.String address) Adds to the email's list of from addresses using the given name and email address.
void	addRecipientBCC(java.lang.Object bcc) Adds to the email's list of BCC addresses using the given object (User, ArrayList, etc.).
void	addRecipientBCC(java.lang.String name, java.lang.String address) Adds to the email's list of BCC addresses using the given name and email address.
void	addRecipientCC(java.lang.Object cc) Adds to the email's list of CC addresses using the given object (User, ArrayList, etc.).
void	addRecipientCC(java.lang.String name, java.lang.String address) Adds to the email's list of CC addresses using the given name and email address.
void	addRecipientTO(java.lang.Object to) Adds to the email's list of TO addresses using the given object (User, ArrayList, etc.).
void	addRecipientTO(java.lang.String name, java.lang.String address) Adds to the email's list of TO addresses using the given name and email address.
protected void	addSiteBaseURLs(org.apache.velocity.VelocityContext content) Adds the site's base urls to the given email content (i.e.
protected void	createMessage() Creates the SMTP server session and message object.
protected void	formatMessage() Formats the message content for the current email type.
protected java.lang.String	formatProperty(java.lang.String key) Returns a formatted property value for the given property key.
protected javax.mail.internet.InternetAddress[]	getAddressFromObject(java.lang.Object obj) Returns an array of InternetAddress objects for the email names and addresses contained within the given object.
protected java.io.File	getAlternateFormatFile(java.io.File file) Returns a File object for the given file's .html or .txt alternate format.
java.lang.Object	getContent() Returns the object that was used to set the email's content.
protected java.lang.String	getContentType(java.lang.String filename) Returns a mime content type based on the given file name's file extension.
java.lang.String	getSubject() Returns the email's subject.
static boolean	isValidEmailAddress(java.lang.String address) Determines if the given email email address can be converted into an InternetAddress object by checking for valid RFC822 syntax.
protected void	resend(javax.mail.SendFailedException sfe) Attempts to resend a failed email by eliminating any email addresses that contributed to the failure.
protected void	reviseRecipients(javax.mail.Message.RecipientType type, javax.mail.Address[] validaddrs) Revises a failed email's recipients by matching the email addresses for the given recipient type to a given list of valid email addresses.
void	send() Sends the email message.
void	setContent(java.lang.Object content) Sets the email's content using the given object.
void	setDebugMode(boolean on) Sets the debug mode on/off state.
void	setFrom(java.lang.Object from) Sets the email's from address(es) using the given object (User, ArrayList, etc.).
void	setFrom(java.lang.String name, java.lang.String address) Sets the email's from address using the given name and email address.
protected void	setHeaderValues() Sets the current email type's from name, from address, to name, to address, subject and preferred template based on configuration property file values.
protected void	setHostValues() Sets the current email type's smtp host, smtp user id, and smtp password based on configuration property file values.
protected void	setMessageFormats(java.lang.String pcontent, java.lang.String ptype, java.lang.String acontent, java.lang.String atype) Sets the message content formats for the current email based on whether the email will contain a single format or multiple formats.
void	setRecipientBCC(java.lang.Object bcc) Sets the email's BCC address(es) using the given object (User, ArrayList, etc.).
void	setRecipientBCC(java.lang.String name, java.lang.String address) Sets the email's BCC address using the given name and email address.
void	setRecipientCC(java.lang.Object cc) Sets the email's CC address(es) using the given object (User, ArrayList, etc.).
void	setRecipientCC(java.lang.String name, java.lang.String address) Sets the email's CC address using the given name and email address.
void	setRecipientTO(java.lang.Object to) Sets the email's TO address(es) using the given object (User, ArrayList, etc.).
void	setRecipientTO(java.lang.String name, java.lang.String address) Sets the email's TO address using the given name and email address.
void	setSampleMode(boolean on) Sets the sample mode on/off state.
void	setSubject(java.lang.String text) Sets the email's subject.
protected java.lang.String	setSubjectFromContent(java.lang.String content, java.lang.String type) Sets the subject for an email based on the email's content.
void	setTemplate(java.io.File file) Sets the email's template file.
void	setTemplate(java.lang.String filename) Sets the email's template file name.
protected void	setType(java.lang.String type) Sets the email type and then invokes the setHostValues, setHeaderValues, createMessage methods.
protected javax.mail.internet.InternetAddress	toInternetAddress(javax.mail.Address address) Converts a javax.mail.Address object to a javax.mail.internet.InternetAddress object.
java.lang.String	toString() Returns a string representation of this MailMessage object.
protected java.lang.Object	verifyContent(java.lang.Object content) Verifies that the given content is appropriate for the current email type.
protected java.lang.String	verifyFile(java.lang.String filename) Verifies that the given file name is valid.
protected void	verifyHasRecipients() Verifies that the current email message has recipients.
protected javax.mail.internet.InternetAddress	verifyInternetAddress(java.lang.String name, java.lang.String address) Verifies that the given email name and email address can be converted into an InternetAddress object.
protected java.lang.String	verifyType(java.lang.String type) Verifies that the given email type is one of the defined types.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

MSG_ALERT

public static final java.lang.String MSG_ALERT

The message type for a site error notification message.

See Also:

Constant Field Values

MSG_GENERIC

public static final java.lang.String MSG_GENERIC

The message type for a generic text message.

See Also:

Constant Field Values

MSG_SITEMON

public static final java.lang.String MSG_SITEMON

The message type for a site monitor message.

See Also:

Constant Field Values

ivDebugMode

protected boolean ivDebugMode

The current debug mode.

ivSampleMode

protected boolean ivSampleMode

The current sample mode.

ivSmtpHost

protected java.lang.String ivSmtpHost

The current STMP host address.

ivSmtpUser

protected java.lang.String ivSmtpUser

The current STMP host user id.

ivSmtpPwd

protected java.lang.String ivSmtpPwd

The current STMP host password.

ivSmtpPort

private int ivSmtpPort

The current SMTP host port.

ivSmtpType

private java.lang.String ivSmtpType

The current SMTP host type (transport). Properties will have SMTP, SMTPS or TLS. TLS is converted to SMTP in the setHostValues() method, which occurs prior to createMessage() and send();

ivSmtpTLS

private boolean ivSmtpTLS

The current SMTP host TLS flag.

ivSession

protected javax.mail.Session ivSession

The current STMP server session.

ivMessage

protected javax.mail.internet.MimeMessage ivMessage

The current email's message object.

ivType

protected java.lang.String ivType

The current email's type.

ivTemplate

protected java.lang.String ivTemplate

The current email's template file name.

ivPreferred

protected java.io.File ivPreferred

The current email's preferred format file.

ivAlternate

protected java.io.File ivAlternate

The current email's alternate format file.

ivContent

protected java.lang.Object ivContent

The current email's content.

ivContentType

protected java.lang.String ivContentType

The current email's content type.

ivAttachments

protected java.util.ArrayList<javax.mail.internet.MimeBodyPart> ivAttachments

The current email's file attachments.

Constructor Detail

MailMessage

protected MailMessage()
               throws java.lang.Exception

Constructs a MailMessage object. Intented for use only by subclasses.

Throws:

java.lang.Exception - - if an error occurs while constructing the MailMessage object.

MailMessage

public MailMessage(java.lang.String type)
            throws java.lang.Exception

Constructs a MailMessage object.

This constructor should never the called directly. New instances of this class should be obtained from the MailFactory class.

Parameters:

type - (String) The type code for the message to send. Must be one of the predefined MSG_* type constants in this class or in an implementation subclass.

Throws:

java.lang.Exception - - if an error occurs while constructing the MailMessage object.

Method Detail

isValidEmailAddress

public static boolean isValidEmailAddress(java.lang.String address)

Determines if the given email email address can be converted into an InternetAddress object by checking for valid RFC822 syntax.

Parameters:

address - (String) The email address to be checked.

Returns:

boolean - true if the email address conforms to RFC822 syntax, otherwise false.

send

public void send()
          throws java.lang.Exception

Sends the email message.

Throws:

java.lang.Exception - - if an error occurs while sending the email.

setContent

public void setContent(java.lang.Object content)
                throws java.lang.Exception

Sets the email's content using the given object. The content may be a message text String, a message file name String or a VelocityContext of template tags and values.

NOTE: All file attachments must be added before setting the email's content.

Parameters:

content - (Object) The object that contains the email's content.

Throws:

java.lang.Exception - - if an error occurs while setting the content.

getContent

public java.lang.Object getContent()

Returns the object that was used to set the email's content. The content may be a message text String, a message file name String or a VelocityContext of template tags and values.

Returns:

Object - The email's content.

setDebugMode

public void setDebugMode(boolean on)

Sets the debug mode on/off state. Controls whether detailed communications activity with the smtp server is logged to the error log.

Parameters:

on - (boolean) true if debug mode is to be turned on, otherwise false (default).

setFrom

public void setFrom(java.lang.Object from)
             throws java.lang.Exception

Sets the email's from address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

from - (Object) The object that contains the from address information.

Throws:

java.lang.Exception - - if an error occurs while setting the from address(es).

setFrom

public void setFrom(java.lang.String name,
                    java.lang.String address)
             throws java.lang.Exception

Sets the email's from address using the given name and email address.

Parameters:

name - (String) The name associated with the from address.

address - (String) The email address associated with the from address.

Throws:

java.lang.Exception - - if an error occurs while setting the from address.

addFrom

public void addFrom(java.lang.Object from)
             throws java.lang.Exception

Adds to the email's list of from addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

from - (Object) The object that contains the from address information.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of from addresses.

addFrom

public void addFrom(java.lang.String name,
                    java.lang.String address)
             throws java.lang.Exception

Adds to the email's list of from addresses using the given name and email address.

Parameters:

name - (String) The name associated with the from address.

address - (String) The email address associated with the from address.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of from addresses.

setRecipientTO

public void setRecipientTO(java.lang.Object to)
                    throws java.lang.Exception

Sets the email's TO address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

to - (Object) The object that contains the TO address information.

Throws:

java.lang.Exception - - if an error occurs while setting the TO address(es).

setRecipientTO

public void setRecipientTO(java.lang.String name,
                           java.lang.String address)
                    throws java.lang.Exception

Sets the email's TO address using the given name and email address.

Parameters:

name - (String) The name associated with the TO address.

address - (String) The email address associated with the TO address.

Throws:

java.lang.Exception - - if an error occurs while setting the TO address.

addRecipientTO

public void addRecipientTO(java.lang.Object to)
                    throws java.lang.Exception

Adds to the email's list of TO addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

to - (Object) The object that contains the TO address information.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of TO addresses.

addRecipientTO

public void addRecipientTO(java.lang.String name,
                           java.lang.String address)
                    throws java.lang.Exception

Adds to the email's list of TO addresses using the given name and email address.

Parameters:

name - (String) The name associated with the TO address.

address - (String) The email address associated with the TO address.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of TO addresses.

setRecipientCC

public void setRecipientCC(java.lang.Object cc)
                    throws java.lang.Exception

Sets the email's CC address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

cc - (Object) The object that contains the CC address information.

Throws:

java.lang.Exception - - if an error occurs while setting the CC address(es).

setRecipientCC

public void setRecipientCC(java.lang.String name,
                           java.lang.String address)
                    throws java.lang.Exception

Sets the email's CC address using the given name and email address.

Parameters:

name - (String) The name associated with the CC address.

address - (String) The email address associated with the CC address.

Throws:

java.lang.Exception - - if an error occurs while setting the CC address.

addRecipientCC

public void addRecipientCC(java.lang.Object cc)
                    throws java.lang.Exception

Adds to the email's list of CC addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

cc - (Object) The object that contains the CC address information.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of CC addresses.

addRecipientCC

public void addRecipientCC(java.lang.String name,
                           java.lang.String address)
                    throws java.lang.Exception

Adds to the email's list of CC addresses using the given name and email address.

Parameters:

name - (String) The name associated with the CC address.

address - (String) The email address associated with the CC address.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of CC addresses.

setRecipientBCC

public void setRecipientBCC(java.lang.Object bcc)
                     throws java.lang.Exception

Sets the email's BCC address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

bcc - (Object) The object that contains the BCC address information.

Throws:

java.lang.Exception - - if an error occurs while setting the BCC address(es).

setRecipientBCC

public void setRecipientBCC(java.lang.String name,
                            java.lang.String address)
                     throws java.lang.Exception

Sets the email's BCC address using the given name and email address.

Parameters:

name - (String) The name associated with the BCC address.

address - (String) The email address associated with the BCC address.

Throws:

java.lang.Exception - - if an error occurs while setting the BCC address.

addRecipientBCC

public void addRecipientBCC(java.lang.Object bcc)
                     throws java.lang.Exception

Adds to the email's list of BCC addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Parameters:

bcc - (Object) The object that contains the BCC address information.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of BCC addresses.

addRecipientBCC

public void addRecipientBCC(java.lang.String name,
                            java.lang.String address)
                     throws java.lang.Exception

Adds to the email's list of BCC addresses using the given name and email address.

Parameters:

name - (String) The name associated with the BCC address.

address - (String) The email address associated with the BCC address.

Throws:

java.lang.Exception - - if an error occurs while adding to the list of BCC addresses.

addFileAttachment

public void addFileAttachment(java.io.File file)
                       throws java.lang.Exception

Adds a file attachment to the email. This method assumes the file resides in the server's local file system.

NOTE: All file attachments must be added before setting the email's content.

Parameters:

file - (File) The object for the file to attach.

Throws:

java.lang.Exception - - if an error occurs while adding the attachment.

addFileAttachment

public void addFileAttachment(java.lang.String path)
                       throws java.lang.Exception

Adds a file attachment to the email. This method assumes the file resides in the server's local file system.

NOTE: All file attachments must be added before setting the email's content.

Parameters:

path - (String) The full path to the file to attach.

Throws:

java.lang.Exception - - if an error occurs while adding the attachment.

addFileAttachment

public void addFileAttachment(javax.mail.internet.MimeBodyPart attachment)
                       throws java.lang.Exception

Adds a file attachment to the email.

NOTE: All file attachments must be added before setting the email's content.

Parameters:

attachment - (MimeBodyPart) The object for the file to attach.

Throws:

java.lang.Exception - - if an error occurs while adding the attachment.

setSampleMode

public void setSampleMode(boolean on)

Sets the sample mode on/off state. When sample mode is on, any alternate format is ignored and only the preferred format is sent.

Parameters:

on - (boolean) true if sample mode is to be turned on, otherwise false (default).

setSubject

public void setSubject(java.lang.String text)
                throws java.lang.Exception

Sets the email's subject.

Parameters:

text - (String) The email subject text.

Throws:

java.lang.Exception - - if an error occurs while setting the subject.

getSubject

public java.lang.String getSubject()
                            throws java.lang.Exception

Returns the email's subject.

Returns:

String - The email's subject.

Throws:

java.lang.Exception - - if an error occurs while getting the subject.

setTemplate

public void setTemplate(java.io.File file)
                 throws java.lang.Exception

Sets the email's template file.

Parameters:

file - (File) The template file.

Throws:

java.lang.Exception - - if an error occurs while setting the template file.

setTemplate

public void setTemplate(java.lang.String filename)
                 throws java.lang.Exception

Sets the email's template file name.

Parameters:

filename - (String) The template file name. The template is assumed to reside in the configured Velocity template folder or in a subfolder of the configured folder.

Throws:

java.lang.Exception - - if an error occurs while setting the template file name.

toString

public java.lang.String toString()

Returns a string representation of this MailMessage object.

Overrides:

toString in class java.lang.Object

Returns:

String - This object as a string.

createMessage

protected void createMessage()
                      throws java.lang.Exception

Creates the SMTP server session and message object.

Throws:

java.lang.Exception - - if an error occurs while creating the session and the message object.

formatMessage

protected void formatMessage()
                      throws java.lang.Exception

Formats the message content for the current email type.

Throws:

java.lang.Exception - - if an error occurs while formatting the message content.

formatProperty

protected java.lang.String formatProperty(java.lang.String key)

Returns a formatted property value for the given property key. This implementation does nothing and simply returns the property value as-is. Subclasses should override this method to provide application-specific processing, such as inserting variable data into the property value.

Parameters:

key - (String) The property key to retrieve.

Returns:

String - The formatted property value.

addDebugRecipient

protected void addDebugRecipient()

Adds the debug TO name and address (if configured) to the email's list of BCC recipients.

addSiteBaseURLs

protected void addSiteBaseURLs(org.apache.velocity.VelocityContext content)

Adds the site's base urls to the given email content (i.e. the email's substitution tags and values).

getAddressFromObject

protected javax.mail.internet.InternetAddress[] getAddressFromObject(java.lang.Object obj)
                                                              throws java.lang.Exception

Returns an array of InternetAddress objects for the email names and addresses contained within the given object.

This implementation does nothing and always returns null. Subclasses must override this method to provide the desired results.

Parameters:

obj - (Object) The object that contains email name & address information.

Returns:

InternetAddress[] - An array of InternetAddress objects, extracted from the given object.

Throws:

java.lang.Exception - - if an error occurs while extracting the name and address information.

getAlternateFormatFile

protected java.io.File getAlternateFormatFile(java.io.File file)
                                       throws java.lang.Exception

Returns a File object for the given file's .html or .txt alternate format. If the given file is a .html file, the file returned will be its corresponding .txt file. If the given file is a .txt file, the file returned will be its corresponding .html file.

Parameters:

file - (File) The File object for a .html or .txt file.

Returns:

File - A File object for the alternate file format, or null if the alternate file format cannot be determined.

Throws:

java.lang.Exception - - if an error occurs while determining the alternate format's file.

getContentType

protected java.lang.String getContentType(java.lang.String filename)
                                   throws java.lang.Exception

Returns a mime content type based on the given file name's file extension.

Parameters:

filename - (String) The file name to process.

Returns:

String - The mime content type that corresponds to the given file name's file extension. Returns "text/html" for .html file extensions. Returns "text/plain" for .txt file extensions.

Throws:

java.lang.Exception - - if an error occurs while determining the file name's content type.

resend

protected void resend(javax.mail.SendFailedException sfe)
               throws java.lang.Exception

Attempts to resend a failed email by eliminating any email addresses that contributed to the failure. Only one retry attempt is made. If additional failures occur during the retry, the entire email is aborted.

Parameters:

sfe - (SendFailedException) The failure exception that occurred during the initial attempt to send the email.

Throws:

java.lang.Exception - - if an error occurs while resending the email.

reviseRecipients

protected void reviseRecipients(javax.mail.Message.RecipientType type,
                                javax.mail.Address[] validaddrs)
                         throws java.lang.Exception

Revises a failed email's recipients by matching the email addresses for the given recipient type to a given list of valid email addresses.

Parameters:

type - (Message.RecipientType) The type of email recipients to revise (TO, CC, BCC).

validaddrs - (Address[]) An array of valid email addresses.

Throws:

java.lang.Exception - - if an error occurs while revising the recipients.

setHeaderValues

protected void setHeaderValues()
                        throws java.lang.Exception

Sets the current email type's from name, from address, to name, to address, subject and preferred template based on configuration property file values.

Throws:

java.lang.Exception - - if an error occurs while setting the header values.

setHostValues

protected void setHostValues()
                      throws java.lang.Exception

Sets the current email type's smtp host, smtp user id, and smtp password based on configuration property file values.

Throws:

java.lang.Exception - - if an error occurs while setting the host values.

setMessageFormats

protected void setMessageFormats(java.lang.String pcontent,
                                 java.lang.String ptype,
                                 java.lang.String acontent,
                                 java.lang.String atype)
                          throws java.lang.Exception

Sets the message content formats for the current email based on whether the email will contain a single format or multiple formats.

Parameters:

pcontent - (String) The email's preferred content.

ptype - (String) The email's preferred content type.

acontent - (String) The email's alternate content. Will be null if there is no alternate content.

atype - (String) The email's alternate content type. Will be null if there is no alternate content.

Throws:

java.lang.Exception - - if an error occurs while setting the message formats.

setSubjectFromContent

protected java.lang.String setSubjectFromContent(java.lang.String content,
                                                 java.lang.String type)
                                          throws java.lang.Exception

Sets the subject for an email based on the email's content. For html formats, this will the the html title (the text between the html title tags). For text formats, this will be the first line of text in the file.

Parameters:

content - (String) The email's content (preferred or alternate).

type - (String) The email's content type (preferred or alternate).

Returns:

String - The email's actual content, with any text format subject information removed.

Throws:

java.lang.Exception - - if an error occurs while setting the message subject.

setType

protected void setType(java.lang.String type)
                throws java.lang.Exception

Sets the email type and then invokes the setHostValues, setHeaderValues, createMessage methods.

Parameters:

type - (String) The type code for the email message. Must be one of the predefined MSG_* type constants in this class or in an implementation subclass.

Throws:

java.lang.Exception - - if an error occurs while setting the type or if the specified type is invalid.

toInternetAddress

protected javax.mail.internet.InternetAddress toInternetAddress(javax.mail.Address address)
                                                         throws java.lang.Exception

Converts a javax.mail.Address object to a javax.mail.internet.InternetAddress object.

Parameters:

address - (Address) The addresss to convert.

Returns:

InternetAddress - The converted address.

Throws:

java.lang.Exception - - if the address cannot be converted.

verifyContent

protected java.lang.Object verifyContent(java.lang.Object content)
                                  throws java.lang.Exception

Verifies that the given content is appropriate for the current email type. The content may be a message text String, a message file name String, or a VelocityContext of template tags and values.

Parameters:

content - (Object) The object that contains the email's content.

Returns:

String - The verified content.

Throws:

java.lang.Exception - - if the specified content is invalid.

verifyFile

protected java.lang.String verifyFile(java.lang.String filename)
                               throws java.lang.Exception

Verifies that the given file name is valid. The file may be for a template or it may be for a pre-composed content file. The file is considered to be valid if either a .html or .txt version of the file can be found. This method assumes the file resides in the server's local file system.

Parameters:

filename - (String) The fully qualified path and file name to be verified.

Returns:

String - The verified file name.

Throws:

java.lang.Exception - - if the specified file name is invalid.

verifyHasRecipients

protected void verifyHasRecipients()
                            throws java.lang.Exception

Verifies that the current email message has recipients. A message must have at least one recipient.

Throws:

java.lang.Exception - - if the current message has no recipients.

verifyInternetAddress

protected javax.mail.internet.InternetAddress verifyInternetAddress(java.lang.String name,
                                                                    java.lang.String address)

Verifies that the given email name and email address can be converted into an InternetAddress object. Logs a message to the error log if the email address does not conform to RFC822 syntax.

Parameters:

name - (String) The name associated with the email address.

address - (String) The email address to be verified.

Returns:

InternetAddress - An InternetAddress object for the specified name and address, or null if the specified address does not conform to RFC822 syntax.

verifyType

protected java.lang.String verifyType(java.lang.String type)
                               throws java.lang.Exception

Verifies that the given email type is one of the defined types.

Parameters:

type - (String) The email type to be verified.

Returns:

String - The verified email type.

Throws:

java.lang.Exception - - if the specified type is invalid.