Added: james/server/trunk/src/xdocs/provided_mailets_2_3.xml URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/provided_mailets_2_3.xml?rev=418815&view=auto ============================================================================== --- james/server/trunk/src/xdocs/provided_mailets_2_3.xml (added) +++ james/server/trunk/src/xdocs/provided_mailets_2_3.xml Mon Jul 3 10:43:15 2006 @@ -0,0 +1,342 @@ +<?xml version="1.0"?> + +<document> + + <properties> + <title>James 2.1 - Provided Mailets</title> + </properties> + +<body> + +<section name="Mailets"> + +<p>James provides a number of implemented Mailets for use by James administrators in their +configurations. These are primarily mailets that members of the James developer or user +communities have found useful in their own configurations. A description of how to configure +Mailets and use them in the James SpoolManager can be found <a href="spoolmanager_configuration_2_1.html">here</a>.</p> + +<subsection name="AddFooter"> +<p>Description: This mailet adds a text footer to the message.</p> +<p>Parameters: +<ul> +<li><strong>text</strong> (required) - the text that will be added as a footer to the message.</li> +</ul> +</p> +</subsection> + +<subsection name="AddHabeasWarrantMark"> +<p>Description: This mailet adds a Habeas warrant mark (see <a href="http://habeas.com";>http://habeas.com</a> for details) to the message.</p> +<p>Parameters: None.</p> +</subsection> + +<subsection name="AddHeader"> +<p>Description: This mailet is <strong>deprecated</strong> .Please use SetMimeHeader .</p> +<p>Parameters: +<ul> +<li><strong>name</strong> (required) - the name of the header to be added to the message.</li> +<li><strong>value</strong> (required) - the text that will be added as a header to the message.</li> +</ul> +</p> +</subsection> + +<subsection name="AvalonListserv"> +<p>Provides basic list server functionality. Implements basic filters for emails sent to the list, +including restriction of senders to members, diallowing attachments in list messages, and subject line +processing</p> +<p>Parameters: +<ul> +<li><strong>repositoryName</strong> (required) - the name of the user repository that contains the users +for this list.</li> +<li><strong>membersonly</strong> (optional) - whether only members of the list can send messages to this +list. Defaults to false.</li> +<li><strong>attachmentsallowed</strong> (optional) - whether attachments are allowed in messages sent to this +list. Defaults to true.</li> +<li><strong>replytolist</strong> (optional) - whether the reply-to address for all messages sent to this +list is set to the list address. Defaults to true.</li> +<li><strong>subjectprefix</strong> (optional) - a String value. If set, this value is prepended to the subject +line of all messages sent to the list.</li> +<li><strong>autobracket</strong> (optional) - a boolean value. If a subjectprefix is set, this value determines +whether the prefix is bracketed before being prepended to the subject line. Defaults to true.</li> +</ul> +</p> +</subsection> + +<subsection name="AvalonListservManager"> +<p>Processes list management commands of the form <list-name>-on@<host> and +<list-name>-off@<host> where <list-name> and lt;host> are arbitrary. Note +that this should be used in tandem with a CommandForListserv matcher to ensure that only commands +intended for a specific list are processed.</p> +<p>Parameters: +<ul> +<li><strong>repositoryName</strong> (required) - the name of the user repository that contains the users +for this list.</li> +</ul> +</p> +</subsection> + +<subsection name="BayesianAnalysis"> +<p>Description: Spam detection mailet using bayesian analysis techniques.</p> +<p>Parameters: +<ul> +<li><strong>repositoryPath</strong> (required) - The repositoryPath which is used.</li> +<li><strong>headerName</strong> - The HeaderName which get adds to holds the Probalitity. Default is <i>X-MessageIsSpamProbability</i>.</li> +<li><strong>ignoreLocalSender</strong> - Set to true if you want to ignore messages from local senders. By local sender we mean a return-path +with a local server part (server listed in <servernames> in config.xml). Default is <i>false</i>.</li> +<li><strong>maxSize</strong> - Set this to the maximum message size (in bytes) after analysis will be skipped. Default is <i>100000</i>.</li> +</ul> +</p> +</subsection> + +<subsection name="BayesianAnalysisFeeder"> +<p>Description: Feeds ham OR spam messages to train the BayesianAnalysis mailet.</p> +<p>Parameters: +<ul> +<li><strong>repositoryPath</strong> (required) - The repositoryPath which is used.</li> +<li><strong>feedType</strong> (required) - The type of the message which is used to feed the mailet. Allowed values are <i>spam</i> and <i>ham</i>.</li> +<li><strong>maxSize</strong> - Set this to the maximum message size (in bytes) after analysis will be skipped. Default is <i>100000</i>.</li> +</ul> +</p> +</subsection> + +<subsection name="Bounce"> +<p>Description: Generates a response to the reverse-path address.</p> +<p>Parameters: +<ul> +<li><strong>sender</strong> - The senderAddress which will be used for sending the bounce. Possible values: <i>address</i>, <i>postmaster</i> , <i>sender</i>, +<i>unaltered</i>. Default <i>postmaster</i>.</li> +<li><strong>attachError</strong> - Attach error. Default is false.</li> +<li><strong>message</strong> - Set the message which get included in the bounce.</li> +<li><strong>prefix</strong> - Optional subject prefix prepended to the original message.</li> +<li><strong>inline</strong> - Specify which mailpart will be included in the email body. Possible values: <i>unaltered</i>, <i>heads</i>, <i>body</i> , <i>all</i>, +"none". Default "none".</li> +<li><strong>attachment</strong> - Specify which mailpart will be attached to the email. Possible values: <i>none</i>, <i>heads</i>, <i>body</i>, <i>all</i>, +<i>message</i>. Default <i>message</i>.</li> +<li><strong>passThrough</strong> - If set to false the email will not processed after the bounce. Possible values: <i>true</i>, <i>false</i>. +Default <i>true</i>.</li> +<li><strong>fakeDomainCheck</strong> - If set to false true will check if the sender domain is valid. Possible values: <i>true</i>, <i>false</i>. +Default <i>true</i>.</li> +<li><strong>debug</strong> - If set true you can enable debugging. Possible values: <i>true</i>, <i>false</i>. +Default <i>false</i>.</li> +</ul> +</p> +</subsection> + +<subsection name="ClamAVScan"> +<p>Description: Does an antivirus scan check using a ClamAV daemon (CLAMD).</p> +<p>Parameters: +<ul> +<li><strong>host</strong> - The host name of the server where CLAMD runs. The default is <i>localhost</i></li> +<li><strong>port</strong> - The port on which CLAMD listens. The default is <i>3310</i>.</li> +<li><strong>maxPings</strong> - The maximum number of connection retries during startup. If the value is <i>0</i> no startup +test will be done.</li> +<li><strong>pingIntervalMillis</strong> (required) - The interval (in milliseconds) between each connection retry during startup. +The default is <i>30000</i> (30 seconds)</li> +<li><strong>streamBufferSize</strong> - the BufferedOutputStream buffer size to use writing to the <I>stream connection</I>. The +default is <i>8192</i>.</li> +<li><strong>debug</strong> - If set true you can enable debugging. Possible values: <i>true</i>, <i>false</i>. +Default <i>false</i>.</li> +</ul> +</p> +</subsection> + +<subsection name="Forward"> +<p>Description: This mailet forwards the message to a set of recipients.</p> +<p>Parameters: +<ul> +<li><strong>forwardto</strong> (required) - a comma delimited list of email addresses.</li> +</ul> +</p> +</subsection> + +<subsection name="FromRepository"> +<p>Description: This mailet ee-spools mail found in the specified Repository.</p> +<p>Parameters: +<ul> +<li><strong>repositoryPath</strong> (required) - The repositoryPath which is used.</li> +<li><strong>processor</strong> (required) - The target processor to move the mails to.</li> +<li><strong>delete</strong> - If set to true the mails get deleted after re-spooling. Default is <i>false</i>.</li> +</ul> +</p> +</subsection> + +<subsection name="JDBCAlias"> +<p>Description: This mailet does alias translation for email addresses stored in a database table.</p> +<p>Parameters: +<ul> +<li><strong>mappings</strong> (required) - a URL of the form db://<data-source>/<table>, where +<table> is the table in the database containing the alias info and <data-source> is the name +of the data-source in config.xml that is to be used.</li> +<li><strong>source_column</strong> (required) - the column containing the aliases.</li> +<li><strong>target_column</strong> (required) - the column containing the alias targets.</li> +</ul> +</p> +</subsection> + +<subsection name="JDBCVirtualUserTable"> +<p>Description: This mailet does complex alias translation for email addresses stored in a database table.</p> +<p>Parameters: +<ul> +<li><strong>table</strong> (required) - the URL describing the database table. This URL has the form +db://<data-source>/<table> where <data-source> and <table> are the names of +the data-source as defined in config.xml and the table in the database.</li> +<li><strong>sqlquery</strong> (optional) - the text of the SQL query used by the mailet to do user +lookup. The default is "select VirtualUserTable.target_address from VirtualUserTable, VirtualUserTable as VUTDomains where (VirtualUserTable.user like ? or VirtualUserTable.user like '\\%') and (VirtualUserTable.domain like ? or (VirtualUserTable.domain like '\\%' and VUTDomains.domain like ?)) order by concat(VirtualUserTable.user,'@',VirtualUserTable.domain) desc limit 1"</li> +</ul> +</p> +</subsection> + +<subsection name="LocalDelivery"> +<p>Description: This mailet delivers messages to local mailboxes.</p> +<p>Parameters: None.</p> +</subsection> + +<subsection name="NotifyPostmaster"> +<p>Description: This mailet forwards the message as an attachment to the James postmaster.</p> +<p>Parameters: +<ul> +<li><strong>sendingAddress</strong> (optional) - the address from which the forwarded email will be +sent. Defaults to the postmaster address.</li> +<li><strong>notice</strong> (optional) - the text message that will accompany the forwarded message. Defaults +to "We were unable to deliver the attached message because of an error in the mail server."</li> +<li><strong>attachStackTrace</strong> (optional) - whether an error stack trace is attached to the forwarded message.</li> +</ul> +</p> +</subsection> + +<subsection name="NotifySender"> +<p>Description: This mailet forwards the message as an attachment to the original sender.</p> +<p>Parameters: +<ul> +<li><strong>sendingAddress</strong> (optional) - the address from which the forwarded email will be +sent. Defaults to the postmaster address.</li> +<li><strong>notice</strong> (optional) - the text message that will accompany the forwarded message. Defaults +to "We were unable to deliver the attached message because of an error in the mail server."</li> +<li><strong>attachStackTrace</strong> (optional) - whether an error stack trace is attached to the forwarded message.</li> +</ul> +</p> +</subsection> + +<subsection name="Null"> +<p>Description: This mailet ends processing for this mail.</p> +<p>Parameters: None.</p> +</subsection> + +<subsection name="PostmasterAlias"> +<p>Description: Intercepts all mails addressed to postmaster@<domain> where <domain> is one +of the domains managed by this James server and substitutes the configured James postmaster address for +the original recipient address. This mailet is inserted automatically by James at the head of the root +processor.</p> +<p>Parameters: None.</p> +</subsection> + +<subsection name="Redirect"> +<p>Description: A mailet providing powerful, configurable redirection services.<br/> + This mailet can produce listserver, forward and notify behaviour, with the + original message intact, attached, appended or left out altogether.<br/> + This built in functionality is controlled by the configuration as described + <a href="javadocs/org/apache/james/transport/mailets/Redirect.html">here</a>.</p> +<p>It is also intended to be easily subclassed to make providing bespoke redirection + mailets simple. <br/> + By extending it and overriding one or more of its methods new behaviour can + be quickly created without the author having to address any other issue than + the relevant one. For more information see the javadocs + <a href="javadocs/org/apache/james/transport/mailets/Redirect.html">here</a>.</p> +<p>Parameters: <a href="javadocs/org/apache/james/transport/mailets/Redirect.html">See javadocs.</a></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>debug</strong> (optional) - a boolean value (true/false) indicating whether debugging is +on. Defaults to false.</li> +</ul> +</p> +</subsection> + +<subsection name="RemoveAllMailAttributes"> +<p>Desctription: Removes all attributes on the Mail instance.</p> +<p>Parameters: None. </p> +</subsection> + +<subsection name="RemoveAllMailAttributes"> +<p>Desctription: Remove attributes on the Mail instance.</p> +<p>Parameters: +<ul> +<li><strong>name</strong> (required) - The name of the attribute to remove.</li> +</ul> +</p> +</subsection> + +<subsection name="ServerTime"> +<p>Description: This mailet sends a message to the sender of the original mail message with a server timestamp.</p> +<p>Parameters: None.</p> +</subsection> + +<subsection name="ToProcessor"> +<p>Redirects processing of the mail message to the specified processor.</p> +<p>Parameters: +<ul> +<li><strong>processor</strong> (required) - the name of the processor to which the message +is to be redirected.</li> +<li><strong>noticeText</strong> (optional) - a String value that, if present, +is set as the error message of the redirected message. If this value is not +present, no error message is set.</li> +</ul> +</p> +</subsection> + +<subsection name="ToRepository"> +<p>Places a copy of the message in the specified repository.</p> +<p>Parameters: +<ul> +<li><strong>repositoryPath</strong> (required) - the URL of the repository to which the message +is to be added.</li> +<li><strong>passThrough</strong> (optional) - a boolean value (true/false) indicating whether +processing should continue on the message is on. If false, the original message is GHOSTed. Defaults to false.</li> +</ul> +</p> +</subsection> + +<subsection name="UseHeaderRecipients"> +<p>Description: Ignores the recipients associated with the Mail interface. Instead, it regenerates the +mail recipients from the MimeMessage headers (To, Cc, Bcc) and inserts a new message at the queue root +these new recipients. The original message is GHOSTed.</p> +<p>Parameters: +<ul> +<li><strong>debug</strong> (optional) - a boolean value (true/false) indicating whether debugging is +on. Defaults to false.</li> +</ul> +</p> +</subsection> +</section> +</body> +</document>
Modified: james/server/trunk/src/xdocs/stylesheets/project.xml URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/stylesheets/project.xml?rev=418815&r1=418814&r2=418815&view=diff ============================================================================== --- james/server/trunk/src/xdocs/stylesheets/project.xml (original) +++ james/server/trunk/src/xdocs/stylesheets/project.xml Mon Jul 3 10:43:15 2006 @@ -14,8 +14,8 @@ <item name="Releases" href="http://james.apache.org/download.cgi"/> </menu> <menu name="Documentation"> - <item name="James 2.X" href="/documentation_2_1.html"/> - <item name="Design" href="/design_objectives.html"/> + <item name="James 2.3" href="/documentation_2_3.html"/> + <item name="Design" href="/design_objectives_2.3.html"/> <item name="James Javadocs" href="/javadocs/index.html"/> <item name="Mailet Javadocs" href="/mailet/index.html"/> <item name="Useful RFCs" href="/rfclist.html"/> Modified: james/server/trunk/src/xdocs/weare.xml URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/weare.xml?rev=418815&r1=418814&r2=418815&view=diff ============================================================================== --- james/server/trunk/src/xdocs/weare.xml (original) +++ james/server/trunk/src/xdocs/weare.xml Mon Jul 3 10:43:15 2006 @@ -36,6 +36,18 @@ <p> <b>Jason Webb (jw at inovem.com) [JW]</b> </p> + <p> + <b>Stefano Bagnara (apache at bago.org) [SB2]</b> + </p> + <p> + <b>Norman Maurer (nm at byteaction.de) [NM]</b> + </p> + <p> + <b>Bernd Fondermann (bf_jak at brainlounge.de) [BF]</b> + </p> + <p> + <b>Alan D. Cabrera (list at toolazydogs.com) [ADC]</b> + </p> </section> <section name="Alumni and Other Contributors"> <p>Many people have had a hand in James' success over the years, here we'd like to give credit to those who have made a difference and to those who have left.</p> --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
