source: contrib/MailArchiver/sources/vendor/mime4j/custom/src/site/xdoc/samples.xml @ 6785

Revision 6785, 4.6 KB checked in by rafaelraymundo, 12 years ago (diff)

Ticket #2946 - Liberado codigo do MailArchiver?. Documentação na subpasta DOCS.
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!--
3/****************************************************************
4 * Licensed to the Apache Software Foundation (ASF) under one   *
5 * or more contributor license agreements.  See the NOTICE file *
6 * distributed with this work for additional information        *
7 * regarding copyright ownership.  The ASF licenses this file   *
8 * to you under the Apache License, Version 2.0 (the            *
9 * "License"); you may not use this file except in compliance   *
10 * with the License.  You may obtain a copy of the License at   *
11 *                                                              *
12 *   http://www.apache.org/licenses/LICENSE-2.0                 *
13 *                                                              *
14 * Unless required by applicable law or agreed to in writing,   *
15 * software distributed under the License is distributed on an  *
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
17 * KIND, either express or implied.  See the License for the    *
18 * specific language governing permissions and limitations      *
19 * under the License.                                           *
20 ****************************************************************/
21
22 -->
23<document>
24    <properties>
25        <title>Samples</title>
26    </properties>
27    <body>
28        <section name="Samples">
29            <p>
30            The Mime4j distribution includes samples
31            which demonstrate how the library could be used. This section
32            gives you a short review of those samples. For more information
33            you should download the distribution and study the sample sources.
34            The samples are in the <code>examples/</code> sub-directory.
35            </p>
36            <table>
37                    <tr>
38                        <th>Sample</th>
39                        <th>Description</th>
40                    </tr>
41                    <tr>
42                        <td>
43                            <code>org.apache.james.mime4j.samples.tree.MessageTree</code>
44                        </td>
45                        <td>Displays a tree of the contents of a
46                            Mime4j <code>Message</code> object in a Swing GUI.
47                            To try it out run
48                            <blockquote>
49                             <code>java org.apache.james.mime4j.samples.tree.MessageTree path/to/message.msg</code>
50                            </blockquote>
51                            The output is very useful if
52                            you want the study the structure of MIME messages.
53                            </td>
54                    </tr>
55                    <tr>
56                        <td>
57                            <code>org.apache.james.mime4j.samples.transform.TransformMessage</code>
58                        </td>
59                        <td>Illustrate how to transform a message into another message without
60                            modifying the original.
61                        </td>
62                    </tr>
63                    <tr>
64                        <td>
65                            <code>org.apache.james.mime4j.samples.dom.TextPlainMessage</code>
66                        </td>
67                        <td>Illustrate the use of Mime4j DOM API. This example generates a message
68                        very similar to the one from
69                        <a href="http://www.rfc-editor.org/rfc/rfc5322.txt">RFC 5322</a>
70                        Appendix A.1.1.
71                        </td>
72                    </tr>
73                    <tr>
74                        <td>
75                            <code>org.apache.james.mime4j.samples.dom.MultipartMessage</code>
76                        </td>
77                        <td>Illustrate the use of Mime4j DOM API. This example creates a
78                            multipart/mixed message that consists of a text/plain and an image/png
79                            part. The image is created on the fly; a similar technique can be used
80                            to create PDF or XML attachments, for example.
81                        </td>
82                    </tr>
83               <!--      <tr>
84                        <td>
85                            <code>org.apache.james.mime4j.samples.sax.Mime2Sax</code>
86                        </td>
87                        <td></td>
88                    </tr>
89                    <tr>
90                        <td>
91                            <code>org.apache.james.mime4j.samples.pgp.PGPSignatureVerifier</code>
92                        </td>
93                        <td></td>
94                    </tr> -->
95                </table>
96        </section>
97    </body>
98</document>
Note: See TracBrowser for help on using the repository browser.