| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <html> |
| <head> |
| <title>Apache JAMES MailetDocs Maven Plugin - Plugin Documentation</title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="http://james.apache.org/mailet/index.html" id="bannerLeft"> |
| |
| <img src="images/james-mailetdocs-logo.gif" alt="" /> |
| |
| </a> |
| <a href="http://www.apache.org/index.html" id="bannerRight"> |
| |
| <img src="images/asf-logo-reduced.gif" alt="" /> |
| |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| |
| |
| |
| |
| |
| <div class="xleft"> |
| Last Published: 09/06/2009 |
| </div> |
| <div class="xright"> <a href="../../index.html">JAMES Project</a> |
| | |
| <a href="../../server/index.html">Server</a> |
| | |
| <a href="../../mailet/index.html">Mailets</a> |
| | |
| <a href="../../jspf/index.html">jSPF</a> |
| | |
| <a href="../../mime4j/index.html">Mime4J</a> |
| | |
| <a href="../../jsieve/index.html">JSieve</a> |
| | |
| <a href="../../postage/index.html">Postage</a> |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| |
| |
| |
| |
| |
| <h5>MailetDocs Maven Plugin</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="index.html">Introduction</a> |
| </li> |
| |
| <li class="none"> |
| <strong>Goals</strong> |
| </li> |
| |
| <li class="none"> |
| <a href="usage.html">Usage</a> |
| </li> |
| |
| <li class="none"> |
| <a href="release-notes.html">Release Notes</a> |
| </li> |
| |
| <li class="none"> |
| <a href="doap_maven-mailetdocs-plugin.rdf">DOAP</a> |
| </li> |
| </ul> |
| <h5>Examples</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="examples/standard.html">Large Catalog</a> |
| </li> |
| </ul> |
| <h5>Mailet</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/api">API</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/base">Basic Toolkit</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/crypto">Crypto</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/jsieve/mailet/index.html">Sieve</a> |
| </li> |
| |
| <li class="none"> |
| <a href="">MailetDocs</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://james.apache.org/mailet/standard">Standard</a> |
| </li> |
| </ul> |
| <h5>Project Documentation</h5> |
| <ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="collapsed"> |
| <a href="project-info.html">Project Information</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="expanded"> |
| <a href="project-reports.html">Project Reports</a> |
| <ul> |
| |
| <li class="none"> |
| <a href="apidocs/index.html">JavaDocs</a> |
| </li> |
| |
| <li class="none"> |
| <strong>Plugin Documentation</strong> |
| </li> |
| |
| <li class="none"> |
| <a href="rat-report.html">RAT Report</a> |
| </li> |
| |
| <li class="none"> |
| <a href="xref/index.html">Source Xref</a> |
| </li> |
| |
| <li class="none"> |
| <a href="surefire-report.html">Surefire Report</a> |
| </li> |
| |
| <li class="none"> |
| <a href="taglist.html">Tag List</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <h5>Downloads</h5> |
| <ul> |
| |
| <li class="none"> |
| <a href="../../download.cgi">Stable releases</a> |
| </li> |
| |
| <li class="none"> |
| <a href="../../downloadunstable.cgi">Unstable releases</a> |
| </li> |
| |
| <li class="none"> |
| <a href="http://people.apache.org/builds/james/nightly/">Nightly builds</a> |
| </li> |
| </ul> |
| <a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"> |
| <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img> |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| <div class="section"><h2>Plugin Documentation</h2><p>Goals available for this plugin:</p><table class="bodyTable"><tr class="a"><th>Goal</th><th>Report?</th><th>Description</th></tr><tr class="b"><td><a href="help-mojo.html">mailetdocs:help</a></td><td>No</td><td>Display help information on maven-mailetdocs-plugin.<br /> |
| Call |
| |
| <pre> |
| mvn mailetdocs:help -Ddetail=true -Dgoal=<goal-name> |
| </pre> |
| |
| to display parameter details.</td></tr><tr class="a"><td><a href="mailetdocs-mojo.html">mailetdocs:mailetdocs</a></td><td>Yes</td><td><p>Generates catalog and reports on mailets and matchers.</p> |
| |
| <h4>Notes</h4> |
| |
| <ul> |
| <li>Should only used as a report.</li> |
| |
| <li>Mailets are instantiated during report production.</li> |
| </ul></td></tr></table></div><div class="section"><h2>System Requirements</h2><p>The following specifies the minimum requirements to run this Maven plugin:</p><table class="bodyTable"><tr class="b"><td>Maven</td><td>2.0</td></tr><tr class="a"><td>JDK</td><td>1.4</td></tr><tr class="b"><td>Memory</td><td>No minimum requirement.</td></tr><tr class="a"><td>Disk Space</td><td>No minimum requirement.</td></tr></table></div><div class="section"><h2>Usage</h2><p>You should specify the version in your project's plugin configuration:</p><div class="source"><pre><project> |
| ... |
| <build> |
| <!-- To define the plugin version in your parent POM --> |
| <pluginManagement> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.james</groupId> |
| <artifactId>maven-mailetdocs-plugin</artifactId> |
| <version>0.2-SNAPSHOT</version> |
| </plugin> |
| ... |
| </plugins> |
| </pluginManagement> |
| <!-- To use the plugin goals in your POM or parent POM --> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.james</groupId> |
| <artifactId>maven-mailetdocs-plugin</artifactId> |
| <version>0.2-SNAPSHOT</version> |
| </plugin> |
| ... |
| </plugins> |
| </build> |
| ... |
| <!-- To use the report goals in your POM or parent POM --> |
| <reporting> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.james</groupId> |
| <artifactId>maven-mailetdocs-plugin</artifactId> |
| <version>0.2-SNAPSHOT</version> |
| </plugin> |
| ... |
| </plugins> |
| </reporting> |
| ... |
| </project> |
| </pre></div><p>For more information, see <a href="http://maven.apache.org/guides/mini/guide-configuring-plugins.html">"Guide to Configuring Plug-ins"</a></p></div> |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright">© |
| 2008-2009 |
| |
| The Apache Software Foundation |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"> |
| </script> |
| <script type="text/javascript"> |
| _uacct = "UA-1384591-1"; |
| urchinTracker(); |
| </script> |
| </body> |
| </html> |
