public class Message
extends java.lang.Object
fromEmail
).
Attachments are stored in the property
attachments
). An attachment may be
of the type MsgAttachment
which
represents another attached (encapsulated)
.msg object.Modifier and Type | Field and Description |
---|---|
protected java.util.List<Attachment> |
attachments
A list of all attachments (both
FileAttachment
and MsgAttachment ). |
protected java.lang.String |
bodyRTF
The body in RTF format (if available)
|
protected java.lang.String |
bodyText
The normalized body text.
|
protected java.util.Date |
date
Email Date
|
protected java.lang.String |
displayBcc
The displayed Bcc: field
|
protected java.lang.String |
displayCc
The displayed Cc: field
|
protected java.lang.String |
displayTo
The displayed To: field
|
protected java.lang.String |
fromEmail
The address part of From: mail address.
|
protected java.lang.String |
fromName
The name part of the From: mail address
|
protected java.lang.String |
headers
Email headers (if available)
|
protected static java.util.logging.Logger |
logger |
protected java.lang.String |
messageClass
The message class as defined in the .msg file.
|
protected java.lang.String |
messageId
The message Id.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
properties
Contains all properties that are not
covered by the special properties.
|
protected java.util.List<RecipientEntry> |
recipients
A list containing all recipients for this message
(which can be set in the 'to:', 'cc:' and 'bcc:' field, respectively).
|
protected java.lang.String |
subject
The mail's subject.
|
protected java.lang.String |
toEmail
The address part of To: mail address.
|
protected java.lang.String |
toName
The name part of the To: mail address
|
Constructor and Description |
---|
Message() |
Modifier and Type | Method and Description |
---|---|
void |
addAttachment(Attachment attachment) |
void |
addRecipient(RecipientEntry recipient) |
java.lang.String |
createMailString(java.lang.String mail,
java.lang.String name)
Convenience method for creating
an email address expression (including
the name, the address, or both).
|
java.util.List<Attachment> |
getAttachments() |
java.lang.String |
getBodyRTF() |
java.lang.String |
getBodyText() |
java.util.Date |
getDate() |
static java.util.Date |
getDateFromHeaders(java.lang.String headers)
Parses the message date from the mail headers.
|
java.lang.String |
getDisplayBcc() |
java.lang.String |
getDisplayCc() |
java.lang.String |
getDisplayTo() |
java.lang.String |
getFromEmail() |
java.lang.String |
getFromName() |
java.lang.String |
getHeaders() |
java.lang.String |
getMessageClass() |
java.lang.String |
getMessageId() |
java.util.Set<java.lang.String> |
getProperties() |
java.lang.Object |
getProperty(java.lang.String name) |
java.util.List<RecipientEntry> |
getRecipients() |
java.lang.String |
getSubject() |
java.lang.String |
getToEmail() |
java.lang.String |
getToName() |
void |
setAttachments(java.util.List<Attachment> attachments) |
void |
setBodyRTF(java.lang.String bodyRTF) |
void |
setBodyText(java.lang.String bodyText) |
void |
setDate(java.util.Date date) |
void |
setDisplayBcc(java.lang.String displayBcc) |
void |
setDisplayCc(java.lang.String displayCc) |
void |
setDisplayTo(java.lang.String displayTo) |
void |
setFromEmail(java.lang.String fromEmail) |
void |
setFromName(java.lang.String fromName) |
void |
setHeaders(java.lang.String headers) |
void |
setMessageClass(java.lang.String messageClass) |
void |
setMessageId(java.lang.String messageId) |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Sets the name/value pair in the
properties
map. |
void |
setRecipients(java.util.List<RecipientEntry> recipients) |
void |
setSubject(java.lang.String subject) |
void |
setToEmail(java.lang.String toEmail) |
void |
setToName(java.lang.String toName) |
java.lang.String |
toLongString()
Provides all information of this message object.
|
java.lang.String |
toString()
Provides a short representation of this .msg object.
|
protected static final java.util.logging.Logger logger
protected java.lang.String messageClass
protected java.lang.String messageId
protected java.lang.String fromEmail
protected java.lang.String fromName
protected java.lang.String toEmail
protected java.lang.String toName
protected java.lang.String subject
protected java.lang.String bodyText
protected java.lang.String displayTo
protected java.lang.String displayCc
protected java.lang.String displayBcc
protected java.lang.String bodyRTF
protected java.lang.String headers
protected java.util.Date date
protected java.util.List<Attachment> attachments
FileAttachment
and MsgAttachment
).protected java.util.Map<java.lang.String,java.lang.Object> properties
protected java.util.List<RecipientEntry> recipients
public void addAttachment(Attachment attachment)
public void addRecipient(RecipientEntry recipient)
public void setProperty(java.lang.String name, java.lang.Object value) throws java.lang.ClassCastException
properties
map. Some properties are put into
special attributes (e.g., toEmail
when
the property name is '0076').name
- The property name (i.e., the class
of the document entry).value
- The value of the field.java.lang.ClassCastException
- Thrown if the detected data
type does not match the expected data type.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public java.lang.String toLongString()
public java.lang.String createMailString(java.lang.String mail, java.lang.String name)
mail
- The mail address.name
- The name part of the address.public java.util.List<Attachment> getAttachments()
public void setAttachments(java.util.List<Attachment> attachments)
attachments
- the attachments to setpublic java.util.List<RecipientEntry> getRecipients()
public void setRecipients(java.util.List<RecipientEntry> recipients)
recipients
- the recipients to setpublic java.lang.String getBodyText()
public void setBodyText(java.lang.String bodyText)
bodyText
- the bodyText to setpublic java.lang.String getFromEmail()
public void setFromEmail(java.lang.String fromEmail)
fromEmail
- the fromEmail to setpublic java.lang.String getFromName()
public void setFromName(java.lang.String fromName)
fromName
- the fromName to setpublic java.lang.String getDisplayTo()
public void setDisplayTo(java.lang.String displayTo)
public java.lang.String getDisplayCc()
public void setDisplayCc(java.lang.String displayCc)
public java.lang.String getDisplayBcc()
public void setDisplayBcc(java.lang.String displayBcc)
public java.lang.String getMessageClass()
public void setMessageClass(java.lang.String messageClass)
messageClass
- the messageClass to setpublic java.lang.String getMessageId()
public void setMessageId(java.lang.String messageId)
messageId
- the messageId to setpublic java.lang.String getSubject()
public void setSubject(java.lang.String subject)
subject
- the subject to setpublic java.lang.String getToEmail()
public void setToEmail(java.lang.String toEmail)
toEmail
- the toEmail to setpublic java.lang.String getToName()
public void setToName(java.lang.String toName)
toName
- the toName to setpublic java.lang.String getBodyRTF()
public void setBodyRTF(java.lang.String bodyRTF)
bodyRTF
- the bodyRTF to setpublic java.lang.String getHeaders()
public void setHeaders(java.lang.String headers)
headers
- the headers to setpublic static java.util.Date getDateFromHeaders(java.lang.String headers)
headers
- The headers in a single String objectpublic java.util.Date getDate()
public void setDate(java.util.Date date)
date
- the date to setpublic java.util.Set<java.lang.String> getProperties()
public java.lang.Object getProperty(java.lang.String name)
This software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.