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/09/29 15:41:36 UTC
svn commit: r1002625 - in /james/server/trunk/src/site: ./ apt/ xdoc/
Author: eric
Date: Wed Sep 29 13:41:36 2010
New Revision: 1002625
URL: http://svn.apache.org/viewvc?rev=1002625&view=rev
Log:
Safety commit to not loose work (JAMES-887)
Added:
james/server/trunk/src/site/xdoc/management_instructions.xml
james/server/trunk/src/site/xdoc/smtp_configuration.xml
james/server/trunk/src/site/xdoc/userstores_configuration.xml
Modified:
james/server/trunk/src/site/apt/release-notes.apt
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/build_james.xml
james/server/trunk/src/site/xdoc/fetchmail_configuration.xml
james/server/trunk/src/site/xdoc/index.xml
james/server/trunk/src/site/xdoc/mailstores_configuration.xml
james/server/trunk/src/site/xdoc/remotemanager_configuration.xml
james/server/trunk/src/site/xdoc/summary.xml
james/server/trunk/src/site/xdoc/upgrade_instructions.xml
Modified: james/server/trunk/src/site/apt/release-notes.apt
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/apt/release-notes.apt?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/apt/release-notes.apt (original)
+++ james/server/trunk/src/site/apt/release-notes.apt Wed Sep 29 13:41:36 2010
@@ -25,43 +25,30 @@
Release Notes
- 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).
-
- 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
- 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.
-
*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.
- James is a 100% pure Java Mail and News server designed to be a complete and portable enterprise
- mail engine solution. James 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
- and even JCR, allowing fast, reliable, even real-time replicated storage.
-
- James provides a powerful, flexible mail application engine through support for the Apache Mailet
- API. With its Mailet pipeline architecture, James can be used not only to provide standard e-mail
- services, but also to implement custom e-mail applications.
-
- The James mail server is deployed in production environments and has proven itself to be a robust
- and high performance mail solution. Tests indicate that version 3.0 is able to maintain a constant
- mail throughput rate of thousands of messages/minute for continuous periods.
-
- The James Community is also happy to announce the release of James version
- 3.0. Features for that version include enhancements to nearly every area of
+ 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).
+
+ 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
+ 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.
+
+ Features for that version include enhancements to nearly every area of
functionality, including full IMAP support, improved mailing list capabilities, fastfail support,
smtp-api for developing own fastfail filters and the next revision of the Mailet API. This was an
- exciting time in James development. 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.
+ exciting time in James development.
+
+ 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>
at http://james.apache.org/. Users interested in subscribing to the James
@@ -71,8 +58,7 @@ Release Notes
*2.3.1 Release Notes
- * Cryptography is now provided by
- {{{http://james.apache.org/mailet/crypto}Apache Crypto Mailets}}. Users
- should check that org.apache.james.mailet.crypto.mailet and
+ Cryptography is now provided by {{{http://james.apache.org/mailet/crypto}Apache Crypto Mailets}}.
+ Users should check that org.apache.james.mailet.crypto.mailet and
org.apache.james.mailet.crypto.matcher packages have been added to
the mailetpackages element in the configuration file.
Modified: james/server/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Wed Sep 29 13:41:36 2010
@@ -54,22 +54,25 @@
<item name="Server-wide" href="/serverwide_configuration.html" />
<item name="DNS" href="/dns_configuration.html" />
<item name="Remote Manager" href="/remotemanager_configuration.html" />
- <item name="Domains and Users" href="/adding_domains_users.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="NNTP" href="/nntp_configuration.html" />-->
<item name="SpoolManager" href="/spoolmanager_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>
- <item name="Common Configurations" href="/common_configurations.html" />
+ <item name="Common Configs" href="/common_configurations.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">
<item name="Architecture" href="/james_architecture.html" />
<item name="Build from source" href="/build_james.html" />
Modified: james/server/trunk/src/site/xdoc/build_james.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/build_james.xml?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/build_james.xml (original)
+++ james/server/trunk/src/site/xdoc/build_james.xml Wed Sep 29 13:41:36 2010
@@ -34,18 +34,19 @@
<p>There are two ways to get the James source code.</p>
<ol>
- <li>1. Download the source distribution - the source is available from the
+ <li>Download the source distribution - the source is available from the
<a href="http://james.apache.org/download.cgi">James release mirrors</a>.
Simply choose the version of James you'd like to download, and pick the source
distribution appropriate for your platform.</li>
- <li>2. Get the source code using SVN - this method gives you access to the cutting edge code
+ <li>Get the source code using SVN - this method gives you access to the cutting edge code
base. Instructions on how to use SVN to get the James source code (the jakarta-james distribution)
can be found <a href="http://www.apache.org/dev/version-control.html">here</a>.
James server repository is <a href="http://svn.apache.org/repos/asf/james/server/">here</a>.</li>
</ol>
<p>Currently, only the second option is available for James 3.0</p>
+ <p>We consider in this document that you have checked-out James source code in JAMES_SRC_HOME directory.</p>
<p>Consult the <a href="/james_architecture.html">architecture</a> page if you want to learn
- more on the source structure.</p>
+ more on the internal source structure.</p>
</section>
@@ -65,7 +66,7 @@
<section name="Build James source from Command Line">
- <p>In the top level directory (where the parent pom.xml resides), invoke maven with 'mvn' with any of the following command line arguments:
+ <p>In the JAMES_SRC_HOME top level directory (where the parent pom.xml resides), invoke maven with 'mvn' with any of the following command line arguments:
<ul>
<li>clean - deletes the target directory, making the system ready for a clean build.</li>
<li>compile - compiles the source code.</li>
@@ -75,7 +76,8 @@
<li>site - builds the entirety of the James website.</li>
</ul>
</p>
- <p>All build products are output in the 'spring-deployment/target'
+ <p>For example, invoke 'mvn package' to get a zip/tar of James distribution.</p>
+ <p>All built products are output in the 'spring-deployment/target'
subdirectory of the James source directory.
This directory will be deleted if you run build with the clean argument.</p>
<p><strong>Warning!</strong> Any changes you've made in the 'dist' directory
@@ -88,31 +90,31 @@
<subsection name="Import projects in Eclipse with m2eclipse">
- <table>
- <tr valign="top">
+ <table>
+ <tr valign="top">
+ <td><img src="./images/eclipse_import_maven_view_1.gif" width="300"/></td>
<td>
- <p>You should have Eclipse IDE with the <a href="http://m2eclipse.sonatype.org">m2eclipse</a> plugin installed.</p>
- <p>You need to import the maven project in the Eclipse workspace.</p>
- <p>Click on the 'File' menu and select 'Import'. Choose 'Existing Maven Project' and click on 'Next' button.</p>
+ <p>You should have Eclipse IDE with <a href="http://m2eclipse.sonatype.org">m2eclipse</a> plugin installed.</p>
+ <p>You now need to import the maven projects in the Eclipse workspace.</p>
+ <p>Therefore, click on the 'File' menu and select 'Import'. Choose 'Existing Maven Project' and click on 'Next' button.</p>
</td>
- <td><img src="./images/eclipse_import_maven_view_1.gif"/></td>
- </tr>
- </table>
+ </tr>
+ </table>
</subsection>
<subsection name="Select projects to import">
- <table>
- <tr valign="top">
+ <table>
+ <tr valign="top">
+ <td><img src="./images/eclipse_import_maven_view_2.gif" width="300"/></td>
<td>
- <p>Select the directory where you have checked out the source code.</p>
- <p>Eclipse should present you with the James modules.</p>
- <p>Click on 'Finish' to execute the import.</p>
+ <p>Select the JAMES_SRC_HOME directory where you have checked out the source code.</p>
+ <p>Eclipse should present you with the list of James server modules.</p>
+ <p>Select the modules you want to import (by default, all) and click on 'Finish' to execute the import.</p>
</td>
- <td><img src="./images/eclipse_import_maven_view_2.gif"/></td>
- </tr>
- </table>
+ </tr>
+ </table>
</subsection>
@@ -120,11 +122,11 @@
<table>
<tr valign="top">
+ <td><img src="./images/eclipse_m2eclipse_project_dependencies.gif" width="300"/></td>
<td>
<p>Check that 'Workspace resolution' is enable in m2eclipse plugin.</p>
- <p>Your changes in code will be directdly taken into account.</p>
+ <p>Your changes in code will be directly taken into account.</p>
</td>
- <td><img src="./images/eclipse_m2eclipse_project_dependencies.gif"/></td>
</tr>
</table>
@@ -132,31 +134,34 @@
<subsection name="Prepare projects">
- <table>
- <tr valign="top">
+ <table>
+ <tr valign="top">
+ <td><img src="./images/eclipse_m2eclipse_projects.gif" width="300"/></td>
<td>
- <p>Now you have James projects in Eclipse workspace, you still the following to prepare everything:</p>
+ <p>Now you have James projects in Eclipse workspace.</p>
+ <p>You still have to prepare the following to be able to run from Eclipse:</p>
<ol>
- <li>Copy the spring-beans.xml and log4j.properties from 'spring-deployment\src\main\config\james' directory to a source folder.</li>
- <li>Copy all files (except spring-beans.xml and log4j.properties) from 'spring-deployment\src\main\config\james' directory to a conf folder (subdirectory of the directory where you made the check-out).</li>
+ <li>Copy the spring-beans.xml and log4j.properties from 'spring-deployment\src\main\config\james' directory
+ to a source folder of 'spring-deployment' project (you can use for example the 'stage' folder as Eclipse source folder).</li>
+ <li>Copy all files (except spring-beans.xml and log4j.properties) from 'spring-deployment\src\main\config\james'
+ directory to a 'conf' folder ('conf' folder must be a subdirectory of the JAMES_SRC_HOME directory where you made the check-out).</li>
</ol>
- </td>
- <td><img src="./images/eclipse_m2eclipse_projects.gif"/></td>
- </tr>
- </table>
+ </td>
+ </tr>
+ </table>
</subsection>
<subsection name="Run James from Eclipse">
- <table>
- <tr valign="top">
+ <table>
+ <tr valign="top">
+ <td><img src="./images/eclipse_run_james.gif" width="300"/></td>
<td>
<p>That's it. Run James and Have Fun!.</p>
</td>
- <td><img src="./images/eclipse_run_james.gif"/></td>
- </tr>
- </table>
+ </tr>
+ </table>
</subsection>
Modified: james/server/trunk/src/site/xdoc/fetchmail_configuration.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/fetchmail_configuration.xml?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/fetchmail_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/fetchmail_configuration.xml Wed Sep 29 13:41:36 2010
@@ -42,10 +42,11 @@
if it had been delivered via standard SMTP.</p>
<p>
- <a href="#How Fetchmail Works">How Fetchmail Works</a><br/>
- <a href="#Fetchmail Configuration Parameters">Fetchmail Configuration Parameters</a><br/>
- <a href="#Fetchmail Examples">Fetchmail Examples</a><br/>
- <a href="#Fetchmail Caveats">Fetchmail Caveats</a>
+ <a href="#How_Fetchmail_Works">How Fetchmail Works</a><br/>
+ <a href="#Fetchmail_Configuration_Parameters">Fetchmail Configuration Parameters</a><br/>
+ <a href="#Fetchmail_Examples">Fetchmail Examples</a><br/>
+ <a href="#Fetchmail_Caveats">Fetchmail Caveats</a>
+ <a href="#Fetchmail_Gmail">Fetchmail Gmail</a>
</p>
</section>
@@ -969,10 +970,73 @@
See <a href="http://support.microsoft.com/kb/816896/en-us"> Bug description and fix</a></li>
</ul>
- </p>
+ </p>
</section>
+ <section name="Fetchmail Gmail">
+
+ <p>Use this configuration to fetch Gmail via POP3. Please don't forget to enable POP3 in Gmail (<a href="http://mail.google.com/support/bin/answer.py?answer=13273">read how-to</a>).</p>
+
+ <source>
+<fetchmail enabled="true">
+<fetch name="gmail.com">
+<accounts>
+<account user="YOUR_USER@gmail.com" password="YOUR_PASSWORD" recipient="YOUR_EMAIL_ADDRESS_IN_JAMES" ignorercpt-header="true"/>
+</accounts>
+<host>pop.gmail.com</host>
+<interval>600000</interval>
+<javaMailProviderName>pop3</javaMailProviderName>
+<javaMailFolderName>INBOX</javaMailFolderName>
+<javaMailProperties>
+<property name="mail.pop3.ssl.enable" value="true"/>
+</javaMailProperties>
+<fetchall>false</fetchall>
+<recursesubfolders>false</recursesubfolders>
+<defaultdomain>localhost</defaultdomain>
+<fetched leaveonserver="true" markseen="true"/>
+<remotereceivedheader index="1" reject="true" leaveonserver="true" markseen="false"/>
+<maxmessagesize limit="0" reject="false" leaveonserver="true" markseen="false"/>
+<undeliverable leaveonserver="true" markseen="false"/>
+<recipientnotfound defer="true" reject="true" leaveonserver="true" markseen="false"/>
+<blacklist reject="true" leaveonserver="true" markseen="false"> wibble@localhost, flobble@localhost</blacklist>
+<userundefined reject="true" leaveonserver="true" markseen="false" />
+<remoterecipient reject="true" leaveonserver="true" markseen="false" />
+</fetch>
+</fetchmail>
+ </source>
+
+ <p>Use this configuration to fetch Gmail via IMAP4. Please don't forget to enable IMAP4 in Gmail (<a href="http://mail.google.com/support/bin/answer.py?answer=77695">read how-to</a>).</p>
+
+ <source>
+<fetchmail enabled="true">
+<fetch name="gmail.com">
+<accounts>
+<account user="YOUR_USER@gmail.com" password="YOUR_PASSWORD" recipient="YOUR_EMAIL_ADDRESS_IN_JAMES" ignorercpt-header="true"/>
+</accounts>
+<host>imap.gmail.com</host>
+<interval>600000</interval>
+<javaMailProviderName>imap</javaMailProviderName>
+<javaMailFolderName>INBOX</javaMailFolderName>
+<javaMailProperties>
+<property name="mail.imap.ssl.enable" value="true"/>
+</javaMailProperties>
+<fetchall>false</fetchall>
+<recursesubfolders>false</recursesubfolders>
+<defaultdomain>localhost</defaultdomain>
+<fetched leaveonserver="true" markseen="true"/>
+<remotereceivedheader index="1" reject="true" leaveonserver="true" markseen="false"/>
+<maxmessagesize limit="0" reject="false" leaveonserver="true" markseen="false"/>
+<undeliverable leaveonserver="true" markseen="false"/>
+<recipientnotfound defer="true" reject="true" leaveonserver="true" markseen="false"/>
+<blacklist reject="true" leaveonserver="true" markseen="false"> wibble@localhost, flobble@localhost</blacklist>
+<userundefined reject="true" leaveonserver="true" markseen="false" />
+<remoterecipient reject="true" leaveonserver="true" markseen="false" />
+</fetch>
+</fetchmail>
+ </source>
+
+ </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=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/index.xml (original)
+++ james/server/trunk/src/site/xdoc/index.xml Wed Sep 29 13:41:36 2010
@@ -53,6 +53,25 @@
<p>This documentation is intended to be an introduction to the concepts behind the James implementation, 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>
+
+ <subsection name="Features">
+
+ <ul>
+ <li>100% pure Java Mail and News 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
+ and even JCR, allowing fast, reliable, even real-time replicated storage.</li>
+ <li>Provides a powerful, flexible mail application engine through support for the Apache Mailet
+ API. With its Mailet pipeline architecture, James can be used not only to provide standard e-mail
+ services, but also to implement custom e-mail applications.</li>
+ <li>Deployed in production environments and has proven itself to be a robust
+ and high performance mail solution. Tests indicate that version 3.0
+ is able to maintain a constant mail throughput rate of thousands of
+ messages/minute for continuous periods.</li>
+ </ul>
+
+ </subsection>
<!-- This hierarchy is present in the menu. It will be easier to not replicate it here
Modified: james/server/trunk/src/site/xdoc/mailstores_configuration.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/mailstores_configuration.xml?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/mailstores_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/mailstores_configuration.xml Wed Sep 29 13:41:36 2010
@@ -20,12 +20,15 @@
<document>
<properties>
- <title>Mail Store Configuration</title>
+ <title>Mail Stores Configuration</title>
</properties>
<body>
-<section name="Mail Store Configuration">
-</section>
+ <section name="Mail Stores Configuration">
+
+ </section>
+
</body>
+
</document>
Added: james/server/trunk/src/site/xdoc/management_instructions.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/management_instructions.xml?rev=1002625&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/management_instructions.xml (added)
+++ james/server/trunk/src/site/xdoc/management_instructions.xml Wed Sep 29 13:41:36 2010
@@ -0,0 +1,43 @@
+<?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 - Management</title>
+ </properties>
+
+<body>
+
+<section name="Management">
+
+ <p>Once James is up and listening, adding a user is simple:</p>
+ <ul>
+ <li>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.</li>
+ <li>You will be prompted for your administrator userid and password. Enter the values you specified
+ in the James config.xml.</li>
+ </ul>
+
+</section>
+
+</body>
+
+</document>
Modified: james/server/trunk/src/site/xdoc/remotemanager_configuration.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/remotemanager_configuration.xml?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/remotemanager_configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/remotemanager_configuration.xml Wed Sep 29 13:41:36 2010
@@ -24,55 +24,59 @@
</properties>
<body>
-<section name="RemoteManager Configuration">
-<p>The RemoteManager is controlled by a configuration block in the config.xml.
-The remotemanager tag defines the boundaries of the configuration block. It encloses
-all the relevant configuration for the RemoteManager. The behavior of the RemoteManager is
-controlled by the attributes and children of this tag.</p>
+ <section name="RemoteManager Configuration">
+
+ <p>The RemoteManager is controlled by a configuration block in the config.xml.
+ The remotemanager tag defines the boundaries of the configuration block. It encloses
+ all the relevant configuration for the RemoteManager. The behavior of the RemoteManager is
+ controlled by the attributes and children of this tag.</p>
+
+ <p>This tag has an optional boolean attribute - <strong>enabled</strong> - that defines whether the service is active or not. The value defaults to "true" if
+ not present.</p>
+ <p>The standard children of the remotemanager tag are:</p>
+ <ul>
+ <li><strong>port</strong> - This is an optional integer value. This value is the port on which this POP3 server is configured
+ to listen.If the tag or value is omitted, the value will default to 4555.</li>
+ <li><strong>bind</strong> - This is an optional value. If present, this value is a string describing
+ the IP address to which this service should be bound. If the tag or value is absent then the service
+ will bind to all network interfaces for the machine.</li>
+ <li><strong>useTLS</strong> - This is an optional boolean value. If this value is true, then the "ssl"
+ server socket factory is used to generate the server socket for this service. If it is false, the
+ "plain" server socket factory is used. In either case this behavior is overridden by the serverSocketType
+ tag which is described under the expert configuration options.</li>
+ <li><strong>handler</strong> - This is an artifact preserved for backwards compatibility. This tag
+ was used to group related parameters. It should disappear in future versions.</li>
+ <ul>
+ <li><strong>helloName</strong> - This is a required tag with an optional body that defines the server name
+ used in the initial service greeting. The tag may have an optional attribute - <strong>autodetect</strong>. If
+ the autodetect attribute is present and true, the service will use the local hostname
+ returned by the Java libraries. If autodetect is absent or false, the body of the tag will be used. In
+ this case, if no body is present, the value "localhost" will be used.</li>
+ <li><strong>administrator_accounts</strong> - This is an required container tag. It contains
+ one or more <strong>administrator_account</strong> elements, each of which has a <strong>login</strong> attribute
+ and a <strong>password</strong> attribute. These two attributes correspond to the login id and password for the
+ administrative account respectively. Obviously, for security reasons, these should be set upon James installation.</li>
+ <li><strong>connectionTimeout</strong> - This is an optional tag with an integer body. </li>
+ </ul>
+ </ul>
+ <p>There are a few additional children of the pop3server tag that are appropriate for advanced
+ configurations. These should only be used by expert administrators. All tags in this group are optional.</p>
+ <ul>
+ <li><strong>serverSocketFactory</strong> - This is an optional tag with a string body. If the tag is present,
+ the body must be the name of one of the server socket factories specified in the socket manager block. Any other
+ value will result in an error. If present, this tag overrides the useTLS tag.</li>
+ <li><strong>threadGroup</strong> - This is an optional tag with a string body. If the tag is present,
+ the body must be the name of one of the thread groups specified in the thread manager block. Any other
+ value will result in an error. This tag is best used to fine tune thread allocation between the services.</li>
+ <li><strong>connectionLimit</strong> - The connectionLimit parameter specifies the maximum number of client
+ connections that this service will allow. If no value is specified, the value defaults to that specified in
+ the connectionmanager block. A value of 0 means that there is no limit imposed
+ by the service, although resource limitations imposed by other components
+ (i.e. max # of threads) may serve to limit the number of open connections.</li>
+ </ul>
+
+ </section>
-<p>This tag has an optional boolean attribute - <strong>enabled</strong> - that defines whether the service is active or not. The value defaults to "true" if
-not present.</p>
-<p>The standard children of the remotemanager tag are:</p>
-<ul>
-<li><strong>port</strong> - This is an optional integer value. This value is the port on which this POP3 server is configured
-to listen.If the tag or value is omitted, the value will default to 4555.</li>
-<li><strong>bind</strong> - This is an optional value. If present, this value is a string describing
-the IP address to which this service should be bound. If the tag or value is absent then the service
-will bind to all network interfaces for the machine.</li>
-<li><strong>useTLS</strong> - This is an optional boolean value. If this value is true, then the "ssl"
-server socket factory is used to generate the server socket for this service. If it is false, the
-"plain" server socket factory is used. In either case this behavior is overridden by the serverSocketType
-tag which is described under the expert configuration options.</li>
-<li><strong>handler</strong> - This is an artifact preserved for backwards compatibility. This tag
-was used to group related parameters. It should disappear in future versions.</li>
-<ul>
-<li><strong>helloName</strong> - This is a required tag with an optional body that defines the server name
-used in the initial service greeting. The tag may have an optional attribute - <strong>autodetect</strong>. If
-the autodetect attribute is present and true, the service will use the local hostname
-returned by the Java libraries. If autodetect is absent or false, the body of the tag will be used. In
-this case, if no body is present, the value "localhost" will be used.</li>
-<li><strong>administrator_accounts</strong> - This is an required container tag. It contains
-one or more <strong>administrator_account</strong> elements, each of which has a <strong>login</strong> attribute
-and a <strong>password</strong> attribute. These two attributes correspond to the login id and password for the
-administrative account respectively. Obviously, for security reasons, these should be set upon James installation.</li>
-<li><strong>connectionTimeout</strong> - This is an optional tag with an integer body. </li>
-</ul>
-</ul>
-<p>There are a few additional children of the pop3server tag that are appropriate for advanced
-configurations. These should only be used by expert administrators. All tags in this group are optional.</p>
-<ul>
-<li><strong>serverSocketFactory</strong> - This is an optional tag with a string body. If the tag is present,
-the body must be the name of one of the server socket factories specified in the socket manager block. Any other
-value will result in an error. If present, this tag overrides the useTLS tag.</li>
-<li><strong>threadGroup</strong> - This is an optional tag with a string body. If the tag is present,
-the body must be the name of one of the thread groups specified in the thread manager block. Any other
-value will result in an error. This tag is best used to fine tune thread allocation between the services.</li>
-<li><strong>connectionLimit</strong> - The connectionLimit parameter specifies the maximum number of client
-connections that this service will allow. If no value is specified, the value defaults to that specified in
-the connectionmanager block. A value of 0 means that there is no limit imposed
-by the service, although resource limitations imposed by other components
-(i.e. max # of threads) may serve to limit the number of open connections.</li>
-</ul>
-</section>
</body>
+
</document>
Added: james/server/trunk/src/site/xdoc/smtp_configuration.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/smtp_configuration.xml?rev=1002625&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/smtp_configuration.xml (added)
+++ james/server/trunk/src/site/xdoc/smtp_configuration.xml Wed Sep 29 13:41:36 2010
@@ -0,0 +1,96 @@
+<?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 - Configuring the SMTP and LMTP Service</title>
+ </properties>
+
+<body>
+
+ <section name="SMTP Configuration">
+
+ <p>The SMTP service is controlled by a configuration block in the config.xml.
+ The smtpserver tag defines the boundaries of the configuration block. It encloses
+ all the relevant configuration for the SMTP server. The behavior of the SMTP service is
+ controlled by the attributes and children of this tag.</p>
+
+ <p>This tag has an optional boolean attribute - <strong>enabled</strong> - that defines whether the service is active or not. The value defaults to "true" if
+ not present.</p>
+
+ <p>The standard children of the smtpserver tag are:</p>
+
+ <ul>
+ <li><strong>port</strong> - This is an optional integer value. This value is the port on which this SMTP server is configured
+ to listen.If the tag or value is omitted, the value will default to the standard SMTP port, 25.</li>
+ <li><strong>bind</strong> - This is an optional value. If present, this value is a string describing
+ the IP address to which this service should be bound. If the tag or value is absent then the service
+ will bind to all network interfaces for the machine.</li>
+ <li><strong>useTLS</strong> - This is an optional boolean value. If this value is true, then the "ssl"
+ server socket factory is used to generate the server socket for this service. If it is false, the
+ "plain" server socket factory is used. In either case this behavior is overridden by the serverSocketType
+ tag which is described under the expert configuration options.</li>
+ <li><strong>handler</strong> - This is an artifact preserved for backwards compatibility. This tag
+ was used to group related parameters. It should disappear in future versions.</li>
+ <ul>
+ <li><strong>helloName</strong> - This is a required tag with an optional body that defines the server name
+ used in the initial service greeting. The tag may have an optional attribute - <strong>autodetect</strong>. If
+ the autodetect attribute is present and true, the service will use the local hostname
+ returned by the Java libraries. If autodetect is absent or false, the body of the tag will be used. In
+ this case, if no body is present, the value "localhost" will be used.</li>
+ <li><strong>connectionTimeout</strong> - This is an optional tag with a non-negative integer body. </li>
+ <li><strong>authRequired</strong> - This is an optional tag with a boolean body. If true, then the server will
+ require authentication before delivering mail to non-local email addresses. If this tag is absent, or the value
+ is false then the client will not be prompted for authentication. Only simple user/password authentication is
+ supported at this time.</li>
+ <li><strong>verifyIdentity</strong> - This is an optional tag with a boolean body. This option can only be used
+ if SMTP authentication is required. If the parameter is set to true then the sender address for the submitted message
+ will be verified against the authenticated subject.</li>
+ <li><strong>maxmessagesize</strong> - This is an optional tag with a non-negative integer body. It specifies the maximum
+ size, in kbytes, of any message that will be transmitted by this SMTP server. It is a service-wide, as opposed to
+ a per user, limit. If the value is zero then there is no limit. If the tag isn't specified, the service will
+ default to an unlimited message size.</li>
+ </ul>
+ </ul>
+ <p>There are a few additional children of the smtpserver tag that are appropriate for advanced
+ configurations. These should only be used by expert administrators. All tags in this group are optional.</p>
+ <ul>
+ <li><strong>serverSocketFactory</strong> - This is an optional tag with a string body. If the tag is present,
+ the body must be the name of one of the server socket factories specified in the socket manager block. Any other
+ value will result in an error. If present, this tag overrides the useTLS tag.</li>
+ <li><strong>threadGroup</strong> - This is an optional tag with a string body. If the tag is present,
+ the body must be the name of one of the thread groups specified in the thread manager block. Any other
+ value will result in an error. This tag is best used to fine tune thread allocation between the services.</li>
+ <li><strong>connectionLimit</strong> - The connectionLimit parameter specifies the maximum number of client
+ connections that this service will allow. If no value is specified, the value defaults to that specified in
+ the connectionmanager block. A value of 0 means that there is no limit imposed
+ by the service, although resource limitations imposed by other components
+ (i.e. max # of threads) may serve to limit the number of open connections.</li>
+ </ul>
+
+ </section>
+
+ <section name="LMTP Configuration">
+
+ </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=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/summary.xml (original)
+++ james/server/trunk/src/site/xdoc/summary.xml Wed Sep 29 13:41:36 2010
@@ -32,15 +32,25 @@
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
+ <p>The standard James distribution deploys inside the Spring dependency injection container.
+ In addition to providing a robust server architecture for James, the use of Spring 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>
+ <subsection 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.html">here</a>.</p>
+
+ </subsection>
+
<subsection name="POP3 Service">
<p>The POP3 protocol allows users to retrieve email messages. It is the method
@@ -55,14 +65,17 @@
</subsection>
- <subsection name="SMTP Service">
+ <subsection name="IMAP4 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>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>
- <p>More information on configuring the SMTP service can be found <a href="smtp_configuration.html">here</a>.</p>
+ <p>The James version of the IMAP4 service is a simple and straightforward implementation that
+ provides full compliance with the specification and maximum compatibility with common
+ 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>
</subsection>
@@ -77,7 +90,7 @@
</subsection>
- <subsection name="The 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
@@ -88,15 +101,16 @@
</subsection>
- <subsection name="Repositories">
+ <subsection name="Stores">
- <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>
+ <p>James uses a number of different stores/repositories to both store message data (email, news messages) and
+ user information. User stores/repositories contain user information, including user names, authentication
+ information, and aliases. Mail stores/repositories contain messages that have been delivered locally. Spool
+ Stores/repositories contain messages that are still being processed. 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>
+ <p>More information the stores can be found <a href="stores.html">here</a>.</p>
+
</subsection>
<subsection name="RemoteManager">
Modified: james/server/trunk/src/site/xdoc/upgrade_instructions.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/upgrade_instructions.xml?rev=1002625&r1=1002624&r2=1002625&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/upgrade_instructions.xml (original)
+++ james/server/trunk/src/site/xdoc/upgrade_instructions.xml Wed Sep 29 13:41:36 2010
@@ -25,6 +25,13 @@
<body>
+ <section name="Migration Tool">
+
+ <p>Provide a tool to migrate 2.3 mail-repositories to 3.0 mailbox-stores</p>
+ <p><a href="https://issues.apache.org/jira/browse/JAMES-1052">https://issues.apache.org/jira/browse/JAMES-1052</a></p>
+
+ </section>
+
<section name="Upgrading Comments">
<p>James upgrading involves a number of steps, each of which is described in some detail in the
following sections. But as this sequence of steps has confused some users in the past, additional
Added: james/server/trunk/src/site/xdoc/userstores_configuration.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/userstores_configuration.xml?rev=1002625&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/userstores_configuration.xml (added)
+++ james/server/trunk/src/site/xdoc/userstores_configuration.xml Wed Sep 29 13:41:36 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>User Stores Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="User Stores Configuration">
+
+ </section>
+
+</body>
+
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org