src/documentation/content/xdocs/components/hsmf/index.xml - poi - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!--
    ====================================================================
    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.
    ====================================================================
 -->
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

 <document>
     <header>
         <title>POI-HSMF - Java API To Access Microsoft Outlook MSG Files</title>
         <subtitle>Overview</subtitle>
         <authors>
             <person name="Nick Burch" email="nick at apache dot org"/>
             <person name="Travis Ferguson" email="uniformstupidity at gmail dot com"/>
         </authors>
     </header>

     <body>
         <section>
             <title>Overview</title>

             <p>HSMF is the POI Project's pure Java implementation of the Outlook MSG format.</p>
             <p>At this time, it provides low-level read access to all of the file, along
 			    with a user-facing way to get at the common textual content of MSG files.
              to all</p>
             <p>There is an example MSG textual renderer, which shows how to access the
              common parts such as sender, subject, message body and examples. This is
              in the
                 <a href="https://github.com/apache/poi/tree/trunk/poi-examples/src/main/java/org/apache/poi/examples/hsmf/">HSMF examples area</a>
              of SVN. You may also wish to look at the unit tests for more use guides.</p>

          <note>
             This code currently lives the
             <a href="https://github.com/apache/poi/tree/trunk/poi-scratchpad/src/main/java">scratchpad area</a>
             of the POI Git repository. To use this component, ensure
             you have the Scratchpad Jar on your classpath, or a dependency
             defined on the <em>poi-scratchpad</em> artifact - the main POI
             jar is not enough! See the
             <a href="site:components">POI Components Map</a>
             for more details.
 			</note>
          <note>
             This code is subject to change between versions, and being
             "scratchpad", doesn't maintain the usual Apache POI backwards
             compatibility guarantees. In particular, the way that property
             values are fetched is expected to change soon, as part of the
             work to improve fixed-length property support.
          </note>
         </section>
     </body>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>
	<!--
	====================================================================
	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.
	====================================================================
	-->
	<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "document-v20.dtd">

	<document>
	<header>
	<title>POI-HSMF - Java API To Access Microsoft Outlook MSG Files</title>
	<subtitle>Overview</subtitle>
	<authors>
	<person name="Nick Burch" email="nick at apache dot org"/>
	<person name="Travis Ferguson" email="uniformstupidity at gmail dot com"/>
	</authors>
	</header>

	<body>
	<section>
	<title>Overview</title>

	<p>HSMF is the POI Project's pure Java implementation of the Outlook MSG format.</p>
	<p>At this time, it provides low-level read access to all of the file, along
	with a user-facing way to get at the common textual content of MSG files.
	to all</p>
	<p>There is an example MSG textual renderer, which shows how to access the
	common parts such as sender, subject, message body and examples. This is
	in the
	<a href="https://github.com/apache/poi/tree/trunk/poi-examples/src/main/java/org/apache/poi/examples/hsmf/">HSMF examples area</a>
	of SVN. You may also wish to look at the unit tests for more use guides.</p>

	<note>
	This code currently lives the
	<a href="https://github.com/apache/poi/tree/trunk/poi-scratchpad/src/main/java">scratchpad area</a>
	of the POI Git repository. To use this component, ensure
	you have the Scratchpad Jar on your classpath, or a dependency
	defined on the <em>poi-scratchpad</em> artifact - the main POI
	jar is not enough! See the
	<a href="site:components">POI Components Map</a>
	for more details.
	</note>
	<note>
	This code is subject to change between versions, and being
	"scratchpad", doesn't maintain the usual Apache POI backwards
	compatibility guarantees. In particular, the way that property
	values are fetched is expected to change soon, as part of the
	work to improve fixed-length property support.
	</note>
	</section>
	</body>
	</document>