| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <HTML> |
| <HEAD> |
| <TITLE>API Overview</TITLE> |
| </HEAD> |
| <BODY> |
| <p><b>Mime4j Core</b> provides a parser, |
| <a href="org/apache/james/mime4j/parser/MimeStreamParser.html">MimeStreamParser</a>, for |
| message streams in plain rfc822 and MIME format.</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.</p> |
| <p>The parser has been designed to be 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> |
| </BODY> |
| </HTML> |
