| <?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> | |
| Building mime4j</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"> | |
| <a href="../samples.html" title="Example">Example</a> | |
| </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"> | |
| <strong>Build</strong> | |
| </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>Building mime4j<a name="Building_mime4j"></a></h2> | |
| <div class="section"><h3>Using a Stable Release<a name="Using_a_Stable_Release"></a></h3> | |
| <p> Go to the <a class="externalLink" href="http://james.apache.org/download.cgi">download | |
| pages</a> and download the most recent | |
| release in your preferred format, either | |
| <tt>james-mime4j-x.y-src.tar.gz</tt> or <tt>james-mime4j-x.y-src.zip</tt>. | |
| Extracting the archived sources will create the directory | |
| <tt>james-mime4j-x.y/</tt>.</p> | |
| </div> | |
| <div class="section"><h3>Checking Out From Subversion<a name="Checking_Out_From_Subversion"></a></h3> | |
| <p> | |
| Issue the following commands in a shell: | |
| <blockquote> | |
| <tt>svn checkout http://svn.apache.org/repos/asf/james/mime4j/trunk james-mime4j</tt><br /> | |
| </blockquote> | |
| </p> | |
| </div> | |
| <div class="section"><h3>Download and Install Maven<a name="Download_and_Install_Maven"></a></h3> | |
| <p> You will need to download and install <a class="externalLink" href="http://maven.apache.org/">Maven</a> before building | |
| the sources. The build has been tested with version 2.0 of | |
| Maven so use this or a later version if possible. </p> | |
| <p> One of the main differences between Maven and plain ant is | |
| that Maven manages external dependencies for your projects | |
| and (at least in theory) you should no longer have to store | |
| third-party jar files in your source code tree. It maintains a local | |
| repository of versioned libraries and shares them between | |
| your Maven projects. If it can't find the necessary files | |
| there it will attempt to download them from the main Maven | |
| repository at www.ibiblio.org/maven. So to use the Maven | |
| build, you need to have a network connection available for | |
| the inital download of the project dependencies. </p> | |
| </div> | |
| <div class="section"><h3>Building the mime4j Jar<a name="Building_the_mime4j_Jar"></a></h3> | |
| <p> Once Maven has been installed, building the project should | |
| be as simple as typing <blockquote> | |
| <tt>cd james-mime4j-x.y/ (cd james-mime4j/ if sources come from | |
| Subversion)<br />mvn package</tt> | |
| </blockquote> from the command line. Maven will | |
| automatically run all test cases for you and create the | |
| jar file in the <tt>target</tt> directory. | |
| </p> | |
| <p> | |
| To install the jar into your local Maven repository run <blockquote> | |
| <tt>mvn install</tt></blockquote> | |
| </p> | |
| <p> | |
| To generate an Eclipse project from the sources run <blockquote> | |
| <tt>mvn eclipse:eclipse</tt></blockquote> | |
| </p> | |
| <p> | |
| <b>NOTE!</b> Mime4j uses <a class="externalLink" href="https://javacc.dev.java.net/">JavaCC</a> to generate parsers for | |
| header fields. If you're using an old version of maven eclipse pluing | |
| <tt>mvn eclipse:eclipse</tt> could have problems | |
| generating proper source folders for the JavaCC generated code. | |
| After running <tt>mvn eclipse:eclipse</tt> you must manually | |
| add <tt>target/generated-sources/javacc</tt> and | |
| <tt>target/generated-sources/jjtree</tt> as source folders | |
| under <i>Project -> Properties</i> in Eclipse. | |
| </p> | |
| <p> | |
| For more information on using | |
| Maven, have a look at the <a class="externalLink" href="http://maven.apache.org/">Maven web site</a>. </p> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| <div id="footer"> | |
| <div class="xright">Copyright © 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> |