Author: eric
Date: Sun Jun 17 09:50:53 2012
New Revision: 1351083
URL: http://svn.apache.org/viewvc?rev=1351083&view=rev
Log:
deploy provided mailets doc
Modified:
james/site/trunk/www/server/3/dev-provided-mailets.html
Modified: james/site/trunk/www/server/3/dev-provided-mailets.html
URL:
http://svn.apache.org/viewvc/james/site/trunk/www/server/3/dev-provided-mailets.html?rev=1351083&r1=1351082&r2=1351083&view=diff
==============================================================================
--- james/site/trunk/www/server/3/dev-provided-mailets.html (original)
+++ james/site/trunk/www/server/3/dev-provided-mailets.html Sun Jun 17 09:50:53
2012
@@ -18,7 +18,7 @@
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 29, 2012 -->
+<!-- Generated by Apache Maven Doxia at Jun 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" />
@@ -37,7 +37,7 @@
<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="20120429" />
+ <meta name="Date-Revision-yyyymmdd" content="20120617" />
<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"/>
@@ -77,7 +77,7 @@
<div class="xleft">
- <span id="publishDate">Last Published: 2012-04-29</span>
+ <span id="publishDate">Last Published: 2012-06-17</span>
</div>
<div class="xright"> <a href="../../index.html"
title="Home">Home</a>
|
@@ -298,8 +298,6 @@
specific language governing permissions and limitations
under the License. -->
-<!-- @todo Document ToFolder -->
-
<div class="section"><h2>Mailets<a name="Mailets"></a></h2>
@@ -657,46 +655,54 @@ processor.</p>
</div>
<div class="section"><h3>RemoteDelivery<a name="RemoteDelivery"></a></h3>
-<p>Manages delivery of messages to recipients on remote SMTP hosts.</p>
-
-<p>Parameters:
-</p><ul>
-<li><b>outgoing</b> (required) - The URL for the repository that will hold
messages being processed
-by the RemoteDelivery Mailet.</li>
-<li><b>delayTime</b> (optional) - a non-negative Long value that is the time in
-milliseconds between redelivery attempts for a particular mail. Defaults to
six hours.</li>
-<li><b>maxRetries</b> (optional) - a non-negative Integer value that is number
of times
-the Mailet will attempt to deliver a particular mail. Defaults to five.</li>
-<li><b>timeout</b> (optional) - The SMTP connection timeout for SMTP
connections generated
-by this Mailet. Defaults to 60 seconds.</li>
-<li><b>deliveryThreads</b> (optional) - The number of threads this Mailet will
use to generate
-SMTP connections.</li>
-<li><b>gateway</b> (optional) - The host name of the SMTP server
-to be used as a gateway for this server. If this value is set, then all
-messages will be delivered to the gateway server, regardless of recipient
-address. To specify more than one gateway server, add multiple gateway tags,
-each containing one value. If more than one server is specified, they will be
-tried in order until one is successful. In addition the port may be specified
-for each gateway in the format <host>:<port>. If this
-value is unset, delivery will occur to SMTP servers resolved by MX lookup.</li>
-<li><b>gatewayPort</b> (optional) - The default port number of the
-SMTP server to be used as a gateway for this server. This value will be
-employed when a gateway is set <i>and</i> the gateway value does not specify
-a port as described above.</li>
-<li><b>bind</b> (optional) - If present, this value is a string
-describing the local IP address to which the mailet should be bound while
-delivering emails. If the tag is absent then the service will bind to the
-default local address of the machine. This tag is useful for multihomed
machines.<br />
-Note: Currently you must use the same IP address for all of those
RemoteDelivery
-instances where you explicitly supply a bind address.</li>
-<li><b>startTLS</b> (optional) - a boolean value (true/false) indicating
whether starTLS is
-on. Defaults to false.</li>
-<li><b>sslEnable</b> (optional) - a boolean value (true/false) indicating
whether starTLS is
-on. Defaults to false.</li>
-<li><b>debug</b> (optional) - a boolean value (true/false) indicating whether
debugging is
-on. Defaults to false.</li>
-</ul>
+ <p>Manages delivery of messages to recipients on remote SMTP hosts.</p>
+
+ <p>Parameters:
+ </p><ul>
+ <li><b>outgoing</b> (required) - The URL for the repository that will
hold messages being processed
+ by the RemoteDelivery Mailet.</li>
+ <li><b>delayTime</b> (optional) - a non-negative Long value that is the
time in
+ milliseconds between redelivery attempts for a particular mail.
Defaults to six hours.</li>
+ <li><b>maxRetries</b> (optional) - a non-negative Integer value that is
number of times
+ the Mailet will attempt to deliver a particular mail. Defaults to
five.</li>
+ <li><b>timeout</b> (optional) - The SMTP connection timeout for SMTP
connections generated
+ by this Mailet. Defaults to 60 seconds.</li>
+ <li><b>deliveryThreads</b> (optional) - The number of threads this
Mailet will use to generate
+ SMTP connections.</li>
+ <li><b>gateway</b> (optional) - The host name of the SMTP server
+ to be used as a gateway for this server. If this value is set, then all
+ messages will be delivered to the gateway server, regardless of
recipient
+ address. To specify more than one gateway server, add multiple gateway
tags,
+ each containing one value. If more than one server is specified, they
will be
+ tried in order until one is successful. In addition the port may be
specified
+ for each gateway in the format <host>:<port>. If this
+ value is unset, delivery will occur to SMTP servers resolved by MX
lookup.</li>
+ <li><b>gatewayPort</b> (optional) - The default port number of the
+ SMTP server to be used as a gateway for this server. This value will be
+ employed when a gateway is set <i>and</i> the gateway value does not
specify
+ a port as described above.</li>
+ <li><b>gatewayUsername</b> (optional) - The username to use when
+ authenticating to the defined gateway. This value will be
+ employed when a gateway is set.</li>
+ <li><b>gatewayPassword</b> (optional) - The password to use when
+ authenticating to the defined gateway. This value will be
+ employed when a gateway is set.</li>
+ <li><b>bind</b> (optional) - If present, this value is a string
+ describing the local IP address to which the mailet should be bound
while
+ delivering emails. If the tag is absent then the service will bind to
the
+ default local address of the machine. This tag is useful for multihomed
machines.<br />
+ Note: Currently you must use the same IP address for all of those
RemoteDelivery
+ instances where you explicitly supply a bind address.</li>
+ <li><b>startTLS</b> (optional) - a boolean value (true/false) indicating
whether starTLS is
+ on. Defaults to false.</li>
+ <li><b>sslEnable</b> (optional) - a boolean value (true/false)
indicating whether starTLS is
+ on. Defaults to false.</li>
+ <li><b>debug</b> (optional) - a boolean value (true/false) indicating
whether debugging is
+ on. Defaults to false.</li>
+ </ul>
+
+
</div>
<div class="section"><h3>RemoveAllMailAttributes<a
name="RemoveAllMailAttributes"></a></h3>
@@ -805,6 +811,17 @@ present, no error message is set.</li>
</div>
+<div class="section"><h3>ToFolder<a name="ToFolder"></a></h3>
+ <p>Description: ...</p>
+
+ <p>Parameters:
+ </p><ul>
+ <li><b>...</b> (required) - ....</li>
+ <li><b>...</b> (optional) - ....</li>
+ </ul>
+
+</div>
+
<div class="section"><h3>ToMultiRepository<a name="ToMultiRepository"></a></h3>
<p>Description: Receives a Mail from JamesSpoolManager and takes care of
delivery of the
message to local inboxes or a specific repository.
