Author: bago
Date: Thu Aug 7 02:40:43 2008
New Revision: 683566
URL: http://svn.apache.org/viewvc?rev=683566&view=rev
Log:
Add an overview for the apidocs including links to MimeStreamParser and Message
classes (MIME4J-51)
Added:
james/mime4j/trunk/src/main/javadoc/
james/mime4j/trunk/src/main/javadoc/overview.html (with props)
Added: james/mime4j/trunk/src/main/javadoc/overview.html
URL:
http://svn.apache.org/viewvc/james/mime4j/trunk/src/main/javadoc/overview.html?rev=683566&view=auto
==============================================================================
--- james/mime4j/trunk/src/main/javadoc/overview.html (added)
+++ james/mime4j/trunk/src/main/javadoc/overview.html Thu Aug 7 02:40:43 2008
@@ -0,0 +1,14 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+ <HEAD>
+ <TITLE>API Overview</TITLE>
+ </HEAD>
+ <BODY>
+<p><b>Mime4j</b> provides a parser, <a
href="org/apache/james/mime4j/parser/MimeStreamParser.html">MimeStreamParser</a>,
for e-mail message streams in plain rfc822 and MIME format and a <a
href="org/apache/james/mime4j/message/Message.html">Message</a> class used to
build a tree representation of an e-mail message.</p>
+
+<p>The parser uses a callback mechanism to report parsing events such as the
start of an entity header the start of a body, etc. If you are familiar with
the SAX XML parser interface you should have no problem getting started with
mime4j.</p>
+<p>The parser only deals with the structure of the message stream. It won't do
any decoding of base64 or quoted-printable encoded header fields and bodies.
This is intentional - the parser should only provide the most basic
functionality needed to build more complex parsers. However, mime4j does
include facilities to decode bodies and fields and the Message class described
below handles decoding of fields and bodies transparently.</p>
+<p>The parser has been designed to be extremely tolerant against messages
violating the standards. It has been tested using a large corpus (>5000) of
e-mail messages. As a benchmark the widely used perl MIME::Tools parser has
been used. mime4j and MIME:Tools rarely differ (<25 in those 5000). When they
do (which only occurs for illegally formatted spam messages) we think mime4j
does a better job.</p>
+<p><b>Mime4j</b> can also be used to build a tree representation of an e-mail
message using the <a
href="org/apache/james/mime4j/message/Message.html">Message</a> class. Using
this facility mime4j automatically handles the decoding of fields and bodies
and uses temporary files for large attachments. This representation is similar
to the representation constructed by the JavaMail API:s but is more tolerant to
messages violating the standards.</p>
+ </BODY>
+</HTML>
Propchange: james/mime4j/trunk/src/main/javadoc/overview.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: james/mime4j/trunk/src/main/javadoc/overview.html
------------------------------------------------------------------------------
svn:mime-type = text/plain
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
