Author: eric
Date: Sun Oct 31 08:07:07 2010
New Revision: 1029272
URL: http://svn.apache.org/viewvc?rev=1029272&view=rev
Log:
Less large image - Rename domains to domainlist - Update ref to phoenix lib dir.
Added:
james/server/trunk/src/site/xdoc/configuration_domainlist.xml
- copied, changed from r1028756,
james/server/trunk/src/site/xdoc/configuration_domains.xml
Removed:
james/server/trunk/src/site/xdoc/configuration_domains.xml
Modified:
james/server/trunk/src/site/resources/images/uml/org.apache.james_package.png
james/server/trunk/src/site/resources/images/uml/org.apache.james_package_details.png
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/configuration.xml
james/server/trunk/src/site/xdoc/configuration_serverwide.xml
james/server/trunk/src/site/xdoc/dev_custom_mailet.xml
james/server/trunk/src/site/xdoc/dev_custom_matcher.xml
Modified:
james/server/trunk/src/site/resources/images/uml/org.apache.james_package.png
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/resources/images/uml/org.apache.james_package.png?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
Binary files - no diff available.
Modified:
james/server/trunk/src/site/resources/images/uml/org.apache.james_package_details.png
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/resources/images/uml/org.apache.james_package_details.png?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
Binary files - no diff available.
Modified: james/server/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Sun Oct 31 08:07:07 2010
@@ -58,7 +58,7 @@
<item name="1. Install James" href="/installation.html" />
<item name="2. Configure James" href="/configuration.html"
collapse="true" >
<item name="Server-wide" href="/configuration_serverwide.html" />
- <item name="Domains" href="/configuration_domains.html" />
+ <item name="DomainList" href="/configuration_domainlist.html" />
<item name="Users" href="/configuration_users.html" />
<item name="Mail Stores" href="/configuration_mailstores.html" />
<item name="DNS" href="/configuration_dns.html" />
Modified: james/server/trunk/src/site/xdoc/configuration.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration.xml?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/configuration.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration.xml Sun Oct 31 08:07:07 2010
@@ -29,11 +29,11 @@
<p>All configuration files resides in the conf and conf/META-INF
directories.</p>
- <p>You can configure James for on the following:</p>
+ <p>You can/must configure James for the following:</p>
<ul>
<li><a href="configuration_serverwide.html">Server-wide
Configuration</a></li>
- <li><a href="configuration_domains.html">Domains Configuration</a></li>
+ <li><a href="configuration_domainlist.html">Domains
Configuration</a></li>
<li><a href="configuration_users.html">Users Configuration</a></li>
<li><a href="configuration_mailstores.html">Mail Stores
Configuration</a></li>
<li><a href="configuration_dns.html">DNS Configuration</a></li>
Copied: james/server/trunk/src/site/xdoc/configuration_domainlist.xml (from
r1028756, james/server/trunk/src/site/xdoc/configuration_domains.xml)
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_domainlist.xml?p2=james/server/trunk/src/site/xdoc/configuration_domainlist.xml&p1=james/server/trunk/src/site/xdoc/configuration_domains.xml&r1=1028756&r2=1029272&rev=1029272&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/configuration_domains.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration_domainlist.xml Sun Oct 31
08:07:07 2010
@@ -20,12 +20,12 @@
<document>
<properties>
- <title>Domains Configuration</title>
+ <title>DomainList Configuration</title>
</properties>
<body>
- <section name="Domains Configuration">
+ <section name="DomainList Configuration">
</section>
Modified: james/server/trunk/src/site/xdoc/configuration_serverwide.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/configuration_serverwide.xml?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/configuration_serverwide.xml (original)
+++ james/server/trunk/src/site/xdoc/configuration_serverwide.xml Sun Oct 31
08:07:07 2010
@@ -36,7 +36,7 @@
<p>This configuration block is defined by the
<strong>mailserver</strong> tag. All administrators
need to adjust this configuration block upon installation. It no
attributes, but several
- children, all of which are required.
+ children, all of which are required.</p>
<ul>
<li><strong>postmaster</strong> - the body of this element is the
address that the server
@@ -50,6 +50,13 @@
will be treated as case-insensitive or not. The second attribute
configures whether local user
aliasing will be enabled. Finally, the value of the third attribute
determines whether forwarding
to potentially remote users will be enabled.</li>
+ </ul>
+
+ </subsection>
+
+ <subsection name="dnsservice.xml">
+
+ <ul>
<li><strong>servernames</strong> - this element determines exactly
which mail domains and IP
addresses the server will treat as local. It has two boolean
attributes -
<strong>autodetect</strong> and <strong>autodetectIP</strong>. The
first attribute, if true,
@@ -61,15 +68,7 @@
<li><strong>servername</strong> - a single host name or IP address
that should be added to the list of
mail domains that the server considers local.</li>
</ul>
- <li><strong>inboxRepository</strong> - This is a simple container tag
which contains a single child element.</li>
- <ul>
- <li><strong>repository</strong> - this defines the mail repository
that will be used to store
- mail delivered locally. This element has no body. The required
attribute <strong>type</strong>
- is always set to "MAIL". The required attribute
<strong>repositoryURL</strong> addresses the
- repository as described in <a href="concept_repositories.html">the
repository configuration section</a>.</li>
- </ul>
</ul>
- </p>
</subsection>
@@ -85,24 +84,8 @@
</subsection>
- <subsection name="The Objectstorage Block">
-
- <p>This block controls the low level file repository to file mapping.
- There is no need to modify this.</p>
-
- </subsection>
-
- <subsection name="The Socketmanager Block">
-
- <p>This block controls the socket types available inside James. Unless
you are intending to enable SSL, it
- shouldn't be necessary for you to adjust this block. For
modifications to this block that are required to
- enable TLS, see <a href="usingTLS.html">the using TLS section</a>.</p>
-
- </subsection>
-
<subsection name="Prepare for JMX on Windows">
-
<p>for let windows start with jmx username/password enabled you need to
modify the security settings for the jmx files
like descripted here:
http://download.oracle.com/javase/1.5.0/docs/guide/management/security-windows.html
@@ -124,9 +107,7 @@ on unix like operation systems the perms
<ul>
<li>log4j.properties: See <a href="monitoring_logging.html">logging
page</a></li>
<li>database.properties</li>
- <li>mailetpackages.xml and matcherpackages.xml</li>
<li>sqlResources.xml and mailboxManagerSqlResources.xml</li>
- <li>bayesiananalyzermanagement.xml</li>
</ul>
</subsection>
Modified: james/server/trunk/src/site/xdoc/dev_custom_mailet.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev_custom_mailet.xml?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev_custom_mailet.xml (original)
+++ james/server/trunk/src/site/xdoc/dev_custom_mailet.xml Sun Oct 31 08:07:07
2010
@@ -24,7 +24,9 @@
</properties>
<body>
+
<section name="Writing a Custom Mailet">
+
<p>Implementing a custom mailet is generally a simple task, most of whose
complexity
lies in coding the actual work to be done by the mailet. This is largely due
to the
simplicity of the Mailet interface and the fact that a GenericMailet class is
provided
@@ -35,6 +37,7 @@ logging details. While it provides a no
these can be easily overridden to provide useful functionality.</p>
<p>In general, the only four methods that you should need to implement are
init(), destroy(),
getMailetInfo(), and service(Mail). And only the last is required in all
cases.</p>
+
<subsection name="Configuration">
<p>As described in the <a href="spoolmanager_configuration.html">SpoolManager
configuration
section</a>, mailets are configured with a set of String (name, value) pairs.
These values are
@@ -44,6 +47,7 @@ information through use of the getInitPa
requested configuration value will yield the value if set, and null otherwise.
Configuration
values are available inside the init(), destroy(), and service(Mail)
methods.</p>
</subsection>
+
<subsection name="Logging">
<p>There is a simple logging mechanism provided by the Mailet API. It does
not support
logging levels, so any log filtering will have to be implemented in the Mailet
code.
@@ -54,6 +58,7 @@ methods.</p>
Mailet. So it may be desirable for you to override this method so you can
distinguish mailet
log entries by Mailet.</p>
</subsection>
+
<subsection name="Initialization">
<p>As part of the Mailet lifecycle, a Mailet is guaranteed to be initialized
immediately after
being instantiated. This happens once and only once for each Mailet instance.
The
@@ -62,6 +67,7 @@ take place. Depending on your Mailet, i
of the mailet. Initialization logic is implemented by overriding the init()
method of
GenericMailet.</p>
</subsection>
+
<subsection name="Servicing">
<p>The bulk of the Mailet logic is expected to be invoked from the
service(Mail) method. This
method is invoked each time a mail message is to be processed by the mailet.
The message is
@@ -70,6 +76,7 @@ passed in as an instance of the Mail int
few important differences. See the Javadoc for the interface for a
description of the additional
methods available on this wrapper.</p>
</subsection>
+
<subsection name="Destruction">
<p>As part of the Mailet lifecycle, a Mailet is guaranteed to be destroyed
when the container
cleans up the Mailet. This happens once and only once for each Mailet
instance. The
@@ -78,6 +85,7 @@ on your Mailet, it may or may not be nec
of the mailet. Destruction logic is implemented by overriding the destroy()
method of
GenericMailet.</p>
</subsection>
+
</section>
<section name="Deploying a Custom Mailet">
<p>Once a Mailet has been successfully implemented there are only a couple of
@@ -106,9 +114,8 @@ the provided .sar file and add them to t
or
</p>
<p>
-1c. Place a jar file containing the custom class files in the
path/to/james/apps/james/SAR-INF/lib subdirectory.
-Please note that you must start james once to get the apps/james/SAR-INF
directory created. After that is done create
-the lib directory and copy the jar to the directory.
+1c. Place a jar file containing the custom class files in
+/path/to/james/conf/lib/ subdirectory.
</p>
<p>
2. After this is done get sure you add the mailet package to the config.xml.
For example:
@@ -125,15 +132,18 @@ the lib directory and copy the jar to th
After that restart james.
</p>
</subsection>
+
<subsection name="James Configuration">
<p>Configuration of the processor chain is discussed
-<a href="spoolmanager_configuration.html">elsewhere</a> in this documentation.
The
+<a href="configuration_mailetcontainer.html">elsewhere</a> in this
documentation. The
details of configuring mailet deployment is discussed at length. Here we will
only comment
that it is important to add the appropriate mailet package for your custom
mailet to the
<mailetpackages> list and that the name of your mailet should not
conflict with any of
-the mailets described <a href="provided_mailets.html">here</a>.
+the mailets described <a href="dev_provided_mailets.html">here</a>.
</p>
</subsection>
+
</section>
+
</body>
</document>
Modified: james/server/trunk/src/site/xdoc/dev_custom_matcher.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev_custom_matcher.xml?rev=1029272&r1=1029271&r2=1029272&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev_custom_matcher.xml (original)
+++ james/server/trunk/src/site/xdoc/dev_custom_matcher.xml Sun Oct 31 08:07:07
2010
@@ -24,7 +24,9 @@
</properties>
<body>
+
<section name="Writing a Custom Matcher">
+
<p>Implementing a custom matcher is generally a simple task, most of whose
complexity
lies in coding the actual work to be done by the matcher. This is largely due
to the
simplicity of the Matcher interface and the fact that a couple of abstract
Matcher template
@@ -44,6 +46,7 @@ anon.</p>
each recipient is evaluated individually. It is a subclass of GenericMatcher,
and inherits
most of its behavior from that class. The only major difference is that
subclasses are
expected to override matchRecipient(MailAddress) rather than match(Mail).</p>
+
<subsection name="Configuration">
<p>Matchers are passed a single String as part of their configuration.
Interpretation of this
list is left entirely to the body of the Matcher. This String value is
available in
@@ -52,6 +55,7 @@ GenericMatcher class. This method retur
null if no value is set. The method getCondition() is available inside the
init(), destroy(), match(Mail),
and matchRecipient(MailAddress) methods.</p>
</subsection>
+
<subsection name="Logging">
<p>There is a simple logging mechanism provided by the Mailet API. It does
not support
logging levels, so any log filtering will have to be implemented in the
Matcher code.
@@ -62,6 +66,7 @@ and matchRecipient(MailAddress) methods.
Matcher. So it may be desirable for you to override this method so you can
distinguish Matcher
log entries by Matcher.</p>
</subsection>
+
<subsection name="Initialization">
<p>As part of the Matcher lifecycle, a Matcher is guaranteed to be initialized
immediately after
being instantiated. This happens once and only once for each Matcher
instance. The
@@ -70,6 +75,7 @@ take place. Depending on your Matcher,
of the Matcher. Initialization logic is implemented by overriding the init()
method of
GenericMatcher/GenericRecipientMatcher.</p>
</subsection>
+
<subsection name="Matching">
<p>It is the matching phase where the Matcher's work is done. The exact form
of this phase largely
depends on which Matcher superclass is subclassed.</p>
@@ -81,6 +87,7 @@ subclassed. In this case, developers mu
matchRecipient(MailAddress) method. This method returns true if the recipient
matches,
and false otherwise.</p>
</subsection>
+
<subsection name="Destruction">
<p>As part of the Matcher lifecycle, a Matcher is guaranteed to be destroyed
when the container
cleans up the Matcher. This happens once and only once for each Matcher
instance. The
@@ -89,7 +96,9 @@ on your Matcher, it may or may not be ne
of the Matcher. Destruction logic is implemented by overriding the destroy()
method of
GenericMatcher/GenericRecipientMatcher.</p>
</subsection>
+
</section>
+
<section name="Deploying a Custom Matcher">
<p>Once a Matcher has been successfully implemented there are only a couple of
additional steps necessary to actually deploy the Matcher.</p>
@@ -117,12 +126,11 @@ the provided .sar file and add them to t
or
</p>
<p>
-1c. Place a jar file containing the custom class files in the
path/to/james/apps/james/SAR-INF/lib subdirectory.
-Please note that you must start james once to get the apps/james/SAR-INF
directory created. After that is done create
-the lib directory and copy the jar to the directory.
+1c. Place a jar file containing the custom class files in
+/path/to/james/conf/lib/ subdirectory.
</p>
<p>
-2. After this is done get sure you add the matcher package to the config.xml.
For example:
+2. After this is done get sure you add the matcher package to the
mailetcontainer.xml. For example:
<p>
<source>
<!-- Set the Java packages from which to load mailets and matchers -->
@@ -136,15 +144,18 @@ the lib directory and copy the jar to th
After that restart james.
</p>
</subsection>
+
<subsection name="James Configuration">
<p>Configuration of the processor chain is discussed
-<a href="spoolmanager_configuration.html">elsewhere</a> in this documentation.
The
+<a href="configuration_mailetcontainer.html">elsewhere</a> in this
documentation. The
details of configuring matcher deployment is discussed at length. Here we
will only comment
that it is important to add the appropriate matcher package for your custom
matcher to the
<matcherpackages> list and that the name of your matcher should not
conflict with any of
-the matchers described <a href="provided_matchers.html">here</a>.
+the matchers described <a href="dev_provided_matchers.html">here</a>.
</p>
</subsection>
+
</section>
+
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
