|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.POIDocument org.apache.poi.hsmf.MAPIMessage
public class MAPIMessage
Reads an Outlook MSG File in and provides hooks into its data structure. If you want to develop with HSMF, you might find it worth getting some of the microsoft public documentation, such as: [MS-OXCMSG]: Message and Attachment Object Protocol Specification
Field Summary |
---|
Fields inherited from class org.apache.poi.POIDocument |
---|
directory |
Constructor Summary | |
---|---|
MAPIMessage()
Constructor for creating new files. |
|
MAPIMessage(DirectoryNode poifsDir)
Constructor for reading MSG Files from a certain point within a POIFS filesystem |
|
MAPIMessage(DirectoryNode poifsDir,
POIFSFileSystem fs)
Deprecated. Use MAPIMessage(DirectoryNode) instead |
|
MAPIMessage(java.io.InputStream in)
Constructor for reading MSG Files from an input stream. |
|
MAPIMessage(NPOIFSFileSystem fs)
Constructor for reading MSG Files from a POIFS filesystem |
|
MAPIMessage(POIFSFileSystem fs)
Constructor for reading MSG Files from a POIFS filesystem |
|
MAPIMessage(java.lang.String filename)
Constructor for reading MSG Files from the file system. |
Method Summary | |
---|---|
AttachmentChunks[] |
getAttachmentFiles()
Gets the message attachments. |
java.lang.String |
getConversationTopic()
Gets the conversation topic of the parsed Outlook Message. |
java.lang.String |
getDisplayBCC()
Gets the display value of the "BCC" line of the outlook message. |
java.lang.String |
getDisplayCC()
Gets the display value of the "CC" line of the outlook message. |
java.lang.String |
getDisplayFrom()
Gets the display value of the "FROM" line of the outlook message This is not the actual address that was sent from but the formated display of the user name. |
java.lang.String |
getDisplayTo()
Gets the display value of the "TO" line of the outlook message. |
java.lang.String[] |
getHeaders()
Returns all the headers, one entry per line |
java.lang.String |
getHmtlBody()
Deprecated. |
java.lang.String |
getHtmlBody()
Gets the html body of this Outlook Message, if this email contains a html version. |
Chunks |
getMainChunks()
Gets the main, core details chunks |
java.lang.String |
getMessageClass()
Gets the message class of the parsed Outlook Message. |
java.util.Calendar |
getMessageDate()
Gets the date that the message was accepted by the server on. |
NameIdChunks |
getNameIdChunks()
Gets the Name ID chunks, or null if there aren't any |
RecipientChunks[] |
getRecipientDetailsChunks()
Gets all the recipient details chunks. |
java.lang.String |
getRecipientEmailAddress()
Returns all the recipients' email address, separated by semicolons. |
java.lang.String[] |
getRecipientEmailAddressList()
Returns an array of all the recipient's email address, normally in TO then CC then BCC order. |
java.lang.String |
getRecipientNames()
Returns all the recipients' names, separated by semicolons. |
java.lang.String[] |
getRecipientNamesList()
Returns an array of all the recipient's names, normally in TO then CC then BCC order. |
java.lang.String |
getRtfBody()
Gets the RTF Rich Message body of this Outlook Message, if this email contains a RTF (rich) version. |
java.lang.String |
getStringFromChunk(StringChunk chunk)
Gets a string value based on the passed chunk. |
java.lang.String |
getSubject()
Gets the subject line of the Outlook Message |
java.lang.String |
getTextBody()
Gets the plain text body of this Outlook Message |
void |
guess7BitEncoding()
Many messages store their strings as unicode, which is nice and easy. |
boolean |
has7BitEncodingStrings()
Does this file contain any strings that are stored as 7 bit rather than unicode? |
boolean |
isReturnNullOnMissingChunk()
Will you get a null on a missing chunk, or a ChunkNotFoundException (default is the
exception). |
void |
set7BitEncoding(java.lang.String charset)
Many messages store their strings as unicode, which is nice and easy. |
void |
setReturnNullOnMissingChunk(boolean returnNullOnMissingChunk)
Sets whether on asking for a missing chunk, you get back null or a ChunkNotFoundException
(default is the exception). |
void |
write(java.io.OutputStream out)
Note - not yet supported, sorry. |
Methods inherited from class org.apache.poi.POIDocument |
---|
copyNodeRecursively, copyNodes, copyNodes, createInformationProperties, getDocumentSummaryInformation, getPropertySet, getSummaryInformation, readProperties, writeProperties, writeProperties, writePropertySet |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MAPIMessage()
public MAPIMessage(java.lang.String filename) throws java.io.IOException
filename
-
java.io.IOException
public MAPIMessage(java.io.InputStream in) throws java.io.IOException
in
-
java.io.IOException
public MAPIMessage(POIFSFileSystem fs) throws java.io.IOException
fs
-
java.io.IOException
public MAPIMessage(NPOIFSFileSystem fs) throws java.io.IOException
fs
-
java.io.IOException
@Deprecated public MAPIMessage(DirectoryNode poifsDir, POIFSFileSystem fs) throws java.io.IOException
MAPIMessage(DirectoryNode)
instead
java.io.IOException
public MAPIMessage(DirectoryNode poifsDir) throws java.io.IOException
poifsDir
-
java.io.IOException
Method Detail |
---|
public java.lang.String getStringFromChunk(StringChunk chunk) throws ChunkNotFoundException
ChunkNotFoundException
- if the chunk isn't therepublic java.lang.String getTextBody() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getHtmlBody() throws ChunkNotFoundException
ChunkNotFoundException
@Deprecated public java.lang.String getHmtlBody() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getRtfBody() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getSubject() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getDisplayFrom() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getDisplayTo() throws ChunkNotFoundException
RecipientChunks
.
ChunkNotFoundException
public java.lang.String getDisplayCC() throws ChunkNotFoundException
RecipientChunks
.
ChunkNotFoundException
public java.lang.String getDisplayBCC() throws ChunkNotFoundException
RecipientChunks
.
This will only be present in sent emails, not received ones!
ChunkNotFoundException
public java.lang.String getRecipientEmailAddress() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String[] getRecipientEmailAddressList() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getRecipientNames() throws ChunkNotFoundException
getDisplayTo()
, getDisplayCC()
and getDisplayBCC()
.
ChunkNotFoundException
public java.lang.String[] getRecipientNamesList() throws ChunkNotFoundException
getDisplayTo()
, getDisplayCC()
and getDisplayBCC()
.
ChunkNotFoundException
public void guess7BitEncoding()
public void set7BitEncoding(java.lang.String charset)
guess7BitEncoding()
public boolean has7BitEncodingStrings()
public java.lang.String[] getHeaders() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getConversationTopic() throws ChunkNotFoundException
ChunkNotFoundException
public java.lang.String getMessageClass() throws ChunkNotFoundException
ChunkNotFoundException
public java.util.Calendar getMessageDate() throws ChunkNotFoundException
ChunkNotFoundException
public Chunks getMainChunks()
public RecipientChunks[] getRecipientDetailsChunks()
getDisplayTo()
* CC recipients, in the order returned by getDisplayCC()
* BCC recipients, in the order returned by getDisplayBCC()
public NameIdChunks getNameIdChunks()
public AttachmentChunks[] getAttachmentFiles()
public void write(java.io.OutputStream out) throws java.io.IOException
write
in class POIDocument
java.io.IOException
public boolean isReturnNullOnMissingChunk()
ChunkNotFoundException
(default is the
exception).
public void setReturnNullOnMissingChunk(boolean returnNullOnMissingChunk)
ChunkNotFoundException
(default is the exception).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |