org.simplejavamail.outlookmessageparser

Class OutlookMessageParser

java.lang.Object

org.simplejavamail.outlookmessageparser.OutlookMessageParser

public class OutlookMessageParser
extends Object

Main parser class that does the actual parsing of the Outlook .msg file. It uses the POI library for parsing the .msg container file and is based on a description posted by Peter Fiskerstrand at fileformat.info.

It parses the .msg file and stores the information in a OutlookMessage object. Attachments are put into an OutlookFileAttachment object. Hence, please keep in mind that the complete mail is held in the memory! If an attachment is another .msg file, this attachment is not processed as a normal attachment but rather included as a OutlookMsgAttachment. This attached mail is, again, a OutlookMessage object and may have further outlookAttachments and so on.

Furthermore there is a feature which allows us to extract HTML bodies when only RTF bodies are available. In order to achieve this a conversion class implementing RTF2HTMLConverter is used. This can be overridden with a custom implementation as well (see code below for an example).

Note: this code has not been tested on a wide range of .msg files. Use in production level (as in any other level) at your own risk.

Usage:

OutlookMessageParser msgp = new OutlookMessageParser();
msgp.setRtf2htmlConverter(new SimpleRTF2HTMLConverter()); //optional (if you want to use your own implementation)
OutlookMessage msg = msgp.parseMsg("test.msg");

Constructor Summary

Constructors

Constructor and Description
OutlookMessageParser()

Method Summary

Modifier and Type	Method and Description
OutlookMessage	parseMsg(@NotNull File msgFile) Parses a .msg file provided in the specified file.
OutlookMessage	parseMsg(@NotNull InputStream msgFileInputStream) Parses a .msg file provided by an input stream.
OutlookMessage	parseMsg(@NotNull String msgFile) Parses a .msg file provided in the specified file.
void	setRtf2htmlConverter(org.bbottema.rtftohtml.RTF2HTMLConverter rtf2htmlConverter) Setter for overriding the default RTF2HTMLConverter implementation which is used to get HTML code from an RTF body.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutlookMessageParser

public OutlookMessageParser()

Method Detail

parseMsg

public OutlookMessage parseMsg(@NotNull
                               @NotNull File msgFile)
                        throws IOException

Parses a .msg file provided in the specified file.

Parameters:

msgFile - The .msg file.

Returns:

A OutlookMessage object representing the .msg file.

Throws:

IOException - Thrown if the file could not be loaded or parsed.

parseMsg

public OutlookMessage parseMsg(@NotNull
                               @NotNull String msgFile)
                        throws IOException

Parses a .msg file provided in the specified file.

Parameters:

msgFile - The .msg file as a String path.

Returns:

A OutlookMessage object representing the .msg file.

Throws:

IOException - Thrown if the file could not be loaded or parsed.

parseMsg

public OutlookMessage parseMsg(@NotNull
                               @NotNull InputStream msgFileInputStream)
                        throws IOException

Parses a .msg file provided by an input stream.

Parameters:

msgFileInputStream - The .msg file as a InputStream.

Returns:

A OutlookMessage object representing the .msg file.

Throws:

IOException - Thrown if the file could not be loaded or parsed.

setRtf2htmlConverter

public void setRtf2htmlConverter(org.bbottema.rtftohtml.RTF2HTMLConverter rtf2htmlConverter)

Setter for overriding the default RTF2HTMLConverter implementation which is used to get HTML code from an RTF body.

Parameters:

rtf2htmlConverter - The converter instance to be used.