com.dpslink.flash.util

Class FlashMailMessage

java.lang.Object

com.dpslink.base.mail.MailMessage

com.dpslink.flash.util.FlashMailMessage

All Implemented Interfaces:

java.io.Serializable

public class FlashMailMessage
extends MailMessage

An extension to the base mail message class that provides additional Flash specific mail handling.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected NotificationMessage	ivNFMessage The current Notfication Framework message handler.
static java.lang.String	MSG_CCREJECT The message type for a credit card reject message.
static java.lang.String	MSG_CUSTDEF The message type for a custom-defined message.
static java.lang.String	MSG_LOGONHELP The message type for a logon assistance message.
static java.lang.String	MSG_LOWSTOCK The message type for a product low stock notification message.
static java.lang.String	MSG_MASSMAIL The message type for a mass mail message.
static java.lang.String	MSG_NEWACCOUNT The message type for a new account notification message.
static java.lang.String	MSG_ORDERCONF The message type for an order confirmation message.
static java.lang.String	MSG_QUOTECONF The message type for a quote creation confirmation message.
static java.lang.String	MSG_RESTOCK The message type for a product restock notification message.
static java.lang.String	MSG_SHIPCONF The message type for a shipment confirmation message.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.mail.MailMessage

ivAlternate, ivAttachments, ivContent, ivContentType, ivDebugMode, ivMessage, ivPreferred, ivSampleMode, ivSession, ivSmtpHost, ivSmtpPwd, ivSmtpUser, ivTemplate, ivType, MSG_ALERT, MSG_GENERIC, MSG_SITEMON

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addFileAttachment(java.io.File file) Adds a file attachment to the message.
void	addFileAttachment(javax.mail.internet.MimeBodyPart attachment) Adds a file attachment to the message.
void	addFileAttachment(java.lang.String path) Adds a file attachment to the message.
void	addFrom(java.lang.Object from) Adds to the message'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 message's list of from addresses using the given name and email address.
void	addRecipientBCC(java.lang.Object bcc) Adds to the message'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 message's list of BCC addresses using the given name and email address.
void	addRecipientCC(java.lang.Object cc) Adds to the message'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 message's list of CC addresses using the given name and email address.
void	addRecipientTO(java.lang.Object to) Adds to the message'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 message's list of TO addresses using the given name and email address.
protected void	createMessage() Creates the SMTP server session and message object.
void	finalizeMessage() Performs finalization for a message that is being scheduled for later sending, such as a mass mail message.
protected void	formatMessage() Formats the message content for the current email type.
private javax.mail.internet.InternetAddress	getAddressFromArray(java.lang.String[] arr) Returns an InternetAddress object for the email name and address contained within the given String array.
private javax.mail.internet.InternetAddress	getAddressFromCustomer(Customer customer) Returns an InternetAddress object for the email name and address contained within the given customer.
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.
private javax.mail.internet.InternetAddress	getAddressFromRestock(RestockNotification restock) Returns an InternetAddress object for the email name and address contained within the given product restock notification.
private javax.mail.internet.InternetAddress	getAddressFromUser(User user) Returns an InternetAddress object for the email name and address contained within the given user.
java.lang.String	getSubject() Returns the message's subject.
static org.apache.velocity.VelocityContext	initTemplateData(FlashServletContext ctx) Creates, initializes and returns a Velocity Context object that can then be used as the template data for an email message.
protected NotificationMessage	newNFMessage(java.lang.String type) Returns the Notification Framework message object that is to be used for processing this message.
void	send() Sends the message.
void	setContent(java.lang.Object content) Sets the message's content using the given object.
void	setFrom(java.lang.Object from) Sets the message's from address(es) using the given object (User, ArrayList, etc.).
void	setFrom(java.lang.String name, java.lang.String address) Sets the message's from address using the given name and email address.
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 message based on whether the message will contain a single format or multiple formats.
void	setRecipientBCC(java.lang.Object bcc) Sets the message's BCC address(es) using the given object (User, ArrayList, etc.).
void	setRecipientBCC(java.lang.String name, java.lang.String address) Sets the message's BCC address using the given name and email address.
void	setRecipientCC(java.lang.Object cc) Sets the message's CC address(es) using the given object (User, ArrayList, etc.).
void	setRecipientCC(java.lang.String name, java.lang.String address) Sets the message's CC address using the given name and email address.
void	setRecipientTO(java.lang.Object to) Sets the message's TO address(es) using the given object (User, ArrayList, etc.).
void	setRecipientTO(java.lang.String name, java.lang.String address) Sets the message's TO address using the given name and email address.
void	setSampleMethod(java.lang.String delvmeth) Sets the sample delivery method (email, sms, push).
void	setSampleMode(boolean on) Sets the sample mode on/off state.
void	setSampleVersion(java.lang.String version) Sets the sample version number.
void	setSubject(java.lang.String text) Sets the message's subject.
void	setTemplate(java.io.File file) Sets the message's template file.
void	setTemplate(java.lang.String filename) Sets the message's template file name.
protected void	setType(java.lang.String type) Sets the message type and then invokes additional type initialization.
protected java.lang.Object	verifyContent(java.lang.Object content) Verifies that the given content is appropriate for the current email type.

Methods inherited from class com.dpslink.base.mail.MailMessage

addDebugRecipient, addSiteBaseURLs, formatProperty, getAlternateFormatFile, getContent, getContentType, isValidEmailAddress, resend, reviseRecipients, setDebugMode, setHeaderValues, setHostValues, setSubjectFromContent, toInternetAddress, toString, verifyFile, verifyHasRecipients, verifyInternetAddress, verifyType

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_ORDERCONF

public static final java.lang.String MSG_ORDERCONF

The message type for an order confirmation message.

See Also:

Constant Field Values

MSG_SHIPCONF

public static final java.lang.String MSG_SHIPCONF

The message type for a shipment confirmation message.

See Also:

Constant Field Values

MSG_QUOTECONF

public static final java.lang.String MSG_QUOTECONF

The message type for a quote creation confirmation message.

See Also:

Constant Field Values

MSG_CCREJECT

public static final java.lang.String MSG_CCREJECT

The message type for a credit card reject message.

See Also:

Constant Field Values

MSG_LOGONHELP

public static final java.lang.String MSG_LOGONHELP

The message type for a logon assistance message.

See Also:

Constant Field Values

MSG_NEWACCOUNT

public static final java.lang.String MSG_NEWACCOUNT

The message type for a new account notification message.

See Also:

Constant Field Values

MSG_RESTOCK

public static final java.lang.String MSG_RESTOCK

The message type for a product restock notification message.

See Also:

Constant Field Values

MSG_LOWSTOCK

public static final java.lang.String MSG_LOWSTOCK

The message type for a product low stock notification message.

See Also:

Constant Field Values

MSG_MASSMAIL

public static final java.lang.String MSG_MASSMAIL

The message type for a mass mail message.

See Also:

Constant Field Values

MSG_CUSTDEF

public static final java.lang.String MSG_CUSTDEF

The message type for a custom-defined message.

The actual message type passed to the constructor for a custom-defined message must be a concatenation of this constant plus the name given to the message in properties. Example: MSG_CUSTDEF + ".mymessage".

See Also:

Constant Field Values

ivNFMessage

protected NotificationMessage ivNFMessage

The current Notfication Framework message handler.

Constructor Detail

FlashMailMessage

protected FlashMailMessage()
                    throws java.lang.Exception

Constructs a FlashMailMessage object.

Throws:

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

FlashMailMessage

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

Constructs a FlashMailMessage 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 the base class.

NOTE: The message type passed to this constructor for a user defined message must be a concatenation of the MSG_USERDEF constant plus the name given to the message in properties. Example: MSG_USERDEF + ".mymessage".

Throws:

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

Method Detail

send

public void send()
          throws java.lang.Exception

Sends the message.

Overrides send in base MailMessage.

Overrides:

send in class MailMessage

Throws:

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

setContent

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

Sets the message'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 message's content.

Overrides setContent in base MailMessage.

Overrides:

setContent in class MailMessage

Parameters:

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

Throws:

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

setFrom

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

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

Overrides setFrom in base MailMessage.

Overrides:

setFrom in class MailMessage

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 message's from address using the given name and email address.

Overrides setFrom in base MailMessage.

Overrides:

setFrom in class MailMessage

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 message's list of from addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides addFrom in base MailMessage.

Overrides:

addFrom in class MailMessage

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 message's list of from addresses using the given name and email address.

Overrides addFrom in base MailMessage.

Overrides:

addFrom in class MailMessage

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 message's TO address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides setRecipientTO in base MailMessage.

Overrides:

setRecipientTO in class MailMessage

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 message's TO address using the given name and email address.

Overrides setRecipientTO in base MailMessage.

Overrides:

setRecipientTO in class MailMessage

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 message's list of TO addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides addRecipientTO in base MailMessage.

Overrides:

addRecipientTO in class MailMessage

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 message's list of TO addresses using the given name and email address.

Overrides addRecipientTO in base MailMessage.

Overrides:

addRecipientTO in class MailMessage

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 message's CC address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides setRecipientCC in base MailMessage.

Overrides:

setRecipientCC in class MailMessage

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 message's CC address using the given name and email address.

Overrides setRecipientCC in base MailMessage.

Overrides:

setRecipientCC in class MailMessage

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 message's list of CC addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides addRecipientCC in base MailMessage.

Overrides:

addRecipientCC in class MailMessage

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 message's list of CC addresses using the given name and email address.

Overrides addRecipientCC in base MailMessage.

Overrides:

addRecipientCC in class MailMessage

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 message's BCC address(es) using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides setRecipientBCC in base MailMessage.

Overrides:

setRecipientBCC in class MailMessage

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 message's BCC address using the given name and email address.

Overrides setRecipientBCC in base MailMessage.

Overrides:

setRecipientBCC in class MailMessage

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 message's list of BCC addresses using the given object (User, ArrayList, etc.). See the getAddressFromObject method for a list of the currently supported objects.

Overrides addRecipientBCC in base MailMessage.

Overrides:

addRecipientBCC in class MailMessage

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 message's list of BCC addresses using the given name and email address.

Overrides addRecipientBCC in base MailMessage.

Overrides:

addRecipientBCC in class MailMessage

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 message. This method assumes the file resides in the server's local file system.

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

Overrides addFileAttachment in base MailMessage.

Overrides:

addFileAttachment in class MailMessage

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 message. This method assumes the file resides in the server's local file system.

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

Overrides addFileAttachment in base MailMessage.

Overrides:

addFileAttachment in class MailMessage

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 message. This method is not supported when using the Notification Framework.

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

Overrides addFileAttachment in base MailMessage.

Overrides:

addFileAttachment in class MailMessage

Parameters:

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

Throws:

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

setSampleMethod

public void setSampleMethod(java.lang.String delvmeth)

Sets the sample delivery method (email, sms, push).

Parameters:

delvmeth - (String) The sample delivery method.

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.

Overrides setSampleMode in base MailMessage.

Overrides:

setSampleMode in class MailMessage

Parameters:

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

setSampleVersion

public void setSampleVersion(java.lang.String version)

Sets the sample version number.

Parameters:

version - (String) The sample version number.

setSubject

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

Sets the message's subject.

Overrides setSubject in base MailMessage.

Overrides:

setSubject in class MailMessage

Parameters:

text - (String) The message 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 message's subject.

Overrides getSubject in base MailMessage.

Overrides:

getSubject in class MailMessage

Returns:

String - The message'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 message's template file.

Overrides setTemplate in base MailMessage.

Overrides:

setTemplate in class MailMessage

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 message's template file name.

Overrides setTemplate in base MailMessage.

Overrides:

setTemplate in class MailMessage

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.

createMessage

protected void createMessage()
                      throws java.lang.Exception

Creates the SMTP server session and message object.

Overrides createMessage in base MailMessage.

Overrides:

createMessage in class MailMessage

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.

Overrides formatMessage in base MailMessage.

Overrides:

formatMessage in class MailMessage

Throws:

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

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 message based on whether the message will contain a single format or multiple formats.

Overrides setMessageFormats in base MailMessage.

Overrides:

setMessageFormats in class MailMessage

Parameters:

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

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

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

atype - (String) The message'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.

setType

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

Sets the message type and then invokes additional type initialization.

Overrides setType in base MailMessage.

Overrides:

setType in class MailMessage

Parameters:

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

Throws:

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

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.

Overrides verifyContent in base MailMessage.

Overrides:

verifyContent in class MailMessage

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.

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.

Overrides getAddressFromObject in base MailMessage.

The currently supported objects are:

Customer

RestockNotification

User

String Array

an ArrayList of any of the above

Overrides:

getAddressFromObject in class MailMessage

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.

getAddressFromArray

private javax.mail.internet.InternetAddress getAddressFromArray(java.lang.String[] arr)
                                                         throws java.lang.Exception

Returns an InternetAddress object for the email name and address contained within the given String array.

Parameters:

arr - (String[]) The array that contains email name & address information (index 0 is the formatted name, index 1 is the email address).

Returns:

InternetAddress - The array's email name and address converted to an InternetAddress object, or null if an InternetAddress object could not be created.

Throws:

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

getAddressFromCustomer

private javax.mail.internet.InternetAddress getAddressFromCustomer(Customer customer)
                                                            throws java.lang.Exception

Returns an InternetAddress object for the email name and address contained within the given customer.

Parameters:

customer - (Customer) The Customer that contains email name & address information.

Returns:

InternetAddress - The customer's email name and address converted to an InternetAddress object, or null if an InternetAddress object could not be created.

Throws:

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

getAddressFromRestock

private javax.mail.internet.InternetAddress getAddressFromRestock(RestockNotification restock)
                                                           throws java.lang.Exception

Returns an InternetAddress object for the email name and address contained within the given product restock notification.

Parameters:

restock - (RestockNotification) The RestockNotification that contains email name & address information.

Returns:

InternetAddress - The restock's email name and address converted to an InternetAddress object, or null if an InternetAddress object could not be created.

Throws:

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

getAddressFromUser

private javax.mail.internet.InternetAddress getAddressFromUser(User user)
                                                        throws java.lang.Exception

Returns an InternetAddress object for the email name and address contained within the given user.

Parameters:

user - (User) The User that contains email name and address information.

Returns:

InternetAddress - The user's email name & address converted to an InternetAddress object, or null if an InternetAddress object could not be created.

Throws:

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

initTemplateData

public static org.apache.velocity.VelocityContext initTemplateData(FlashServletContext ctx)

Creates, initializes and returns a Velocity Context object that can then be used as the template data for an email message. All classes that generate Flash-specific emails should invoke this method and use the returned Velocity Context as the basis for the message's content.

Parameters:

ctx - (Context) The current servlet or thread context.

Returns:

VelocityContext - An initialized email content object.

finalizeMessage

public void finalizeMessage()
                     throws java.lang.Exception

Performs finalization for a message that is being scheduled for later sending, such as a mass mail message. It is not necessary for unscheduled messages to invoke this method.

Throws:

java.lang.Exception - - if an error occurs during finalization.

newNFMessage

protected NotificationMessage newNFMessage(java.lang.String type)

Returns the Notification Framework message object that is to be used for processing this message. Allows for properties to be defined that indicate which class actually gets created.

Uses the Notification.Framework.NotificationMessage.class property to determine if a custom message class should be created. If no value is assigned or found for this property then the default class com.dpslink.flash.util.NotificationMessage is created.

Parameters:

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

Returns:

NotificationMessage - An instance of the default message class or a defined subclass. Returns null if the class could not be created.