You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by er...@apache.org on 2010/10/08 19:08:03 UTC
svn commit: r1005906 - in /james/server/trunk/src/site: ./ apt/ xdoc/
xdoc/stylesheets/
Author: eric
Date: Fri Oct 8 17:08:02 2010
New Revision: 1005906
URL: http://svn.apache.org/viewvc?rev=1005906&view=rev
Log:
One more safety commit for 3.0 web site (JAMES-887)
Added:
james/server/trunk/src/site/apt/release_notes.apt
- copied, changed from r1005434, james/server/trunk/src/site/apt/release-notes.apt
james/server/trunk/src/site/xdoc/adding_domains.xml
- copied, changed from r1005819, james/server/trunk/src/site/xdoc/adding_domains_users.xml
james/server/trunk/src/site/xdoc/adding_users.xml
james/server/trunk/src/site/xdoc/adding_virtualusers.xml
james/server/trunk/src/site/xdoc/domains_configuration.xml
james/server/trunk/src/site/xdoc/mailetcontainer.xml
- copied, changed from r1005819, james/server/trunk/src/site/xdoc/mailet_api.xml
james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml
- copied, changed from r1005434, james/server/trunk/src/site/xdoc/spoolmanager_configuration.xml
james/server/trunk/src/site/xdoc/monitoring_instructions.xml
james/server/trunk/src/site/xdoc/perfomance.xml
james/server/trunk/src/site/xdoc/queue_priority.xml
james/server/trunk/src/site/xdoc/queues_monitoring.xml
james/server/trunk/src/site/xdoc/security.xml
james/server/trunk/src/site/xdoc/stylesheets/stylesheet.css
- copied unchanged from r1005819, james/server/trunk/src/site/xdoc/stylesheet.css
james/server/trunk/src/site/xdoc/users_configuration.xml
- copied, changed from r1005434, james/server/trunk/src/site/xdoc/userstores_configuration.xml
Removed:
james/server/trunk/src/site/apt/release-notes.apt
james/server/trunk/src/site/xdoc/adding_domains_users.xml
james/server/trunk/src/site/xdoc/mailet_api.xml
james/server/trunk/src/site/xdoc/protocols.xml
james/server/trunk/src/site/xdoc/spoolmanager.xml
james/server/trunk/src/site/xdoc/spoolmanager_configuration.xml
james/server/trunk/src/site/xdoc/stylesheet.css
james/server/trunk/src/site/xdoc/userstores_configuration.xml
Modified:
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/extend_james.xml
james/server/trunk/src/site/xdoc/index.xml
james/server/trunk/src/site/xdoc/summary.xml
Copied: james/server/trunk/src/site/apt/release_notes.apt (from r1005434, james/server/trunk/src/site/apt/release-notes.apt)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/apt/release_notes.apt?p2=james/server/trunk/src/site/apt/release_notes.apt&p1=james/server/trunk/src/site/apt/release-notes.apt&r1=1005434&r2=1005906&rev=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/apt/release-notes.apt (original)
+++ james/server/trunk/src/site/apt/release_notes.apt Fri Oct 8 17:08:02 2010
@@ -28,15 +28,15 @@ Release Notes
*3.0-M1 Release Notes
The Java Apache Mail Enterprise Server (a.k.a. Apache James) Project is happy to announce the release
- of version 3.0 of the Apache James server.
+ of version 3.0-M1 of the Apache James server.
The Apache James Server is a 100% pure Java enterprise mail server based
on open protocols. Currently supported are SMTP/LMTP, POP3, IMAP4
- protocols together with several different storage solutions (relational database,
- maildir, jcr).
+ protocols together with several different storage solutions (relational database via JPA and JDBC,
+ maildir, JCR).
- The James server also serves as a mail application platform. The James
- project hosts the Apache Mailet API, and the James server has a Mailet
+ The James server also serves as a mail application platform. It
+ hosts the Apache Mailet API, and acts has a Mailet
container. This feature makes it easy to design, write, and deploy
custom applications for mail processing. This modularity and ease of
customization is one of James' strengths, and can allow administrators
@@ -50,10 +50,10 @@ Release Notes
We are still actively looking for eager, capable developers to contribute to James.
If you're interesting in contributing to the James project, please subscribe to the James developer mailing list.
- Information about James can be found at the <a href="http://james.apache.org/">James web site</a>
+ Information about James can be found at the {{{http://james.apache.org/}James web site}}
at http://james.apache.org/. Users interested in subscribing to the James
- <a href="mailto:server-user-subscribe@james.apache.org">user</a> and
- <a href="mailto:server-dev-subscribe@james.apache.org">developer</a> mailings lists should send emails
+ {{{mailto:server-user-subscribe@james.apache.org}user}} and
+ {{{mailto:server-dev-subscribe@james.apache.org}developer}} mailings lists should send emails
to server-user-subscribe@james.apache.org and server-dev-subscribe@james.apache.org, respectively
*2.3.1 Release Notes
Modified: james/server/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1005906&r1=1005905&r2=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Fri Oct 8 17:08:02 2010
@@ -34,43 +34,53 @@
<body>
<menu name="Overview">
- <item name='Introduction' href='/index.html'/>
- <item name='Release Notes' href='/release-notes.html'/>
- <item name='Changes' href='/changelog.html'/>
+ <item name="Introduction" href="/index.html"/>
+ <item name="Release Notes" href="/release_notes.html"/>
+ <item name="Changes" href="/changelog.html"/>
+ <item name="Security" href="/security.html" />
+ <item name="Performance" href="/perfomance.html" />
<!-- <item name='JIRA Report' href='/jira-report.html'/>-->
</menu>
<menu name="Concepts">
<item name="Summary" href="/summary.html" />
- <item name="Protocols" href="/protocols.html" />
- <item name="SpoolManager" href="/spoolmanager.html" />
- <item name="Mailet API" href="/mailet_api.html" />
<item name="Stores" href="/stores.html" />
+ <item name="Mailet Container" href="/mailetcontainer.html" />
+ <item name="Queue Priority" href="/queue_priority.html" />
</menu>
<menu name="How to...">
- <item name="Install James" href="/installation_instructions.html" />
- <item name="Configure James" href="/configuration_instructions.html" collapse="true" >
+ <item name="1. Install James" href="/installation_instructions.html" />
+ <item name="2. Configure James" href="/configuration_instructions.html" collapse="true" >
<item name="Server-wide" href="/serverwide_configuration.html" />
+ <item name="Domains" href="/domains_configuration.html" />
+ <item name="Users" href="/users_configuration.html" />
+ <item name="Mail Stores" href="/mailstores_configuration.html" />
<item name="DNS" href="/dns_configuration.html" />
- <item name="Remote Manager" href="/remotemanager_configuration.html" />
<item name="IMAP4" href="/imap4_configuration.html" />
<item name="POP3" href="/pop3_configuration.html" />
- <item name="SMTP and LMTP" href="/smtp_configuration.html" />
+ <item name="SMTP LMTP" href="/smtp_configuration.html" />
<!-- <item name="NNTP" href="/nntp_configuration.html" />-->
- <item name="SpoolManager" href="/spoolmanager_configuration.html" />
+ <item name="Mailet Container" href="/mailetcontainer_configuration.html" />
<item name="FetchMail" href="/fetchmail_configuration.html" />
- <item name="User Stores" href="/userstores_configuration.html" />
- <item name="Mail Stores" href="/mailstores_configuration.html" />
+ <item name="Remote Manager" href="/remotemanager_configuration.html" />
+ </item>
+ <item name="3. Manage James" href="/management_instructions.html" collapse="true" >
+ <item name="Domains" href="/adding_domains.html" />
+ <item name="Users" href="/adding_users.html" />
+ <item name="Virtual Users" href="/adding_virtual_users.html" />
+ </item>
+ <item name="4. Monitor James" href="/monitoring_instructions.html" collapse="true" >
+ <item name="Queues" href="/queues_monitoring.html" />
</item>
+ </menu>
+
+ <menu name="FAQ">
+ <item name="Upgrade from James 2.3" href="/upgrade_instructions.html" />
<item name="Common Configs" href="/common_configurations.html" />
+ <item name="James and Sendmail" href="/james_and_sendmail.html" />
<item name="Provided Mailets" href="/provided_mailets.html" />
<item name="Provided Matchers" href="/provided_matchers.html" />
- <item name="James and Sendmail" href="/james_and_sendmail.html" />
- <item name="Upgrade from 2.3" href="/upgrade_instructions.html" />
- <item name="Manage James" href="/management_instructions.html" collapse="true" >
- <item name="Domains and Users" href="/adding_domains_users.html" />
- </item>
</menu>
<menu name="Developers Corner">
Copied: james/server/trunk/src/site/xdoc/adding_domains.xml (from r1005819, james/server/trunk/src/site/xdoc/adding_domains_users.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/adding_domains.xml?p2=james/server/trunk/src/site/xdoc/adding_domains.xml&p1=james/server/trunk/src/site/xdoc/adding_domains_users.xml&r1=1005819&r2=1005906&rev=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/adding_domains_users.xml (original)
+++ james/server/trunk/src/site/xdoc/adding_domains.xml Fri Oct 8 17:08:02 2010
@@ -20,7 +20,7 @@
<document>
<properties>
- <title>James 3.0 - Adding Domains and Users</title>
+ <title>James 3.0 - Adding Domains</title>
</properties>
<body>
Added: james/server/trunk/src/site/xdoc/adding_users.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/adding_users.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/adding_users.xml (added)
+++ james/server/trunk/src/site/xdoc/adding_users.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,65 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Adding Users</title>
+ </properties>
+
+<body>
+
+ <section name="Creating User Accounts">
+
+ <p>User accounts are shared across services. A common user repository is shared across James
+ services. That is, once you've created a POP3 mail account and set a password, that same
+ account is available for authenticated SMTP and NNTP.</p>
+
+ <subsection name="Before You Add Accounts">
+ <p>In James, user accounts are created throught the RemoteManager. So, after installation is complete, the first step to adding users
+ is to configure the RemoteManager. More information on RemoteManager configuration can be found
+ <a href="remotemanager_configuration.html">here</a>. You will need to have configured at least one administrator account and
+ ensured that the RemoteManager is enabled.</p>
+ <p>Also, you need to make sure that your user repository configuration is correct before adding any users. If
+ you change your user repository type (i.e. file to database) or the configuration of your user repository
+ (i.e. the file or database URL) after you have added users, you may lose your user data. Please change these
+ values with care.</p>
+ <p>After you've done this, restart James to ensure that any changes you've made in the configuration are incorporated into
+ the running system. You are now ready to create user accounts.</p>
+ </subsection>
+
+ <p>Once James is up and listening, adding a user is simple:</p>
+ 1. Telnet to the host and port on which the RemoteManager is listening. For command-line telnet clients
+ this is generally done by typing "telnet <host> <port>" where <host> is the James
+ hostname and <port> is the RemoteManager port specified in the James config.xml.<br/><br/>
+ 2. You will be prompted for your administrator userid and password. Enter the values you specified
+ in the James config.xml.<br/><br/>
+ 3. After logging in, type "adduser <user> <password>" where <user> is the user name
+ and <password> is the password of the account you wish to create. Please note that the user name
+ should NOT be a complete email address. Rather, all email addresses of the form <user>@<domain>
+ (where <domain> is any of the values specified in the <servernames> block) will be delivered to
+ this account by default. Mailet configuration can change this default behavior.<br/><br/>
+ 4. Repeat step 3 for all user accounts you wish to create.
+ <p>That's it. Your user accounts are now created and can be used by all James services.</p>
+
+ </section>
+
+</body>
+
+</document>
Added: james/server/trunk/src/site/xdoc/adding_virtualusers.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/adding_virtualusers.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/adding_virtualusers.xml (added)
+++ james/server/trunk/src/site/xdoc/adding_virtualusers.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Adding Virtual Users</title>
+ </properties>
+
+<body>
+
+ <section name="Creating Virtual User">
+
+ </section>
+
+</body>
+
+</document>
Added: james/server/trunk/src/site/xdoc/domains_configuration.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/domains_configuration.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/domains_configuration.xml (added)
+++ james/server/trunk/src/site/xdoc/domains_configuration.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>Domains Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="Domains Configuration">
+
+ </section>
+
+</body>
+
+</document>
Modified: james/server/trunk/src/site/xdoc/extend_james.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/extend_james.xml?rev=1005906&r1=1005905&r2=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/extend_james.xml (original)
+++ james/server/trunk/src/site/xdoc/extend_james.xml Fri Oct 8 17:08:02 2010
@@ -27,6 +27,22 @@
<section name="Extend James">
+ <subsection name="Mailbox Store">
+
+ </subsection>
+
+ <subsection name="Mailbox Listeners">
+
+ </subsection>
+
+ <subsection name="Queue">
+
+ </subsection>
+
+ <subsection name="Queue Listeners">
+
+ </subsection>
+
</section>
</body>
Modified: james/server/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/index.xml?rev=1005906&r1=1005905&r2=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/index.xml (original)
+++ james/server/trunk/src/site/xdoc/index.xml Fri Oct 8 17:08:02 2010
@@ -21,43 +21,63 @@
<properties>
<title>James 3 - Index</title>
- </properties>
+ </properties>
<body>
- <section name="James 3.0-M1 (Milestone 1)">
+ <section name="James 3.0-M1">
- <p>James 3.0-M1 represents the leading edge of development. This codestream has many more
- features than the 2.x code, but is not as well tested in production. The internal APIs
- are under current validation and are expected to be subject to change. Reasonable
- configuration compatibility has been retained with 3.0.</p>
-
<p>The Java Apache Mail Enterprise Server (a.k.a. Apache James) is a 100% pure Java SMTP, IMAP4 and POP3 Mail
server designed to be a complete and portable enterprise mail engine solution.
James is based on currently available open protocols.</p>
- <p>The James server also serves as a mail application platform. The James project hosts the Apache Mailet API,
- and the James server is a Mailet container. This feature makes it easy to design, write, and deploy
- custom applications for mail processing. This modularity and ease of customization is one of James'
- strengths, and can allow administrators to produce powerful applications surprisingly easily.</p>
-
- <p>James is now built on top of Spring 3.0 in replacement of trunk version of the <a href="http://avalon.apache.org/">Avalon Application Framework</a>.
- With Spring, We keep the good development practices introduced by Avalon such as
- Component Oriented Programming and Inversion of Control.
- The stable and robust Spring container provides a strong foundation for the James server.</p>
-
- <p>James 3.0-M1 requires Java 1.5 but Java 1.6 is recommended.
- A migration guide for users willing to upgrade from 3.0 to 3.0 is under development.
- The NNTP News server present in James 3.0 has been removed from the 3.0 release line.</p>
-
- <p>This documentation is intended to be an introduction to the concepts behind the James implementation, as well
+ <p>This documentation is intended to be an introduction to the concepts behind the James usage, as well
as a guide to <a href="/installation_instructions.html">install</a>, <a href="/configuration_instructions.html">configure</a>
and <a href="/build_james.html">develop</a> the James server.</p>
+
+ <p>James is <b>secured</b>, <b>performant</b>, <b>extensible</b> and supports many <b>features</b>.
+ You can download stables releases, it from <a href="http://james.apache.org/download.cgi">here</a>
+ (or from here for latest <a href="http://repository.apache.org/content/groups/snapshots/org/apache/james/james-server-spring-deployment/3.0-SNAPSHOT/ ">snapshots</a>).</p>
+
+ <subsection name="Secured">
+
+ James is a secured mail server. See our <a href="/security.html">security</a> page to get more information.
+
+ </subsection>
+
+ <subsection name="Performant">
+
+ James is a performant mail server. See our <a href="/performance.html">performance</a> page to get some numbers.
+
+ </subsection>
+
+ <subsection name="Extensible">
+
+ <p>The James server also serves as a mail application platform. The James project hosts the Apache Mailet API,
+ and the James server is a Mailet container. This feature makes it easy to design, write, and deploy
+ custom applications for mail processing. This modularity and ease of customization is one of James'
+ strengths, and can allow administrators to produce powerful applications surprisingly easily.</p>
+
+ <p>James 3.0 is now built on top of Spring 3.0 in replacement of trunk version of the <a href="http://avalon.apache.org/">Avalon Application Framework</a>.
+ With Spring, We keep the good development practices introduced by Avalon such as
+ Component Oriented Programming and Inversion of Control.
+ The stable and robust Spring container provides a strong foundation for the James server.</p>
+
+ <p>The internal APIs for this first miletstone release are under current validation and are
+ expected to be subject to change.</p>
+
+ </subsection>
<subsection name="Features">
- <ul>
- <li>100% pure Java Mail and News server designed to be a complete and portable enterprise
+ <p>James 3.0 represents the leading edge of development. This codestream has many more
+ features than the 2.x code, but is not as well tested in production. Reasonable
+ configuration compatibility has been retained with 3.0. James 3.0 requires Java 1.5 but Java 1.6 is recommended.
+ A migration guide for users willing to upgrade from 3.0 to 3.0 is under development.
+ The NNTP News server present in James 2.3 has been removed from the 3.0 release line.</p>
+
+ <ul>
+ <li>100% pure Java Mail server designed to be a complete and portable enterprise
mail engine solution.</li>
<li>Supports currently available IETF protocols, including SMTP, POP3 and IMAP4
James is able to store user and message data either in a file-system (Maildir), any JPA-compatible database
@@ -71,6 +91,84 @@
messages/minute for continuous periods.</li>
</ul>
+ <table width="500">
+ <tr>
+ <th>Functionality</th>
+ <th align="center"><b>2.3.x</b></th>
+ <th align="center"><b>3.0</b></th>
+ </tr>
+ <tr>
+ <td>POP3</td>
+ <td align="center">yes</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>IMAP4</td>
+ <td align="center">no</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>SMTP</td>
+ <td align="center">yes</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>LMTP</td>
+ <td align="center">no</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>NNTP</td>
+ <td align="center">yes</td>
+ <td align="center">no</td>
+ </tr>
+ <tr>
+ <td>File Mail Store</td>
+ <td align="center">yes</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>JDBC Database Mail Store</td>
+ <td align="center">yes</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>JPA Database Mail Store</td>
+ <td align="center"></td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>JCR (Jackrabbit) Database Mail Store</td>
+ <td align="center">no</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>Alternate Store</td>
+ <td align="center">no</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>Mailets API</td>
+ <td align="center">yes</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>Alternate Queue</td>
+ <td align="center"></td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>SpamAssassin</td>
+ <td align="center">partial</td>
+ <td align="center">yes</td>
+ </tr>
+ <tr>
+ <td>IP V6</td>
+ <td align="center">no</td>
+ <td align="center">partial</td>
+ </tr>
+ </table>
+
</subsection>
<!-- This hierarchy is present in the menu. It will be easier to not replicate it here
Copied: james/server/trunk/src/site/xdoc/mailetcontainer.xml (from r1005819, james/server/trunk/src/site/xdoc/mailet_api.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/mailetcontainer.xml?p2=james/server/trunk/src/site/xdoc/mailetcontainer.xml&p1=james/server/trunk/src/site/xdoc/mailet_api.xml&r1=1005819&r2=1005906&rev=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/mailet_api.xml (original)
+++ james/server/trunk/src/site/xdoc/mailetcontainer.xml Fri Oct 8 17:08:02 2010
@@ -24,26 +24,102 @@
</properties>
<body>
-<section name="Mailet API">
-<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.html">here</a>, while descriptions of provided mailets can be found
-<a href="provided_mailets.html">here</a>.</p>
-</section>
+
+ <section name="Mailet API">
+
+ <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.html">here</a>, while descriptions of provided mailets can be found
+ <a href="provided_mailets.html">here</a>.</p>
+
+ </section>
+
+ <section name="The Spooler, 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>
+
+ <subsection name="Matchers and Mailets">
+
+ <p>Core to the SpoolManager operation are Matchers and Mailets. A Matcher is a
+ simple object that checks whether a mail message matches a particular condition.
+ A mailet is another type object that processes an email message in some way. Some
+ typical tasks appropriate for a mailet would be adding a header, delivering the message
+ to a local repository, or handling remote delivery. Both the Matcher and Mailet APIs are
+ public, allowing James users to write their own custom matchers and mailets. James
+ comes with a large set of pre-built matchers and mailets.</p>
+
+ <p>Matchers and mailets are used in pairs. At each stage in processing a message is checked
+ against a matcher. The matcher will attempt to match the mail message. The match is not simply
+ a yes or no issue. Instead, the match method returns a collection of matched recipients. If the
+ this collection of matched recipients is empty, the mailet is not invoked. If the collection of
+ matched recipients is the entire set of original recipients, the mail is then processed by the
+ associated mailet. Finally, if the matcher only matches a proper subset of the original recipients,
+ the original mail is duplicated. The recipients for one message are set to the matched recipients,
+ and that message is processed by the mailet. The recipients for the other mail are set to the
+ non-matching recipients, and that message is not processed by the mailet.</p>
+
+ <p>More on matchers and mailets can be found <a href="mailet_api.html">here</a>.</p>
+
+ </subsection>
+
+ <subsection name="Processors">
+
+ <p>One level up from the matchers and mailets are the processors. Each processor
+ is a list of matcher/mailet pairs. During mail processing, mail messages will be
+ processed by each pair, in order. In most cases, the message will be processed by
+ all the pairs in the processor. However, it is possible for a mailet to change the
+ state of the mail message so it is immediately directed to another processor, and no
+ additional processing occurs in the current processor. Typically this occurs when the mailet
+ wants to prevent future processing of this message (i.e. the mail message has been delivered locally,
+ and hence requires no further processing) or when the mail message has been identified
+ as a candidate for special processing (i.e. the message is spam and thus should be
+ routed to the spam processor). Because of this redirection, the processors in the
+ SpoolManager form a tree. The root processor, which must be present, is the root of
+ this tree.</p>
+
+ </subsection>
+
+ <p>The SpoolManager continually checks for mail in the spool repository. When
+ mail is first found in the repository, it is delivered to the root processor.
+ Mail can be placed on this spool from a number of sources (SMTP, FetchPOP, a
+ custom component). This spool repository is also used for storage of mail that is
+ being redirected from one processor to another. Mail messages are driven through
+ the processor tree until they reach the end of a processor or are marked completed
+ by a mailet.</p>
+
+ <p>More on configuration of the SpoolManager can be found <a href="spoolmanager_configuration.html">here</a>.</p>
+
+ <p>Much of the power of James lies in the SpoolManager component. Custom matchers and
+ mailets can be easily developed to address an administrator's particular needs. The
+ processor tree can easily be configured to sort, filter, and deliver mail based on any
+ number of criteria. Mail administrators new to James should spend some time learning how
+ to configure the SpoolManager to meet their needs.</p>
+
+ </section>
+
</body>
+
</document>
Copied: james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml (from r1005434, james/server/trunk/src/site/xdoc/spoolmanager_configuration.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml?p2=james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml&p1=james/server/trunk/src/site/xdoc/spoolmanager_configuration.xml&r1=1005434&r2=1005906&rev=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/spoolmanager_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/mailetcontainer_configuration.xml Fri Oct 8 17:08:02 2010
@@ -20,11 +20,11 @@
<document>
<properties>
- <title>James 3.0 - Configuring the SpoolManager</title>
+ <title>James 3.0 - Configuring the Mailet Container</title>
</properties>
<body>
-<section name="SpoolManager Configuration">
+<section name="Mailet Container Configuration">
<p>The SpoolManager is controlled by a single configuration block in the config.xml.
The spoolmanager tag defines the boundaries of the configuration block. The behavior of
the SpoolManager, most importantly the routing of mail messages through the processor tree,
Added: james/server/trunk/src/site/xdoc/monitoring_instructions.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/monitoring_instructions.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/monitoring_instructions.xml (added)
+++ james/server/trunk/src/site/xdoc/monitoring_instructions.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Monitoring Instructions</title>
+ </properties>
+
+<body>
+
+ <section name="Monitoring Instructions">
+
+ </section>
+
+</body>
+
+</document>
Added: james/server/trunk/src/site/xdoc/perfomance.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/perfomance.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/perfomance.xml (added)
+++ james/server/trunk/src/site/xdoc/perfomance.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>Performance</title>
+ </properties>
+
+<body>
+
+ <section name="Performance">
+
+ <p>James can spool more than 100 mails per second (configured with Maildir mail storage).</p>
+
+ <p>We ran following command (from postfix distribution) with only 10 dequeue threads.</p>
+
+ <source>time smtp-source -A -C1500 -l 100 -m 100000 -s 500 -d -c -f user@domain.net -t te localhost:25 100000</source>
+
+ <p>The result was:</p>
+ <ol>
+ <li>The queuing of the 100.000 emails took 8 minutes.</li>
+ <li>The dequeue of the 100.000 emails took 16 minutes.</li>
+ </ol>
+
+ <p>We thus have a troughput of more than <b>100 mails/second</b>.</p>
+
+ </section>
+
+</body>
+
+</document>
Added: james/server/trunk/src/site/xdoc/queue_priority.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/queue_priority.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/queue_priority.xml (added)
+++ james/server/trunk/src/site/xdoc/queue_priority.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>Queue Priority</title>
+ </properties>
+
+<body>
+
+ <section name="Queue">
+
+ </section>
+
+ <section name="Priority">
+
+ <p>Priority is supported when James (de)queues the mails during the spooling process.</p>
+
+ <p>For this just add a Mail header with name "MAIL_PRIORITY" to it.</p>
+
+ <p>This mail header should use one of the following value:</p>
+
+ <ol>
+ <li>0 for LOW_PRIORITY</li>
+ <li>5 for NORMAL_PRIORITY (default)</li>
+ <li>9 for HIGH_PRIORITY</li>
+ </ol>
+
+ <p>Default priority if no MAIL_PRIORITY attribute set is NORMAL_PRIORITY.</p>
+
+ </section>
+
+</body>
+
+</document>
Added: james/server/trunk/src/site/xdoc/queues_monitoring.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/queues_monitoring.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/queues_monitoring.xml (added)
+++ james/server/trunk/src/site/xdoc/queues_monitoring.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Queues Monitoring</title>
+ </properties>
+
+<body>
+
+ <section name="Queues Monitoring">
+
+ </section>
+
+</body>
+
+</document>
Added: james/server/trunk/src/site/xdoc/security.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/security.xml?rev=1005906&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/security.xml (added)
+++ james/server/trunk/src/site/xdoc/security.xml Fri Oct 8 17:08:02 2010
@@ -0,0 +1,42 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Security</title>
+ </properties>
+
+<body>
+
+ <section name="Protocol Security">
+
+ <p>TLS is supported.</p>
+
+ </section>
+
+ <section name="User Credential Security">
+
+ <p>LDAP is supported.</p>
+
+ </section>
+
+</body>
+
+</document>
Modified: james/server/trunk/src/site/xdoc/summary.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/summary.xml?rev=1005906&r1=1005905&r2=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/summary.xml (original)
+++ james/server/trunk/src/site/xdoc/summary.xml Fri Oct 8 17:08:02 2010
@@ -40,7 +40,7 @@
<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>
- <subsection name="SMTP Service">
+ <subsection name="SMTP Protocol">
<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,
@@ -51,7 +51,7 @@
</subsection>
- <subsection name="POP3 Service">
+ <subsection name="POP3 Protocol">
<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>
@@ -65,7 +65,7 @@
</subsection>
- <subsection name="IMAP4 Service">
+ <subsection name="IMAP4 Protocol">
<p>The IMAP4 protocol allows users to retrieve email messages. It is the method
most commonly used by email clients to download and manage email messages.</p>
@@ -75,7 +75,7 @@
IMAP4 clients. In addition, James can be configured to require SSL/TLS connections for
IMAP4 client connecting to the server.</p>
- <p>More information on configuring the POP3 service can be found <a href="imap4_configuration.html">here</a>.</p>
+ <p>More information on configuring the IMAP4 service can be found <a href="imap4_configuration.html">here</a>.</p>
</subsection>
@@ -90,7 +90,7 @@
</subsection>
- <subsection name="SpoolManager, Matchers, and Mailets">
+ <subsection name="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
Copied: james/server/trunk/src/site/xdoc/users_configuration.xml (from r1005434, james/server/trunk/src/site/xdoc/userstores_configuration.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/users_configuration.xml?p2=james/server/trunk/src/site/xdoc/users_configuration.xml&p1=james/server/trunk/src/site/xdoc/userstores_configuration.xml&r1=1005434&r2=1005906&rev=1005906&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/userstores_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/users_configuration.xml Fri Oct 8 17:08:02 2010
@@ -20,12 +20,12 @@
<document>
<properties>
- <title>User Stores Configuration</title>
+ <title>Users Configuration</title>
</properties>
<body>
- <section name="User Stores Configuration">
+ <section name="Users Configuration">
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org