Author: eric
Date: Sun Jun 17 09:40:13 2012
New Revision: 1351081
URL: http://svn.apache.org/viewvc?rev=1351081&view=rev
Log:
Add gatewayUsername and gatewayPassword + ToFolder to mailets documentation
Modified:
james/server/trunk/src/site/xdoc/dev-provided-mailets.xml
Modified: james/server/trunk/src/site/xdoc/dev-provided-mailets.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev-provided-mailets.xml?rev=1351081&r1=1351080&r2=1351081&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-provided-mailets.xml (original)
+++ james/server/trunk/src/site/xdoc/dev-provided-mailets.xml Sun Jun 17
09:40:13 2012
@@ -19,10 +19,6 @@
-->
<document>
-<!--
-@todo Document ToFolder
--->
-
<properties>
<title>Apache James Server 3 - Provided Mailets</title>
</properties>
@@ -384,46 +380,54 @@ processor.</p>
</subsection>
<subsection name="RemoteDelivery">
-<p>Manages delivery of messages to recipients on remote SMTP hosts.</p>
-<p>Parameters:
-<ul>
-<li><strong>outgoing</strong> (required) - The URL for the repository that
will hold messages being processed
-by the RemoteDelivery Mailet.</li>
-<li><strong>delayTime</strong> (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><strong>maxRetries</strong> (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><strong>timeout</strong> (optional) - The SMTP connection timeout for SMTP
connections generated
-by this Mailet. Defaults to 60 seconds.</li>
-<li><strong>deliveryThreads</strong> (optional) - The number of threads this
Mailet will use to generate
-SMTP connections.</li>
-<li><strong>gateway</strong> (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><strong>gatewayPort</strong> (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 <em>and</em> the gateway value does not specify
-a port as described above.</li>
-<li><strong>bind</strong> (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><strong>startTLS</strong> (optional) - a boolean value (true/false)
indicating whether starTLS is
-on. Defaults to false.</li>
-<li><strong>sslEnable</strong> (optional) - a boolean value (true/false)
indicating whether starTLS is
-on. Defaults to false.</li>
-<li><strong>debug</strong> (optional) - a boolean value (true/false)
indicating whether debugging is
-on. Defaults to false.</li>
-</ul>
-</p>
+ <p>Manages delivery of messages to recipients on remote SMTP hosts.</p>
+
+ <p>Parameters:
+ <ul>
+ <li><strong>outgoing</strong> (required) - The URL for the repository
that will hold messages being processed
+ by the RemoteDelivery Mailet.</li>
+ <li><strong>delayTime</strong> (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><strong>maxRetries</strong> (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><strong>timeout</strong> (optional) - The SMTP connection timeout
for SMTP connections generated
+ by this Mailet. Defaults to 60 seconds.</li>
+ <li><strong>deliveryThreads</strong> (optional) - The number of threads
this Mailet will use to generate
+ SMTP connections.</li>
+ <li><strong>gateway</strong> (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><strong>gatewayPort</strong> (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 <em>and</em> the gateway value does not
specify
+ a port as described above.</li>
+ <li><strong>gatewayUsername</strong> (optional) - The username to use
when
+ authenticating to the defined gateway. This value will be
+ employed when a gateway is set.</li>
+ <li><strong>gatewayPassword</strong> (optional) - The password to use
when
+ authenticating to the defined gateway. This value will be
+ employed when a gateway is set.</li>
+ <li><strong>bind</strong> (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><strong>startTLS</strong> (optional) - a boolean value (true/false)
indicating whether starTLS is
+ on. Defaults to false.</li>
+ <li><strong>sslEnable</strong> (optional) - a boolean value (true/false)
indicating whether starTLS is
+ on. Defaults to false.</li>
+ <li><strong>debug</strong> (optional) - a boolean value (true/false)
indicating whether debugging is
+ on. Defaults to false.</li>
+ </ul>
+ </p>
+
</subsection>
<subsection name="RemoveAllMailAttributes">
@@ -532,6 +536,17 @@ present, no error message is set.</li>
</p>
</subsection>
+<subsection name="ToFolder">
+ <p>Description: ...</p>
+
+ <p>Parameters:
+ <ul>
+ <li><strong>...</strong> (required) - ....</li>
+ <li><strong>...</strong> (optional) - ....</li>
+ </ul>
+ </p>
+</subsection>
+
<subsection name="ToMultiRepository">
<p>Description: Receives a Mail from JamesSpoolManager and takes care of
delivery of the
message to local inboxes or a specific repository.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
