com.aspc.Mail

Class MailMessage

java.lang.Object

com.aspc.Mail.MailMessage

public class MailMessage
extends java.lang.Object

Mail Message provides a facility for sending mail messages. The process is simplified by automatically setting up the parameters for the host.
THREAD MODE: SINGLE-THREADED

Since:

April 8, 2002, 12:20 PM

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_REDIRECT_EMAIL_RECIPIENTS Default Redirect Email Recipients
static java.lang.String	REDIRECT_EMAIL_RECIPIENTS Ignore selected recipients and send emails to recipients supplied by system property

Constructor Summary

Constructors

Constructor and Description
MailMessage()

Method Summary

Modifier and Type	Method and Description
MailAttachment	addAttachment(DBFile file, java.lang.String attachmentName) Adds an attachment to the email
MailAttachment	addAttachment(java.io.File file, java.lang.String attachmentName) Adds an attachment to the email
MailAttachment	addAttachment(MailAttachment ma) Adds an attachment to the email
protected MimeMultipart	addAttachments(MimeMultipart mp, java.lang.String sendHTML) Creates body elements for each attachment and adds to supplied MimeMultipart
MailMessage	addBCC(java.lang.String recipient) Adds a recipient to the BCC list
MailMessage	addCC(java.lang.String recipient) This function adds the CC recipients
MailMessage	addRecipient(java.lang.String recipient) Adds a recipient to the TO list
MailMessage	addRecipient(java.lang.String type, java.lang.String recipient) Adds the recipient to the recipient list based on the recipient type
MailMessage	addRecipients(java.lang.String type, java.lang.String[] recipients) Adds a list of recipients to the recipient list based on type
MailMessage	clearRecipients() Clears the recipient lists
protected MimeMessage	constructMessage(Session session)
java.lang.String	generateMimeBody() Generate the mime body
java.lang.String	getCalcReplyTo() Determines the REPLY TO address depending on information supplied
java.lang.String	getFrom() Returns the FROM email address
java.lang.String	getHTML() Returns the current body text in HTML format
MimeMessage	getMessage() Constructs the email
boolean	getReadReceipt() Returns the current setting for the read receipt
java.lang.String[]	getRecipients() Returns the list of recipients in the TO list
java.lang.String	getReplyTo() Returns the REPLY TO email address
EmailUtil.ConnectionSecurity	getSecurity() security
boolean	getServerReceipt() Returns the current setting for the server receipt
java.lang.String	getSMTPPassword() Returns the current setting for user used to connect to the SMTP server This will return the setting if manually set or the current value from system property mail.smtp.user
java.lang.String	getSMTPServer() Retrieves the current setting for the SMTP server url This will return the setting if manually set or the current value from system property mail.smtp.host
java.lang.String	getSMTPUser() Returns the current setting for user used to connect to the SMTP server This will return the setting if manually set or the current value from system property mail.smtp.user
java.lang.String	getSubject() Returns the subject of the email
java.lang.String	getText() Returns the text used in the body of the email
boolean	hasImageEmbedded() get the hasImageEmbedded value
MailAttachment[]	listAttachments() Returns the list of attachments for this email The returned objects can be a combination of File and DBFile objects
java.lang.String	makeHTML()
void	send() Constructs the email and sends to SMTP server error codes
MailMessage	setDataSource(VirtualDB layer) sets the datasource to find the systemProperty for recipient list.
MailMessage	setEmbedRemoteImages(boolean flag) fetch and embed images.
MailMessage	setFrom(java.lang.String from) Sets the email address that the email is to be sent from
MailMessage	setHasImageEmbedded(boolean hasImageEmbedded) set the hasImageEmbedded value, if true, the HTML IMG tag would show the image in the email body.
MailMessage	setHeader(java.lang.String key, java.lang.String value) Sets a specific header in the email
MailMessage	setHTML(java.lang.String html) Sets the body text in HTML format
MailMessage	setReadReceipt(boolean flag) Requests that the person receiving the email is prompted to notify the sender that it has been received
MailMessage	setReplyTo(java.lang.String replyTo) Sets the REPLY To email address.
MailMessage	setSecurity(EmailUtil.ConnectionSecurity security) Use TLS
MailMessage	setServerReceipt(boolean flag) Requests that the person receiving the email is prompted to notify the sender that it has been received
MailMessage	setSMTPPassword(java.lang.String password) Sets the password that should be used when connecting to SMTP server
MailMessage	setSMTPPort(int port) Sets the port used to connect to the SMTP server
MailMessage	setSMTPServer(java.lang.String host) Sets the URL of the SMTP server
MailMessage	setSMTPUser(java.lang.String user) Sets the user used to connect to the SMTP server
MailMessage	setSubject(java.lang.String subject) Set the subject to be used in the mail message
MailMessage	setText(java.lang.String text) Sets the text to be used in body of the email

Methods inherited from class java.lang.Object

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

Field Detail

REDIRECT_EMAIL_RECIPIENTS

public static final java.lang.String REDIRECT_EMAIL_RECIPIENTS

Ignore selected recipients and send emails to recipients supplied by system property

See Also:

Constant Field Values

DEFAULT_REDIRECT_EMAIL_RECIPIENTS

public static final java.lang.String DEFAULT_REDIRECT_EMAIL_RECIPIENTS

Default Redirect Email Recipients

See Also:

Constant Field Values

Constructor Detail

MailMessage

public MailMessage()

Method Detail

setSMTPServer

@Nonnull
public MailMessage setSMTPServer(@Nullable
                                          java.lang.String host)

Sets the URL of the SMTP server

Parameters:

host - - the url of the SMTP server

Returns:

this

getSMTPServer

@CheckReturnValue
 @Nullable
public java.lang.String getSMTPServer()

Retrieves the current setting for the SMTP server url This will return the setting if manually set or the current value from system property mail.smtp.host

Returns:

- the current SMTP server url

setSMTPUser

@Nonnull
public MailMessage setSMTPUser(@Nonnull
                                        java.lang.String user)

Sets the user used to connect to the SMTP server

Parameters:

user - - the username to use for the connection

Returns:

this

setDataSource

@Nonnull
public MailMessage setDataSource(@Nullable
                                          VirtualDB layer)

sets the datasource to find the systemProperty for recipient list.

Parameters:

layer - - the layer

Returns:

this

getSMTPUser

@CheckReturnValue
 @Nullable
public java.lang.String getSMTPUser()

Returns the current setting for user used to connect to the SMTP server This will return the setting if manually set or the current value from system property mail.smtp.user

Returns:

username of user

setSMTPPassword

@Nonnull
public MailMessage setSMTPPassword(@Nullable
                                            java.lang.String password)

Sets the password that should be used when connecting to SMTP server

Parameters:

password - - password to be used

Returns:

this

getSMTPPassword

@CheckReturnValue
 @Nullable
public java.lang.String getSMTPPassword()

Returns the current setting for user used to connect to the SMTP server This will return the setting if manually set or the current value from system property mail.smtp.user

Returns:

username of user

setSMTPPort

@Nonnull
public MailMessage setSMTPPort(@Nonnegative
                                        int port)

Sets the port used to connect to the SMTP server

Parameters:

port - - the port to use for the connection

Returns:

this

setSecurity

@Nonnull
public MailMessage setSecurity(@Nonnull
                                        EmailUtil.ConnectionSecurity security)

Use TLS

Parameters:

security - the security

Returns:

this

getSecurity

@CheckReturnValue
 @Nonnull
public EmailUtil.ConnectionSecurity getSecurity()

security

Returns:

security

setSubject

@Nonnull
public MailMessage setSubject(@Nonnull
                                       java.lang.String subject)

Set the subject to be used in the mail message

Parameters:

subject - - the subject for the email

Returns:

this

getSubject

@CheckReturnValue
 @Nullable
public java.lang.String getSubject()

Returns the subject of the email

Returns:

the current subject text

setText

@Nonnull
public MailMessage setText(@Nonnull
                                    java.lang.String text)

Sets the text to be used in body of the email

Parameters:

text - - The body text

Returns:

this

getText

@CheckReturnValue
 @Nonnull
public java.lang.String getText()

Returns the text used in the body of the email

Returns:

- the body text

setHTML

@Nonnull
public MailMessage setHTML(@Nullable
                                    java.lang.String html)

Sets the body text in HTML format

Parameters:

html - - body text in HTML format

Returns:

this

getHTML

@CheckReturnValue
 @Nullable
public java.lang.String getHTML()

Returns the current body text in HTML format

Returns:

- body text in HTML format

hasImageEmbedded

@CheckReturnValue
public boolean hasImageEmbedded()

get the hasImageEmbedded value

Returns:

if true, the HTML IMG tag would show the image in the email body.

setHasImageEmbedded

@Nonnull
public MailMessage setHasImageEmbedded(boolean hasImageEmbedded)

set the hasImageEmbedded value, if true, the HTML IMG tag would show the image in the email body.

Parameters:

hasImageEmbedded - hasImageEmbedded

Returns:

this

setFrom

@Nonnull
public MailMessage setFrom(@Nullable
                                    java.lang.String from)
                             throws InvalidDataException

Sets the email address that the email is to be sent from

Parameters:

from - - the FROM email address

Returns:

this

Throws:

InvalidDataException

getFrom

@CheckReturnValue
 @Nullable
public java.lang.String getFrom()

Returns the FROM email address

Returns:

- the FROM email address

setReplyTo

@Nonnull
public MailMessage setReplyTo(@Nonnull
                                       java.lang.String replyTo)
                                throws InvalidDataException

Sets the REPLY To email address.

Parameters:

replyTo - - email address to the reply should be sent to

Returns:

this

Throws:

InvalidDataException

getReplyTo

@CheckReturnValue
 @Nullable
public java.lang.String getReplyTo()

Returns the REPLY TO email address

Returns:

- email address to the reply should be sent to

getCalcReplyTo

@CheckReturnValue
 @Nullable
public java.lang.String getCalcReplyTo()

Determines the REPLY TO address depending on information supplied

Returns:

- email address to the reply should be sent to

clearRecipients

@Nonnull
public MailMessage clearRecipients()

Clears the recipient lists

Returns:

this

addRecipient

@Nonnull
public MailMessage addRecipient(@Nonnull
                                         java.lang.String type,
                                         @Nonnull
                                         java.lang.String recipient)
                                  throws InvalidDataException

Adds the recipient to the recipient list based on the recipient type

Parameters:

type - TO, CC, BCC

recipient - - email address of recipient

Returns:

this

Throws:

InvalidDataException

addRecipients

@Nonnull
public MailMessage addRecipients(@Nonnull
                                          java.lang.String type,
                                          @Nullable
                                          java.lang.String[] recipients)
                                   throws InvalidDataException

Adds a list of recipients to the recipient list based on type

Parameters:

type - TO, CC, BCC

recipients - - list of recipient email addresses

Returns:

this

Throws:

InvalidDataException

addRecipient

@Nonnull
public MailMessage addRecipient(@Nonnull
                                         java.lang.String recipient)
                                  throws InvalidDataException

Adds a recipient to the TO list

Parameters:

recipient - - the email address of the recipient

Returns:

this

Throws:

InvalidDataException

getRecipients

@CheckReturnValue
 @Nonnull
public java.lang.String[] getRecipients()

Returns the list of recipients in the TO list

Returns:

- the list of recipient email addresses

addCC

@Nonnull
public MailMessage addCC(@Nonnull
                                  java.lang.String recipient)
                           throws InvalidDataException

This function adds the CC recipients

Parameters:

recipient - String

Returns:

this

Throws:

InvalidDataException

addBCC

@Nonnull
public MailMessage addBCC(@Nonnull
                                   java.lang.String recipient)
                            throws InvalidDataException

Adds a recipient to the BCC list

Parameters:

recipient - - the email address of the recipient to be added to BCC list

Returns:

this

Throws:

InvalidDataException

setReadReceipt

@Nonnull
public MailMessage setReadReceipt(boolean flag)

Requests that the person receiving the email is prompted to notify the sender that it has been received

Parameters:

flag - - if true then the read receipt will be activated

Returns:

this

setEmbedRemoteImages

@Nonnull
public MailMessage setEmbedRemoteImages(boolean flag)

fetch and embed images.

Parameters:

flag - true to embed remote images.

Returns:

this

getReadReceipt

@CheckReturnValue
public boolean getReadReceipt()

Returns the current setting for the read receipt

Returns:

true if the read receipt will be activated

setServerReceipt

@Nonnull
public MailMessage setServerReceipt(boolean flag)

Requests that the person receiving the email is prompted to notify the sender that it has been received

Parameters:

flag - - if true then the server receipt will be activated

Returns:

this

getServerReceipt

@CheckReturnValue
public boolean getServerReceipt()

Returns the current setting for the server receipt

Returns:

true if the server receipt will be activated

setHeader

@Nonnull
public MailMessage setHeader(@Nonnull
                                      java.lang.String key,
                                      @Nonnull
                                      java.lang.String value)

Sets a specific header in the email

Parameters:

key - - the key of the header

value - - the value of the header

Returns:

this

addAttachment

@Nonnull
public MailAttachment addAttachment(@Nonnull
                                             DBFile file,
                                             @Nullable
                                             java.lang.String attachmentName)
                                      throws java.lang.Exception

Adds an attachment to the email

Parameters:

file - the DBFile to be added

attachmentName - - the attachmentName to overwrite file name when sending

Returns:

the attachment

Throws:

java.lang.Exception - a serious problem.

addAttachment

@Nonnull
public MailAttachment addAttachment(@Nonnull
                                             MailAttachment ma)
                                      throws java.lang.Exception

Adds an attachment to the email

Parameters:

ma - the attachment

Returns:

the attachment

Throws:

java.lang.Exception - a serious problem.

addAttachment

@Nonnull
public MailAttachment addAttachment(@Nonnull
                                             java.io.File file,
                                             @Nullable
                                             java.lang.String attachmentName)
                                      throws java.lang.Exception

Adds an attachment to the email

Parameters:

file - the File to be added

attachmentName - - the attachmentName to overwrite file name when sending

Returns:

the attachment

Throws:

java.lang.Exception - a serious problem.

listAttachments

@CheckReturnValue
 @Nonnull
public MailAttachment[] listAttachments()

Returns the list of attachments for this email The returned objects can be a combination of File and DBFile objects

Returns:

the list of attachments

getMessage

@CheckReturnValue
 @Nonnull
public MimeMessage getMessage()
                                                   throws java.lang.Exception

Constructs the email

Returns:

the message

Throws:

java.lang.Exception - a serious problem

send

public void send()
          throws java.lang.Exception

Constructs the email and sends to SMTP server error codes

Throws:

java.lang.Exception - a serious problem

generateMimeBody

@CheckReturnValue
 @Nonnull
public java.lang.String generateMimeBody()
                                                              throws java.lang.Exception

Generate the mime body

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

makeHTML

@CheckReturnValue
 @Nonnull
public java.lang.String makeHTML()
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

constructMessage

@CheckReturnValue
 @Nonnull
protected MimeMessage constructMessage(@Nonnull
                                                                   Session session)
                                                            throws java.lang.Exception

Parameters:

session - - the current SMTP session

Returns:

A MimeMessage constructed using current settings

Throws:

java.lang.Exception - a serious problem

addAttachments

@Nullable
protected MimeMultipart addAttachments(MimeMultipart mp,
                                                 java.lang.String sendHTML)
                                          throws java.lang.Exception

Creates body elements for each attachment and adds to supplied MimeMultipart

Parameters:

mp - - the multi part object to add the embed attachments to if not other attachments

sendHTML - the HTML that is being sent

Returns:

MimeMultipart object, this is the main object which contains message body and the rest of attachments

Throws:

java.lang.Exception - a serious problem