|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.filenet.bso.api.collaboration.data.EmailInfo
The EmailInfo
class is a collection of data used to create a teamspace email
message.
A teamspace email message is created by generating a EmailInfo
object from
the CollaborationFactory
and adding it to the teamspace email container via it's
addContainee()
method.
CollaborationFactory
, Serialized FormConstructor Summary | |
protected |
EmailInfo()
The default constructor. |
|
EmailInfo(Teamspace teamspace,
javax.mail.internet.MimeMessage message,
java.lang.String ownerID,
boolean isDebug)
Construct the email info object. |
Method Summary | |
int |
getAttachmentCount()
Return the number of attachments in the email message. |
EmailSubpartInfo[] |
getAttachmentParts()
Get the message attachments. |
java.lang.String |
getCc()
Get the 'To' email header for the message. |
java.util.Date |
getDate()
Get the date sent as a Date . |
java.lang.String |
getDateString()
Get the date sent as a string. |
com.filenet.wcm.api.Folder |
getDirectContainer()
Get the folder that this email message will be placed into. |
java.lang.String |
getFrom()
Get the 'From' email header for the message. |
java.util.Enumeration |
getHeaders()
Get all the headers that are associated with the message. |
EmailSubpartInfo[] |
getInlineParts()
Get the inline/embedded parts of the message. |
java.lang.String |
getInOwnFolderName()
Get the inOwnFolderName property for the message. |
java.lang.String |
getInReplyTo()
Get the value of the In-Reply-To: message header. |
java.lang.String |
getMessageID()
Get the message ID for the email message. |
java.lang.String |
getOwnerID()
Get the member ID of the message creator (set to the special user ID used when running the collaboration's email server). |
com.filenet.wcm.api.Properties |
getProperties()
Return the entire set of properties for this email message. |
EmailSubpartInfo |
getRawMessage()
Get the raw message as a message/rfc822 subpart. |
java.lang.String |
getSubject()
Get the subject for the email message. |
Teamspace |
getTeamspace()
Get the teamspace that this email message belongs to. |
EmailSubpartInfo[] |
getTextParts()
Get the text parts of the message. |
java.lang.String |
getThreadID()
Return the MessageID of the first message in a thread. |
java.lang.String |
getTo()
Get the 'To' email header for the message. |
boolean |
isComplexMessage()
Test the message for "complex" construction (such as messages with inline/embedded parts). |
void |
setDirectContainer(com.filenet.wcm.api.Folder name)
Set the folder that this email message should be placed into. |
void |
setInOwnFolderName(java.lang.String name)
Set the inOwnFolderName property for the message. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected EmailInfo()
public EmailInfo(Teamspace teamspace, javax.mail.internet.MimeMessage message, java.lang.String ownerID, boolean isDebug) throws javax.mail.MessagingException
teamspace
- The teamspace in which the message is to be archivedmessage
- The raw messageownerID
- The LDAP SID of the user who will be granted CREATOR OWNER rights for this objectjavax.mail.MessagingException
- on any errorMethod Detail |
public java.util.Enumeration getHeaders() throws javax.mail.MessagingException
Header
objects.javax.mail.MessagingException
- if a problem with the message is encounteredpublic EmailSubpartInfo[] getTextParts()
EmailSubpartInfo
objects each represent one
alternative representation of the message.
For example, the first part might be a plain text message and
the second an HTML-formatted message. Normally, the MIME types of these
will be text/plain, text/html, text/rtf, etc., but a special case
is made for application/pdf, which is also considered a textual
representation.public EmailSubpartInfo[] getInlineParts()
public EmailSubpartInfo[] getAttachmentParts()
public java.util.Date getDate()
Date
.public java.lang.String getDateString()
public java.lang.String getFrom()
public java.lang.String getTo()
getHeaders()
method.getHeaders()
public java.lang.String getCc()
getHeaders()
method.getHeaders()
public java.lang.String getSubject()
public java.lang.String getMessageID()
public java.lang.String getInReplyTo()
public java.lang.String getThreadID()
public Teamspace getTeamspace()
public java.lang.String getOwnerID()
public EmailSubpartInfo getRawMessage()
null
unless the
isDebug
flag was set in the constructor.public int getAttachmentCount()
public boolean isComplexMessage()
true
if the message is complex, false
if notpublic java.lang.String getInOwnFolderName()
null
if not.public void setInOwnFolderName(java.lang.String name)
name
- the name of the folder into which the complex message is to
be placedpublic com.filenet.wcm.api.Folder getDirectContainer()
public void setDirectContainer(com.filenet.wcm.api.Folder name)
name
- the folderpublic com.filenet.wcm.api.Properties getProperties() throws javax.mail.MessagingException
javax.mail.MessagingException
- if something went wrong when retrieving the headers.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |