Author: norman Date: Fri Aug 18 06:14:01 2006 New Revision: 432574 URL: http://svn.apache.org/viewvc?rev=432574&view=rev Log: Fix javadoc link
Added: james/site/trunk/www/server/mailet_api_2_3.html Added: james/site/trunk/www/server/mailet_api_2_3.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/server/mailet_api_2_3.html?rev=432574&view=auto ============================================================================== --- james/site/trunk/www/server/mailet_api_2_3.html (added) +++ james/site/trunk/www/server/mailet_api_2_3.html Fri Aug 18 06:14:01 2006 @@ -0,0 +1,257 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + + + + + + + + + +<html> + <head> + <title>James Server - + James 2.3 - Mailet API</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/index.html" id="bannerLeft"> + + <img src="images/james-server-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: 08/18/2006 + </div> + <div class="xright"> <a href="http://james.apache.org/index.html">JAMES Project</a> + | + <a href="">Server</a> + | + <a href="http://james.apache.org/jspf/index.html">jSPF</a> + | + <a href="http://james.apache.org/mime4j/index.html">Mime4J</a> + | + <a href="http://james.apache.org/jsieve/index.html">JSieve</a> + | + <a href="http://james.apache.org/postage/index.html">Postage</a> + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + + + + + + <h5>James</h5> + <ul> + + <li class="none"> + <a href="index.html">Overview</a> + </li> + + <li class="none"> + <a href="FAQ.html">James FAQ</a> + </li> + + <li class="none"> + <a href="mail.html">Mailing Lists</a> + </li> + + <li class="none"> + <a href="http://wiki.apache.org/james">Wiki</a> + </li> + </ul> + <h5>Documentation</h5> + <ul> + + <li class="none"> + <a href="documentation_2_1.html">James</a> + </li> + + <li class="none"> + <a href="design_objectives.html">Design</a> + </li> + + <li class="none"> + <a href="document_archive.html">Document Archive</a> + </li> + </ul> + <h5>Documentation 2.3B</h5> + <ul> + + <li class="none"> + <a href="documentation_2_3.html">James</a> + </li> + + <li class="none"> + <a href="design_objectives_2_3.html">Design</a> + </li> + + <li class="none"> + <a href="apidocs/index.html">James Javadocs</a> + </li> + + <li class="none"> + <a href="rfclist.html">Useful RFCs</a> + </li> + </ul> + <h5>Project</h5> + <ul> + + <li class="none"> + <a href="http://issues.apache.org/jira/browse/JAMES">Bug Database</a> + </li> + + <li class="none"> + <a href="http://svn.apache.org/viewvc/james/server/">Source Code</a> + </li> + + <li class="none"> + <a href="changelog.html">Changelog</a> + </li> + + <li class="none"> + <a href="todo.html">TODO</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + + + + + + + + + + + + + + + + + + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + + + + + + + + + + + + <li class="collapsed"> + <a href="project-reports.html">Project Reports</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"> + + + + + +<a name="Mailet API"></a><div class="section"><h2>Mailet API</h2> +<p>The Mailet API is a simple API used to build mail processing applications. James is a Mailet +container, allowing administrators to deploy Mailets (both custom and pre-made) to carry out a +variety of complex mail processing tasks. In the default configuration James uses Mailets to carry +out a number of tasks that are carried out deep in the source code of other mail servers (i.e. list +processing, remote and local delivery).</p> +<p> +As it stands today, the Mailet API defines interfaces for both Matchers and Mailets.</p> +<p>Matchers, as their name would suggest, match mail messages against certain conditions. They +return some subset (possibly the entire set) of the original recipients of the message if there +is a match. An inherent part of the Matcher contract is that a Matcher should not induce any changes +in a message under evaluation.</p> +<p>Mailets are responsible for actually processing the message. They may alter the message in any fashion, +or pass the message to an external API or component. This can include delivering a message to its destination +repository or SMTP server.</p> +<p>The Mailet API is currently in its second revision. Although, the Mailet API is expected to undergo substantial changes in the near future, it is our aim that existing Mailets that abided purely by the prior Mailet API interfaces will continue to run with the revised specification.</p> +<p>The Javadoc for the Mailet API can be found <a href="apidocs/index.html">here</a>.</p> +<p>James bundles a number of Matchers and Mailets in its distribution. Descriptions of provided matchers +can be found <a href="provided_matchers_2_3.html">here</a>, while descriptions of provided mailets can be found +<a href="provided_mailets_2_3.html">here</a>.</p> +</div> + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">© + 2002-2006 + + Apache Software Foundation + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>