blob: 0a32ac02d0a7f5aa9a9053f4fa0d351f60913a08 [file] [log] [blame]
<?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 html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Apr 17, 2012 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
Samples</title>
<style type="text/css" media="all">
@import url("./css/james.css");
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
@import url("./js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css");
@import url("./js/jquery/css/print.css");
@import url("./js/fancybox/jquery.fancybox-1.3.4.css");
</style>
<script type="text/javascript" src="./js/jquery/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="./js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script>
<script type="text/javascript" src="./js/fancybox/jquery.fancybox-1.3.4.js"></script>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20120417" />
<meta http-equiv="Content-Language" content="en" />
<link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/>
<!-- Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-1384591-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body class="composite">
<div id="banner">
<a href="../" id="bannerLeft" title="james-mime4j-logo.gif">
<img src="images/logos/james-mime4j-logo.gif" alt="JAMES Mime4J" />
</a>
<a href="http://www.apache.org/index.html" id="bannerRight">
<img src="images/logos/asf-logo-reduced.gif" alt="The Apache Software Foundation" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 2012-04-17</span>
</div>
<div class="xright"> <a href="../index.html" title="Home">Home</a>
|
<a href="../server/index.html" title="Server">Server</a>
|
<a href="../hupa/index.html" title="Hupa">Hupa</a>
|
<a href="../protocols/index.html" title="Protocols">Protocols</a>
|
<a href="../imap/index.html" title="IMAP">IMAP</a>
|
<a href="../mailet/index.html" title="Mailets">Mailets</a>
|
<a href="../mailbox/index.html" title="Mailbox">Mailbox</a>
|
<a href="index.html" title="Mime4J">Mime4J</a>
|
<a href="../jsieve/index.html" title="jSieve">jSieve</a>
|
<a href="../jspf/index.html" title="jSPF">jSPF</a>
|
<a href="../jdkim/index.html" title="jDKIM">jDKIM</a>
|
<a href="../mpt/index.html" title="MPT">MPT</a>
|
<a href="../postage/index.html" title="Postage">Postage</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Documentation</h5>
<ul>
<li class="none">
<a href="index.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="status.html" title="Status">Status</a>
</li>
<li class="none">
<strong>Example</strong>
</li>
<li class="none">
<a href="usage.html" title="Usage">Usage</a>
</li>
</ul>
<h5>Developers Corner</h5>
<ul>
<li class="none">
<a href="start/download.html" title="Download">Download</a>
</li>
<li class="none">
<a href="start/build.html" title="Build">Build</a>
</li>
</ul>
<h5>References</h5>
<ul>
<li class="none">
<a href="apidocs/index.html" title="Javadoc">Javadoc</a>
</li>
<li class="none">
<a href="http://issues.apache.org/jira/browse/MIME4J/" title="Issue Tracker">Issue Tracker</a>
</li>
</ul>
<h5>Related Projects</h5>
<ul>
<li class="none">
<a href="http://hc.apache.org/httpcomponents-client/httpmime/index.html" title="httpmime">httpmime</a>
</li>
</ul>
<h5>About James</h5>
<ul>
<li class="none">
<a href="../index.html" title="Overview">Overview</a>
</li>
<li class="none">
<a href="../newsarchive.html" title="News">News</a>
</li>
<li class="none">
<a href="../mail.html" title="Mailing Lists">Mailing Lists</a>
</li>
<li class="none">
<a href="../contribute.html" title="Contributing">Contributing</a>
</li>
<li class="none">
<a href="../guidelines.html" title="Guidelines">Guidelines</a>
</li>
<li class="none">
<a href="http://wiki.apache.org/james" title="Wiki">Wiki</a>
</li>
<li class="none">
<a href="../team-list.html" title="Who We Are">Who We Are</a>
</li>
<li class="none">
<a href="../license.html" title="License">License</a>
</li>
</ul>
<h5>Download</h5>
<ul>
<li class="none">
<a href="../download.cgi" title="Releases">Releases</a>
</li>
<li class="none">
<a href="https://repository.apache.org/content/repositories/snapshots/org/apache/james/" title=""></a>
</li>
</ul>
<h5>Apache Software Foundation</h5>
<ul>
<li>
<strong>
<a title="ASF" href="http://www.apache.org/">ASF</a>
</strong>
</li>
<li>
<a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a>
</li>
<li>
<a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a>
</li>
<li>
<a title="License" href="http://www.apache.org/licenses/" >License</a>
</li>
<li>
<a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
</li>
<li>
<a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
</li>
<li>
<a title="Security" href="http://www.apache.org/security/">Security</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<!-- /****************************************************************
* 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. *
****************************************************************/ -->
<div class="section"><h2>Samples<a name="Samples"></a></h2>
<p>
The Mime4j distribution includes samples
which demonstrate how the library could be used. This section
gives you a short review of those samples. For more information
you should download the distribution and study the sample sources.
The samples are in the <tt>examples/</tt> sub-directory.
</p>
<table border="0" class="bodyTable">
<tr class="a">
<th>Sample</th>
<th>Description</th>
</tr>
<tr class="b">
<td>
<tt>org.apache.james.mime4j.samples.tree.MessageTree</tt>
</td>
<td>Displays a tree of the contents of a
Mime4j <tt>Message</tt> object in a Swing GUI.
To try it out run
<blockquote>
<tt>java org.apache.james.mime4j.samples.tree.MessageTree path/to/message.msg</tt>
</blockquote>
The output is very useful if
you want the study the structure of MIME messages.
</td>
</tr>
<tr class="a">
<td>
<tt>org.apache.james.mime4j.samples.transform.TransformMessage</tt>
</td>
<td>Illustrate how to transform a message into another message without
modifying the original.
</td>
</tr>
<tr class="b">
<td>
<tt>org.apache.james.mime4j.samples.dom.TextPlainMessage</tt>
</td>
<td>Illustrate the use of Mime4j DOM API. This example generates a message
very similar to the one from
<a class="externalLink" href="http://www.rfc-editor.org/rfc/rfc5322.txt">RFC 5322</a>
Appendix A.1.1.
</td>
</tr>
<tr class="a">
<td>
<tt>org.apache.james.mime4j.samples.dom.MultipartMessage</tt>
</td>
<td>Illustrate the use of Mime4j DOM API. This example creates a
multipart/mixed message that consists of a text/plain and an image/png
part. The image is created on the fly; a similar technique can be used
to create PDF or XML attachments, for example.
</td>
</tr>
<!-- <tr>
<td>
<code>org.apache.james.mime4j.samples.sax.Mime2Sax</code>
</td>
<td></td>
</tr>
<tr>
<td>
<code>org.apache.james.mime4j.samples.pgp.PGPSignatureVerifier</code>
</td>
<td></td>
</tr> -->
</table>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">Copyright &#169; 2004-2012
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>