james-server-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nor...@apache.org
Subject svn commit: r418828 - in /james/server/trunk/src/xdocs: migratingDatasource_v3.0.xml provided_matchers_2_3.xml summary_2_3.xml weare.xml
Date Mon, 03 Jul 2006 19:04:55 GMT
Author: norman
Date: Mon Jul  3 12:04:55 2006
New Revision: 418828

URL: http://svn.apache.org/viewvc?rev=418828&view=rev
Log:
update xdocs for james 2.3. See JAMES-432

Added:
    james/server/trunk/src/xdocs/provided_matchers_2_3.xml
    james/server/trunk/src/xdocs/summary_2_3.xml
Removed:
    james/server/trunk/src/xdocs/migratingDatasource_v3.0.xml
Modified:
    james/server/trunk/src/xdocs/weare.xml

Added: james/server/trunk/src/xdocs/provided_matchers_2_3.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/provided_matchers_2_3.xml?rev=418828&view=auto
==============================================================================
--- james/server/trunk/src/xdocs/provided_matchers_2_3.xml (added)
+++ james/server/trunk/src/xdocs/provided_matchers_2_3.xml Mon Jul  3 12:04:55 2006
@@ -0,0 +1,280 @@
+<?xml version="1.0"?>
+
+<document>
+
+ <properties>
+  <title>James 2.3 - Provided Matchers</title>
+ </properties>
+
+<body>
+
+<section name="Matchers">
+
+<p>James provides a number of implemented Matchers for use by James administrators
in their 
+configurations.  These are primarily matchers that members of the James developer or user

+communities have found useful in their own configurations.  A description of how to configure

+Matchers and use them in the James SpoolManager can be found <a href="spoolmanager_configuration_2_1.html">here</a>.</p>
+
+<subsection name="All">
+<p>Description: This matcher is the trivial one - it matches all mails being processed.
 All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+<subsection name="AttachmentFileNameIs">
+<p>Description: It can be used to refuse emails with SCR, PIF, EXE etc. attachments.
+It matches mails that has a file attachment with a file name meeting one of the supplied
filters.
+All recipients are returned.</p>
+<p>Configuration string: A comma or space delimited list of file names. 
+File names may start with a wildcard '*'. Example: *.scr,*.bat,*.pif,*.pi,*.com,*.exe</p>
+</subsection>
+<subsection name="CommandForListserv">
+<p>Description: The CommandForListserv matcher is used as a simple filter to recognize
emails that are list server 
+commands.  It will match any email addressed to the list server host, as well as any email
that is addressed
+to a user named &lt;prefix&gt;-on or &lt;prefix&gt;-off on any host.  Only
those matching recipients will be returned.</p>
+<p>Configuration string: An email address of the form &lt;prefix&gt;@&lt;host&gt;,
where host is the hostname used for the listserver and prefix is the command prefix.</p>
+</subsection>
+<subsection name="FetchedFrom">
+<p>Description: A matcher intended for use with the FetchPOP server.  It matches a
custom header (X-fetched-from) that is 
+set by the FetchPOP server.  FetchPOP sets this header to the name of the FetchPOP task which
originally fetched
+the message.  All recipients are returned.</p>
+<p>Configuration string: The name of the FetchPOP task which originally fetched the
message.</p>
+</subsection>
+
+<subsection name="FileRegexMatcher">
+<p>Description: A matcher which can be used to match on a attachment when the given
regex match.</p>
+<p>Configuration string: A regex for match attachmentname.</p>
+</subsection>
+
+<subsection name="HasAttachment">
+<p>Description: Matches those messages with a MIME type of "multipart/mixed".  All
recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="HasHabeasWarrantMark">
+<p>Description: Matches mails that have the Habeas Warrant (see http://www.habeas.com
for details).  All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="HasHeader">
+<p>Description: Matches mails that have the specified header.  All recipients are returned.</p>
+<p>Configuration string: The name of the header whose presence determines the match.</p>
+</subsection>
+
+<subsection name="HasMailAttribute">
+<p>Description: Matches mails that have the specified Mail Attribute.  All 
+recipients are returned.</p>
+<p>Configuration string: The name of the Mail Attribute to match. For example:<br/>
+<pre><code>
+&lt;mailet match="HasMailAttribute=name" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="HasMailAttributeWithValue">
+<p>Description: Matches mails that have the specified Mail Attribute and the
+specified MailAttribute value. All recipients are returned.</p>
+<p>MailAttributes are types of Object whereas the value specified in the Matcher
+condition is of type String. The toString() method is used to obtain a String
+representation of the Mail Attribute value for matching. The 
+String.equals(String) method tests for a match.</p>
+<p>Configuration string: The name of the Mail Attribute to be matched,  a comma
+and then the String value to be matched. For example:<br/>
+<pre><code>
+&lt;mailet match="HasMailAttributeWithValue=name, value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="HasMailAttributeWithValueRegex">
+<p>Description: Matches mails that have the specified Mail Attribute and 
+a MailAttribute value that matches the specified regular expression.
+All recipients are returned.</p>
+<p>MailAttributes are types of Object whereas the value specified in the Matcher
+condition is of type String. The toString() method is used to obtain a String
+representation of the Mail Attribute value for matching. The regular
+expression must follow Perl5 syntax.</p>
+<p>Configuration string: The name of the Mail Attribute to be matched,  a comma
+and then the regular expression used to match the value against. For example:<br/>
+<pre><code>
+&lt;mailet match="HasMailAttributeWithValueRegex=name, regex" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="HostIs">
+<p>Description: Matches mails that are sent to email addresses on hosts that are in
the configuration list.  Only 
+recipients that are on one of the hosts are returned.</p>
+<p>Configuration string: A list of host names, comma or space delimited.
+<pre><code>
+&lt;mailet match="HostIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="HostIsLocal">
+<p>Description: Matches mails that are sent to email addresses on local hosts.  Only

+recipients that are on one of the local hosts are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="InSpammerBlacklist">
+<p>Description: Checks the mail against one of a number of mail-abuse.org IP lists.</p>
+<p>Configuration string: One of three strings - "blackholes.mail-abuse.org", "relays.mail-abuse.org",
or "dialups.mail-abuse.org".</p>
+</subsection>
+
+<subsection name="IsSingleRecipient">
+<p>Description: Matches those messages sent to only a single recipient.  The single
recipient is returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="NESSpamCheck">
+<p>Description: A matcher derived from a Netscape Mail Server spam filter.  If the
matcher detects headers that 
+indicate spam, the message is matched.  All recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="RecipientIs">
+<p>Description: Matches mails that are sent to one of the recipients on a specified
list.  Only 
+matching recipients are returned.</p>
+<p>Configuration string: A list of recipient addresses, comma, tab, or space delimited.
+<pre><code>
+&lt;mailet match="RecipientIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="RecipientIsLocal">
+<p>Description: Matches mails that are sent to email addresses on local hosts with
users that have local acccunts.  Only 
+matching recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="RelayLimit">
+<p>Description: Counts the number of Received headers in the mail (each of which represents
a server 
+in the relay chain).  If the number equals or exceeds the specified limit, the mail is 
+matched.  All recipients are returned.</p>
+<p>Configuration string: a positive integer that is the limit on the number of relays.
+<pre><code>
+&lt;mailet match="RelayLimit=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="RemoteAddrInNetwork">
+<p>Description: Checks the remote address from which the mail was received against
the configured list.  If the address matches one on the list, the matcher considers it a match.
 All recipients are returned.</p>
+<p>Configuration string: A list of domain names, IP addresses, or wildcarded IP subnets
of any class.  The 
+list may be comma or space delimited.
+<pre><code>
+&lt;mailet match="RemoteAddrInNetwork=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="RemoteAddrNotInNetwork">
+<p>Description: Checks the remote address from which the mail was received against
the configured list.  If the address doesn't match one on the list, the matcher considers
it a match.  All recipients are returned.</p>
+<p>Configuration string: A list of domain names, IP addresses, or wildcarded IP subnets
of any class.  The 
+list may be comma or space delimited.
+<pre><code>
+&lt;mailet match="RemoteAddrNotInNetwork=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SenderHostIs">
+<p>Description: Matches mails where the host name in the address of the sender cannot
be resolved.  All 
+recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="SenderInFakeDomain">
+<p>Description: Matches mails where the host name in the address of the sender cannot
be resolved.  All 
+recipients are returned.</p>
+<p>Configuration string: None.</p>
+</subsection>
+
+<subsection name="SenderIs">
+<p>Description: Matches mails that are sent by one of the senders on a specified list.
 All 
+recipients are returned.</p>
+<p>Configuration string: A list of sender addresses, comma, tab, or space delimited.
+<pre><code>
+&lt;mailet match="SenderIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SenderIsNull">
+<p>Description: Matches mails that are sent by a null sender.</p>
+<p>Configuration string: none.
+<pre><code>
+&lt;mailet match="SenderIsNull" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SenderIsRegex">
+<p>Description: Matches mails that are sent by one of the senders matched the given
regex.</p>
+<p>Configuration string: A regex.
+<pre><code>
+&lt;mailet match="SenderIsRegex=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SizeGreaterThan">
+<p>Description: Matches emails with a total message size (headers and body) greater
than the specified limit.  All recipients are returned.</p>
+<p>Configuration string: a positive integer followed by an 'm' or a 'k'.  This is the
maximum message size permitted specified in megabytes or kilobytes respectively.
+<pre><code>
+&lt;mailet match="SizeGreaterThan=1m" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SMTPAuthSuccessful">
+<p>Description: Matches mails that are send from an authorized sender.</p>
+<p>Configuration string: none.
+<pre><code>
+&lt;mailet match="SMTPAuthSuccessful" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SMTPAuthUserIs">
+<p>Description: Matches mails that are send from one of the given authorized senders.</p>
+<p>Configuration string: none.
+<pre><code>
+&lt;mailet match="SMTPAuthUserIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+
+<subsection name="SubjectIs">
+<p>Description: Matches emails with the specified subject.  All recipients are returned.</p>
+<p>Configuration string: The string against which mail subject headers are matched.
+<pre><code>
+&lt;mailet match="SubjectIs=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="SubjectStartsWith">
+<p>Description: Matches emails whose subject header starts with the specified string.
 All recipients are returned.</p>
+<p>Configuration string: The string against which mail subject headers are matched.
+<pre><code>
+&lt;mailet match="SubjectStartsWith=value" class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+<subsection name="UserIs">
+<p>Description: Matches mails that are sent to email addresses that have userids that
are in the configuration list.  Only 
+matching recipients are returned.</p>
+<p>Configuration string: A list of user names, comma or space delimited.
+<pre><code>
+&lt;mailet match="UserIs=value, value, .." class=&quot;&lt;any-class&gt;&quot;&gt;
+</code></pre>
+</p>
+</subsection>
+
+</section>
+</body>
+</document>

Added: james/server/trunk/src/xdocs/summary_2_3.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/summary_2_3.xml?rev=418828&view=auto
==============================================================================
--- james/server/trunk/src/xdocs/summary_2_3.xml (added)
+++ james/server/trunk/src/xdocs/summary_2_3.xml Mon Jul  3 12:04:55 2006
@@ -0,0 +1,99 @@
+<?xml version="1.0"?>
+
+<document>
+
+ <properties>
+  <title>James 2.3 - Component Summary</title>
+ </properties>
+
+<body>
+
+<section name="The James Server">
+
+<p>James is an open source project intended to produce a robust, flexible, and powerful

+enterprise class server that provides email and email-related services.  It is also designed
to
+be highly customizable, allowing administrators to configure James to process email in a

+nearly endless variety of fashions.</p>
+
+<p>The James server is built on top of the Avalon Framework.  The standard James distribution

+deploys inside the Phoenix Avalon Framework container.  In addition to providing a robust

+server architecuture for James, the use of Phoenix allows James administrators to deploy

+their own applications inside the container.  These applications can then be accessed during

+mail processing.</p>
+
+<p>The James server is implemented as a complete collection of servers and related
components that, taken together,
+provide an email solution.  These components are described below.</p>
+
+</section>
+<section name="POP3 Service">
+
+<p>The POP3 protocol allows users to retrieve email messages.  It is the method
+most commonly used by email clients to download and manage email messages.</p>
+
+<p>The James version of the POP3 service is a simple and straightforward implementation
that 
+provides full compliance with the specification and maximum compatibility with common
+POP3 clients.  In addition, James can be configured to require SSL/TLS connections for
+POP3 client connecting to the server.</p>
+
+<p>More information on configuring the POP3 service can be found <a href="pop3_configuration_2_3.html">here</a>.</p>
+
+</section>
+<section name="SMTP Service">
+
+<p>SMTP (Simple Mail Transport Protocol) is the standard method of sending and delivering

+email on the internet.  James provides a full-function implementation of the SMTP specification,
+with support for some optional features such as message size limits, SMTP auth, and encrypted

+client/server communication.</p>
+
+<p>More information on configuring the SMTP service can be found <a href="smtp_configuration_2_3.html">here</a>.</p>
+
+</section>
+<section name="NNTP Service">
+
+<p>NNTP is used by clients to store messages on and retrieve messages from news servers.
 James provides 
+the server side of this interaction by implementing the NNTP specification as well as an
appropriate 
+repository for storing news messages.  The server implementation is simple and straightforward,
but 
+supports some additional features such as NNTP authentication and encrypted client/server
communication.</p>
+
+<p>More information on configuring the NNTP service can be found <a href="nntp_configuration_2_3.html">here</a>.</p>
+
+</section>
+<section name="FetchPOP">
+
+<p>FetchMail, unlike the other James components, is not an implementation of an RFC.
 Instead, it's a 
+component that allows the administrator to configure James to retrieve email from a number
of POP3 
+servers and deliver them to the local spool.  This is useful for consolidating mail delivered
to a
+number of accounts on different machines to a single account.</p>
+
+<p>More information on configuring FetchMail can be found <a href="fetchpop_configuration_2_3.html">here</a>.</p>
+</section>
+<section name="The SpoolManager, Matchers, and Mailets">
+
+<p>James separates the services that deliver mail to James (i.e. SMTP, FetchMail) 
+from the engine that processes mail after it is received by James.  The 
+SpoolManager component is James' mail processing engine.  James' SpoolManager component 
+is a Mailet container.  It is these mailets and matchers that actually carry out mail processing.</p>
+
+<p>More on the structure of the SpoolManager and the Mailet API can be found <a
href="spoolmanager_2_3.html">here</a>.</p>
+
+</section>
+<section name="Repositories">
+
+<p>James uses a number of different repositories to both store message data (email,
news messages) and 
+user information.  User repositories store user information, including user names, authentication

+information, and aliases.  Mail repositories store messages that have been delivered locally.
 Spool 
+repositories store messages that are still being processed.  Finally, news repositories are
used to
+store news messages.  Aside from what type of data they store, repositories are distinguished
by 
+where they store data.  There are three types of storage - File, Database, and DBFile.</p>
+
+</section>
+<section name="RemoteManager">
+
+<p>James provides a simple telnet-based interface for control.  Through this interface
you can add 
+and delete users, configure per-user aliases and forward addresses, and shut down the server.</p>
+
+<p>More on the configuring the RemoteManager can be found <a href="remotemanager_configuration_2_3.html">here</a>.</p>
+
+</section>
+</body>
+</document>

Modified: james/server/trunk/src/xdocs/weare.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/xdocs/weare.xml?rev=418828&r1=418827&r2=418828&view=diff
==============================================================================
--- james/server/trunk/src/xdocs/weare.xml (original)
+++ james/server/trunk/src/xdocs/weare.xml Mon Jul  3 12:04:55 2006
@@ -45,12 +45,13 @@
       <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>
+      <p>
+        <b>Alan D. Cabrera (list at toolazydogs.com) [ADC]</b>
+      </p>
       <p>
         <b>Darrell DeBoer (DD)</b>
       </p>



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org


Mime
View raw message