|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.EmailMessage
public class EmailMessage
Represents an Email message that can be sent using EmailManager
EmailManager
,
Serialized FormNested Class Summary | |
---|---|
static class |
EmailMessage.EmailAddress
Represents an email address with a name like Andrew Wright <andrew@jivesoftware.com> |
Constructor Summary | |
---|---|
EmailMessage()
|
Method Summary | |
---|---|
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.Map |
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 |
getRecipients()
Returns the recipients of the email |
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()
|
void |
setHtmlBody(java.lang.String htmlBody)
Sets the text version of the body. |
void |
setHtmlBodyProperty(java.lang.String htmlBodyProperty)
|
void |
setLocale(java.util.Locale locale)
Set the locale for the email message. |
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 |
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 |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EmailMessage()
Method Detail |
---|
public void addRecipient(EmailMessage.EmailAddress emailAddress)
emailAddress
- the recipient's addresspublic void addRecipient(java.lang.String name, java.lang.String email)
name
- the name of the recipientemail
- the email address of the recipientpublic void setSender(java.lang.String name, java.lang.String email)
name
- Name of the senderemail
- Email address of the senderpublic void setSender(EmailMessage.EmailAddress sender)
sender
- The sender's email addresspublic void setSubjectProperty(java.lang.String subjectProperty)
subjectProperty
- the email's subjectpublic void setTextBodyProperty(java.lang.String textBodyProperty)
textBodyProperty
- the property name for the html version of the email bodypublic java.util.Collection getRecipients()
public EmailMessage.EmailAddress getSender()
public java.lang.String getSubjectProperty()
public java.lang.String getSubject()
public void setSubject(java.lang.String subject)
subject
- the subject of the email.public java.lang.String getTextBodyProperty()
public java.lang.String getTextBody()
public void setTextBody(java.lang.String textBody)
textBody
- the text version of the body.public java.lang.String getHtmlBody()
public void setHtmlBody(java.lang.String htmlBody)
htmlBody
- the text version of the body.public java.util.Locale getLocale()
public void setLocale(java.util.Locale locale)
locale
- the locale for the email messagepublic java.util.Map getContext()
public java.lang.String getHtmlBodyProperty()
public void setHtmlBodyProperty(java.lang.String htmlBodyProperty)
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |