xdocs/samples.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!--
   3 /*
   4  *  Copyright 2004 the mime4j project
   5  *
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  */
  18  -->
  19 <document>
  20     <properties>
  21         <title>Samples</title>
  22     </properties>
  23     <body>
  24         <section name="Samples">
  25             <p>
  26             The mime4j distribution includes a number of sample applications
  27             which demonstrate how the library could be used. This section
  28             gives you a short review of those samples. For more information
  29             you should download the distribution and study the sample sources.
  30             The samples are in in <code>samples/</code> sub-directory.
  31             </p>
  32             <table>
  33                     <tr>
  34                         <th>Sample</th>
  35                         <th>Description</th>
  36                     </tr>
  37                     <tr>
  38                         <td>
  39                             <code>org.mime4j.samples.tree.MessageTree</code>
  40                         </td>
  41                         <td>Displays a tree of the contents of a
  42                             mime4j <code>Message</code> object in a Swing GUI.
  43                             To try it out run
  44                             <blockquote>
  45                              <code>java org.mime4j.samples.tree.MessageTree path/to/message.msg</code>
  46                             </blockquote>
  47                             The output is very useful if
  48                             you want the study the structure of MIME messages.
  49                             </td>
  50                     </tr>
  51                     <tr>
  52                         <td>
  53                             <code>org.mime4j.samples.sax.Mime2Sax</code>
  54                         </td>
  55                         <td></td>
  56                     </tr>
  57                     <tr>
  58                         <td>
  59                             <code>org.mime4j.samples.pgp.PGPSignatureVerifier</code>
  60                         </td>
  61                         <td></td>
  62                     </tr>
  63                 </table>
  64         </section>
  65     </body>
  66 </document>