com.jivesoftware.community
Class EmailMessage

java.lang.Object
  com.jivesoftware.community.EmailMessage

All Implemented Interfaces:

java.io.Serializable

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

Represents an Email message that can be sent using EmailManager

See Also:

EmailManager, Serialized Form

Nested Class Summary

static class

EmailMessage.EmailAddress Represents an email address with a name like Andrew Wright <andrew@jivesoftware.com>

Field Summary

static java.lang.String	FOOTER_PROPERTY
static java.lang.String	HEADER_PROPERTY

Constructor Summary

EmailMessage()

Method Summary

void	addAttachment(com.jivesoftware.util.InputStreamDataSource attachment) Adds an attachment for this email message
void	addRecipient(EmailMessage.EmailAddress emailAddress) Adds a recipient (to address) for this email message
void	addRecipient(java.lang.String name, java.lang.String email) Adds a recipient (to address) for this email message
boolean	equals(java.lang.Object o)
java.util.Collection<DataSource>	getAttachments() Returns the attachments of the email
java.util.Map<java.lang.String,java.lang.Object>	getContext() Returns a map of replacement tokens to use in the email
java.lang.String	getHtmlBody() Returns the html version of the body
java.lang.String	getHtmlBodyProperty()
java.util.Locale	getLocale() Return the locale for the email message.
java.util.Collection<EmailMessage.EmailAddress>	getRecipients() Returns the recipients of the email
EmailMessage.EmailAddress	getReplyTo()
EmailMessage.EmailAddress	getSender() Returns the sender of them email
java.lang.String	getSubject() Returns the subject of the email.
java.lang.String	getSubjectProperty() Returns the property name for subject of the email
java.lang.String	getTextBody() Returns the text version of the body.
java.lang.String	getTextBodyProperty() Return the property name for the html version of the email body
int	hashCode()
boolean	isBccSender() If copySender is set to true, the sender will be BCCed on the message.
boolean	isIncludeHeaderAndFooter()
void	setBccSender(boolean bccSender) If copySender is set to true, the sender will be BCCed on the message.
void	setContext(java.util.Map<java.lang.String,java.lang.Object> context) Sets the context map.
void	setHtmlBody(java.lang.String htmlBody) Sets the text version of the body.
void	setHtmlBodyProperty(java.lang.String htmlBodyProperty)
void	setIncludeHeaderAndFooter(boolean includeHeaderAndFooter)
void	setLocale(java.util.Locale locale) Set the locale for the email message.
EmailMessage	setReplyTo(EmailMessage.EmailAddress replyTo) Sets the reply-to header for the email.
EmailMessage	setReplyTo(java.lang.String name, java.lang.String email) Sets the reply-to header for the email.
void	setSender(EmailMessage.EmailAddress sender) Sets the address the email is sent from.
void	setSender(java.lang.String name, java.lang.String email) Sets the address the email is sent from.
void	setShouldFreemarkerParse(boolean shouldFreemarkerParse)
void	setSubject(java.lang.String subject) Sets the subject of the email.
void	setSubjectProperty(java.lang.String subjectProperty) Sets the email's subject property name
void	setTextBody(java.lang.String textBody) Sets the text version of the body.
void	setTextBodyProperty(java.lang.String textBodyProperty) Set the property name for the html version of the email body
boolean	shouldFreemarkerParse()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HEADER_PROPERTY

public static final java.lang.String HEADER_PROPERTY

See Also:

Constant Field Values

FOOTER_PROPERTY

public static final java.lang.String FOOTER_PROPERTY

See Also:

Constant Field Values

Constructor Detail

EmailMessage

public EmailMessage()

Method Detail

addAttachment

public void addAttachment(com.jivesoftware.util.InputStreamDataSource attachment)

Adds an attachment for this email message

Parameters:

attachment - the data source representing the email message attachment

addRecipient

public void addRecipient(EmailMessage.EmailAddress emailAddress)

Adds a recipient (to address) for this email message

Parameters:

emailAddress - the recipient's address

addRecipient

public void addRecipient(java.lang.String name,
                         java.lang.String email)

Adds a recipient (to address) for this email message

Parameters:

name - the name of the recipient

email - the email address of the recipient

setSender

public void setSender(java.lang.String name,
                      java.lang.String email)

Sets the address the email is sent from.

Parameters:

name - Name of the sender

email - Email address of the sender

setSender

public void setSender(EmailMessage.EmailAddress sender)

Sets the address the email is sent from.

Sender only needs to be set if it is different than the system default.

Parameters:

sender - The sender's email address

setBccSender

public void setBccSender(boolean bccSender)

If copySender is set to true, the sender will be BCCed on the message. Default is false.

Parameters:

bccSender - Whether or not to copy the sender on the email.

isBccSender

public boolean isBccSender()

If copySender is set to true, the sender will be BCCed on the message. Default is false.

Returns:

Whether or not to copy the sender on the email.

setReplyTo

public EmailMessage setReplyTo(java.lang.String name,
                               java.lang.String email)

Sets the reply-to header for the email.

Parameters:

name - the name of the entity who replies should be sent to for this email.

email - the email address of the entity to whom replies are to be sent.

Returns:

this

setReplyTo

public EmailMessage setReplyTo(EmailMessage.EmailAddress replyTo)

Sets the reply-to header for the email.

Parameters:

replyTo - the email address of the entity to whom replies are to be sent.

Returns:

this

getReplyTo

public EmailMessage.EmailAddress getReplyTo()

setSubjectProperty

public void setSubjectProperty(java.lang.String subjectProperty)

Sets the email's subject property name

Parameters:

subjectProperty - the email's subject

setTextBodyProperty

public void setTextBodyProperty(java.lang.String textBodyProperty)

Set the property name for the html version of the email body

Parameters:

textBodyProperty - the property name for the html version of the email body

getAttachments

public java.util.Collection<DataSource> getAttachments()

Returns the attachments of the email

Returns:

the attachments of the email

getRecipients

public java.util.Collection<EmailMessage.EmailAddress> getRecipients()

Returns the recipients of the email

Returns:

the recipients of the email

getSender

public EmailMessage.EmailAddress getSender()

Returns the sender of them email

Returns:

the sender of the email

getSubjectProperty

public java.lang.String getSubjectProperty()

Returns the property name for subject of the email

Returns:

the property name for subject of the email

getSubject

public java.lang.String getSubject()

Returns the subject of the email. Should be specified if subjectProperty is not specified.

Returns:

the subject of the email.

setSubject

public void setSubject(java.lang.String subject)

Sets the subject of the email. Should be specified if subjectProperty is not specified.

Parameters:

subject - the subject of the email.

getTextBodyProperty

public java.lang.String getTextBodyProperty()

Return the property name for the html version of the email body

Returns:

the property name for the html version of the email body

getTextBody

public java.lang.String getTextBody()

Returns the text version of the body.

Returns:

the text version of the body.

setTextBody

public void setTextBody(java.lang.String textBody)

Sets the text version of the body.

Parameters:

textBody - the text version of the body.

getHtmlBody

public java.lang.String getHtmlBody()

Returns the html version of the body

Returns:

the htmlVersion of the body.

setHtmlBody

public void setHtmlBody(java.lang.String htmlBody)

Sets the text version of the body.

Parameters:

htmlBody - the text version of the body.

getLocale

public java.util.Locale getLocale()

Return the locale for the email message. This in conjunction with the body|subject property name will be used to acquire the correct email content

Returns:

the locale for the email message

setLocale

public void setLocale(java.util.Locale locale)

Set the locale for the email message. This in conjunction with the body|subject property name will be used to acquire the correct email content

Parameters:

locale - the locale for the email message

getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()

Returns a map of replacement tokens to use in the email

Returns:

a map of replacement tokens

setContext

public void setContext(java.util.Map<java.lang.String,java.lang.Object> context)

Sets the context map.

Parameters:

context - the context.

getHtmlBodyProperty

public java.lang.String getHtmlBodyProperty()

setHtmlBodyProperty

public void setHtmlBodyProperty(java.lang.String htmlBodyProperty)

shouldFreemarkerParse

public boolean shouldFreemarkerParse()

setShouldFreemarkerParse

public void setShouldFreemarkerParse(boolean shouldFreemarkerParse)

isIncludeHeaderAndFooter

public boolean isIncludeHeaderAndFooter()

setIncludeHeaderAndFooter

public void setIncludeHeaderAndFooter(boolean includeHeaderAndFooter)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object