|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.itim.mail.NotificationMessage
Represents an email message with recipients, subject, a plain text message, and an optional HTML message. Both a plain text AND HTML formatted body is supported within the same message.
Constructor Summary | |
---|---|
NotificationMessage()
Default constructor. |
|
NotificationMessage(java.util.Collection addresses,
java.lang.String subject,
java.lang.String textMessage,
java.lang.String htmlMessage)
The constructor of NotificationMessage. |
|
NotificationMessage(java.util.Collection addresses,
java.lang.String subject,
java.lang.String textMessage,
java.lang.String htmlMessage,
java.lang.String tenant,
java.lang.String locale)
The constructor of NotificationMessage when taking advantage of Post Office functionality. |
|
NotificationMessage(java.util.Collection addresses,
java.lang.String subject,
java.lang.String textMessage,
java.lang.String htmlMessage,
java.lang.String tenant,
java.lang.String topic,
java.lang.String locale)
The constructor of NotificationMessage when taking advantage of Post Office functionality. |
Method Summary | |
---|---|
java.util.Collection |
getEmailAddresses()
Returns the recipients of the message. |
java.lang.String |
getHtmlMessage()
Returns the HTML message body (if any). |
java.lang.String |
getLocale()
Returns the locale the message was written in. |
java.lang.String |
getMessage()
Returns the text message body. |
java.lang.String |
getSubject()
Returns the subject of the message. |
java.lang.String |
getTenant()
Returns the tenant of this message. |
java.lang.String |
getTopic()
Returns the topic of the message (if any). |
void |
setEmailAddresses(java.util.Collection addresses)
Changes the recipients of the message. |
void |
setHtmlMessage(java.lang.String htmlMessage)
Change sthe HTML message body. |
void |
setLocale(java.lang.String locale)
Changes the locale the message was written in. |
void |
setMessage(java.lang.String textMessage)
Changes the text body of the message. |
void |
setSubject(java.lang.String subject)
Changes the subject of the message. |
void |
setTenant(java.lang.String tenant)
Changes the tenant for this message. |
void |
setTopic(java.lang.String topic)
Changes the topic of the message. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public NotificationMessage()
public NotificationMessage(java.util.Collection addresses, java.lang.String subject, java.lang.String textMessage, java.lang.String htmlMessage)
addresses
- The collection of email address (Strings).subject
- The subject.textMessage
- The plain text message.htmlMessage
- The HTML message.public NotificationMessage(java.util.Collection addresses, java.lang.String subject, java.lang.String textMessage, java.lang.String htmlMessage, java.lang.String tenant, java.lang.String topic, java.lang.String locale)
addresses
- The collection of email address (Strings).subject
- The subject of the email. null means the email will have no SubjecttextMessage
- The plain text message of the email. null means the email content will have no
plain text.htmlMessage
- The HTML message of the email. null means the email content will have no HTML.tenant
- The short name of the tenant to use when applying email aggregation template. null means use the
system default tenant. NOTE: this is not the tenant DNtopic
- The topic to use for grouping emails. null means grouping is not desired.locale
- The locale of the recipient of this message (ie, en_US.public NotificationMessage(java.util.Collection addresses, java.lang.String subject, java.lang.String textMessage, java.lang.String htmlMessage, java.lang.String tenant, java.lang.String locale)
addresses
- The collection of email address (Strings).subject
- The subject of the email. null means the email will have no SubjecttextMessage
- The plain text message of the email. null means the email content will have no
plain text.htmlMessage
- The HTML message of the email. null means the email content will have no HTML.tenant
- The short name of the tenant to use when applying email aggregation template. null means use the
system default tenant. NOTE: this is not the tenant DNMethod Detail |
public java.util.Collection getEmailAddresses()
public void setEmailAddresses(java.util.Collection addresses)
addresses
- Collection of the new recipients (Strings).public java.lang.String getSubject()
public void setSubject(java.lang.String subject)
public java.lang.String getMessage()
public void setMessage(java.lang.String textMessage)
public java.lang.String getHtmlMessage()
public void setHtmlMessage(java.lang.String htmlMessage)
public java.lang.String getTopic()
public void setTopic(java.lang.String topic)
topic
- Topic of the message. An empty
string or null indicates the message does not have
a topic.public java.lang.String getLocale()
public void setLocale(java.lang.String locale)
locale
- Locale of the message.public java.lang.String getTenant()
public void setTenant(java.lang.String tenant)
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |