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 ie...@apache.org on 2012/05/14 10:45:06 UTC
svn commit: r1338063 [3/7] - in /james/site-cms/trunk: ./ content/
content/resources/ content/resources/css/ content/resources/images/
content/resources/images/conf/ content/resources/images/database/
content/resources/images/dns-mx/ content/resources/...
Added: james/site-cms/trunk/content/xdoc/config-recipientrewritetable.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config-recipientrewritetable.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config-recipientrewritetable.xml (added)
+++ james/site-cms/trunk/content/xdoc/config-recipientrewritetable.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,86 @@
+<?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>Apache James Server 3 - Recipient Rewrite Table Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="Recipient Rewrite Table Configuration">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/recipientrewritetable-template.conf">recipientrewritetable-template.conf</a> in SVN to get some examples and hints.</p>
+
+ <subsection name="JPA Recipient Rewrite Table">
+
+ <p>The default table for storing James' Recipient Rewrite mappings.</p>
+
+ <p>Add a class attribute to recipientrewritetable tag (class="org.apache.james.rrt.jpa.JPARecipientRewriteTable).</p>
+
+ <dl>
+ <dt><strong>recursiveMapping</strong></dt>
+ <dd>If set recursiveMapping false only the first mapping will get processed - Default true.</dd>
+ <dt><strong>mappingLimit</strong></dt>
+ <dd>By setting the mappingLimit you can specify how much mapping will get processed before a bounce will send. This avoid infinity loops. Default 10.</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="XML Recipient Rewrite Table">
+
+ <p>Add a class attribute to recipientrewritetable tag (class="org.apache.james.rrt.xml.XMLRecipientRewriteTable).</p>
+
+ <dl>
+ <dt><strong>recursiveMapping</strong></dt>
+ <dd>If set recursiveMapping false only the first mapping will get processed - Default true.</dd>
+ <dt><strong>mappingLimit</strong></dt>
+ <dd>By setting the mappingLimit you can specify how much mapping will get processed before a bounce will send. This avoid infinity loops. Default 10.</dd>
+ <dt><strong>mapping</strong></dt>
+ <dd>Example: some@domain=someuser</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="JDBC Recipient Rewrite Table">
+
+ <p>Database backed RecipientRewrite table</p>
+
+ <p>Add a class attribute and a destinationURL attributed to recipientrewritetable tag (class="org.apache.james.rrt.jdbc.JDBCRecipientRewriteTable" destinationURL="db://maildb/RecipientRewriteTable").</p>
+
+ <p>Use these configurations to store the RecipientRewriteTable in a database.</p>
+
+ <dl>
+ <dt><strong>recursiveMapping</strong></dt>
+ <dd>If set recursiveMapping false only the first mapping will get processed - Default true.</dd>
+ <dt><strong>mappingLimit</strong></dt>
+ <dd>By setting the mappingLimit you can specify how much mapping will get processed before a bounce will send. This avoid infinity loops. Default 10.</dd>
+ <dt><strong>sqlFile</strong></dt>
+ <dd>file://conf/sqlResources.xml</dd>
+ </dl>
+
+ </subsection>
+
+ </section>
+
+</body>
+
+</document>
+
Propchange: james/site-cms/trunk/content/xdoc/config-recipientrewritetable.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/config-sieve.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config-sieve.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config-sieve.xml (added)
+++ james/site-cms/trunk/content/xdoc/config-sieve.xml Mon May 14 08:45:02 2012
@@ -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>Apache James Server 3 - Sieve Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="Sieve Configuration">
+
+ </section>
+
+</body>
+
+</document>
Propchange: james/site-cms/trunk/content/xdoc/config-sieve.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/config-smtp-lmtp.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config-smtp-lmtp.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config-smtp-lmtp.xml (added)
+++ james/site-cms/trunk/content/xdoc/config-smtp-lmtp.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,211 @@
+<?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>Apache James Server 3 - Configuring the SMTP and LMTP Service</title>
+ </properties>
+
+<body>
+
+ <section name="Incoming and outgoing SMTP">
+
+ <p>This page details the configuration for Incoming SMTP</p>
+
+ <p>The outgoing (remote delivery) is implemented in the RemoteDelivery mailets. The configuration details for
+ outgoing SMTP traffic can be read on <a href="dev-provided-mailets.html">this page</a> (section RemoteDelivery) and
+ shoud be update in the <a href="config-mailetcontainer.html">mailetcontainer</a>.</p>
+
+ </section>
+
+ <section name="SMTP Configuration">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/smtpserver-template.conf">smtpserver-template.conf</a> in SVN to get some examples and hints.</p>
+
+ <p>The SMTP service is controlled by a configuration block in the smptserver.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>
+
+ <dl>
+ <dt><strong>bind</strong></dt>
+ <dd>A list of address:port - 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 on port 25. Port 25 is the well-known/IANA registered port for SMTP.
+ Port 465 is the well-known/IANA registered port for SMTP over TLS.</dd>
+ <dt><strong>connectBacklog</strong></dt>
+ <dd></dd>
+ <dt><strong>tls</strong></dt>
+ <dd>Set to true to support STARTTLS or SSL for the Socket.
+ To use this you need to copy sunjce_provider.jar to /path/james/lib directory. To create a new keystore execute:
+ keytool -genkey -alias james -keyalg RSA -keystore /path/to/james/conf/keystore. The algorithm is optional and only needs to be specified when using something other
+ than the Sun JCE provider - You could use IbmX509 with IBM Java runtime.</dd>
+ <dt><strong>handler.helloName</strong></dt>
+ <dd>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.</dd>
+ <dt><strong>handler.connectionTimeout</strong></dt>
+ <dd>This is an optional tag with a non-negative integer body. Connection timeout in secconds.</dd>
+ <dt><strong>handler.connectionLimit</strong></dt>
+ <dd>Set the maximum simultaneous incoming connections for this service.</dd>
+ <dt><strong>handler.connectionLimitPerIP</strong></dt>
+ <dd>Set the maximum simultaneous incoming connections per IP for this service.</dd>
+ <dt><strong>handler.authRequired</strong></dt>
+ <dd>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. supported values:
+ true: required but announced only to not authorizedAddresses
+ false: don't use AUTH
+ announce: like true, but always announce AUTH capability to clients
+
+ The correct behaviour per RFC value would be false or announce
+ but we still support true for backward compatibility and because
+ some webmail client fails when AUTH is announced but no authentication
+ information has been provided</dd>
+ <dt><strong>handler.authorizedAddresses</strong></dt>
+ <dd>Authorize specific addresses/networks.
+ If you use SMTP AUTH, addresses that match those specified here will
+ be permitted to relay without SMTP AUTH. If you do not use SMTP
+ AUTH, and you specify addreses here, then only addresses that match
+ those specified will be permitted to relay.
+
+ Addresses may be specified as a an IP address or domain name, with an
+ optional netmask, e.g.,
+
+ 127.*, 127.0.0.0/8, 127.0.0.0/255.0.0.0, and localhost/8 are all the same
+
+ See also the RemoteAddrNotInNetwork matcher in the transport processor.
+ You would generally use one OR the other approach.</dd>
+ <dt><strong>handler.verifyIdentity</strong></dt>
+ <dd>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. Verify sender addresses, ensuring that
+ the sender address matches the user who has authenticated.
+ This prevents a user of your mail server from acting as someone else
+ If unspecified, default value is true.</dd>
+ <dt><strong>handler.maxmessagesize</strong></dt>
+ <dd>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.</dd>
+ <dt><strong>handler.heloEhloEnforcement</strong></dt>
+ <dd>This sets wether to enforce the use of HELO/EHLO salutation before a
+ MAIL command is accepted. If unspecified, the value defaults to true.</dd>
+ <dt><strong>handler.addressBracketsEnforcement</strong></dt>
+ <dd>WARNING: This is Non-RFC compliant (default value: true)
+ See: http://wiki.apache.org/james/StandardsComplianceStatement</dd>
+ <dt><strong>handler.smtpGreeting</strong></dt>
+ <dd>This sets the SMTPGreeting which will be used when connect to the smtpserver
+ If none is specified a default is generated</dd>
+ <dt><strong>handler.handlerchain</strong></dt>
+ <dd></dd>
+ <dt><strong>handler.handlerchain</strong></dt>
+ <dd>The configuration handler chain</dd>
+ </dl>
+
+ <subsection name="Configure Authenticated SMTP (SMTP AUTH)">
+
+ <p>Authenticated SMTP is a method of securing your SMTP server. With SMTP AUTH enabled senders who wish to
+ relay mail through the SMTP server (that is, send mail that is eventually to be delivered to another SMTP
+ server) must authenticate themselves to Apache James Server before sending their message. Mail that is to be delivered
+ locally does not require authentication. This method ensures that spammers cannot use your SMTP server
+ to send unauthorized mail, while still enabling users who may not have fixed IP addresses to send their
+ messages.</p>
+
+ <p>Mail servers that allow spammers to send unauthorized email are known as open relays. So SMTP AUTH
+ is a mechanism for ensuring that your server is not an open relay .</p>
+
+ <p>At this time Apache James Server only supports simple user name / password authentication.</p>
+
+ <p>Configuring Apache James Server for Authentication SMTP is a multi-step process. It requires several adjustments of
+ the smtpserver.xml. To enable SMTP AUTH, do the following:</p>
+
+ <ol>
+
+ <li>As mentioned above, SMTP AUTH requires that Apache James Server be able to distinguish between mail intended
+ for local delivery and mail intended for remote delivery. Apache James Server makes this determination by matching the
+ domain to which the mail was sent against the <servernames> element of the Apache James Server configuration block. Any
+ local domains should be explicitly listed as <servername> elements in this section.</li>
+<!--
+Correct this.
+ <li>Apache James Server is configured out of the box so as to not serve as an open relay for spammers. This is done
+ by restricting the IP addresses from which mail will be accepted using the RemoteAddrNotInNetwork mailet. This
+ restriction must be lifted before users can send from arbitrary clients. To do this, comment out or remove the
+ mailet tag containing the class attribute "RemoteAddrNotInNetwork". This tag can be found in the spoolmanager
+ configuration block, in the root processor configuration.</li>
+-->
+ <li>set the authRequired element of the smtpserver configuration block to "true".</li>
+
+ <li>if you wish to ensure that authenticated users can only send email from their own account, you may
+ optionally set the verifyIdentity element of the smtpserver configuration block to "true".</li>
+
+ <li>Restart Apache James Server. This will pull in all of your configuration changes.</li>
+
+ </ol>
+
+ <p>Finally, you need to verify that your configuration was done correctly. This step is
+ <strong>important</strong> and should not be skipped.</p>
+
+ <p>Verify that you have not inadvertantly configured your server as an open relay. This is most easily
+ accomplished by using the service provided at <a href="http://www.abuse.net/relay.html">abuse.net</a>. abuse.net will
+ check your mail server and inform you if it is an open relay.</p>
+
+ <p>It is extremely important that your server not be configured as an open relay. Aside from potential
+ costs associated with usage by spammers, connections from servers that are determined to be open relays
+ are routinely rejected by SMTP servers. This can severely impede the ability of your mail server to
+ send mail.</p>
+
+ <p>Of course it is also necessary to confirm that users and log in and send
+ mail through your server. This can be accomplished using any standard mail client (i.e. Thunderbird, Outlook,
+ Eudora, Evolution).</p>
+
+ </subsection>
+
+ <subsection name="Configure multiple SMTP servers">
+<!--
+ <p>Read <a href="https://issues.apache.org/jira/browse/JAMES-1105">https://issues.apache.org/jira/browse/JAMES-1105</a>
+ for ideas to have multiple SMTP port open.</p>
+-->
+ </subsection>
+
+ </section>
+
+ <section name="LMTP Configuration">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/lmtpserver-template.conf">lmtpserver-template.conf</a> in SVN to get some examples and hints.</p>
+
+ <p>The configuration is the same of for SMTP.</p>
+
+ <p>By default, it is desactivated. You can activate it with SMTP and bind for example on port 24.</p>
+
+ </section>
+
+</body>
+
+</document>
+
Propchange: james/site-cms/trunk/content/xdoc/config-smtp-lmtp.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/config-ssl-tls.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config-ssl-tls.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config-ssl-tls.xml (added)
+++ james/site-cms/trunk/content/xdoc/config-ssl-tls.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,161 @@
+<?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>Apache James Server 3 - SSL / TLS Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="SSL / TLS Configuration">
+
+ <p>This document explains how to enable James 3.0 servers to use Transport Layer Security (TLS) for encrypted client-server communication.</p>
+
+ <subsection name="Configure a Server to Use SSL/TLS">
+
+ <p>Each of the servers <a href="config-smtp-lmtp.html">SMTP</a>,
+ <a href="config-pop3.html">POP3</a> and <a href="config-imap.html">IMAP</a>
+ supports use of SSL/TLS.</p>
+
+ <p>TLS (Transport Layer Security) and SSL (Secure Sockets Layer) are protocols that provide
+ data encryption and authentication between applications in scenarios where that data is
+ being sent across an insecure network, such as checking your email
+ (How does the Secure Socket Layer work?). The terms SSL and TLS are often used
+ interchangeably or in conjunction with each other (TLS/SSL),
+ but one is in fact the predecessor of the other â SSL 3.0 served as the basis
+ for TLS 1.0 which, as a result, is sometimes referred to as SSL 3.1.</p>
+
+ <p>You need to add a block in the corresponding configuration file (smtpserver.xml, pop3server.xml, imapserver.xml,..)</p>
+
+ <source>
+<tls socketTLS="false" startTLS="false">
+ <keystore>file://conf/keystore</keystore>
+ <secret>yoursecret</secret>
+ <provider>org.bouncycastle.jce.provider.BouncyCastleProvider</provider>
+</tls>
+</source>
+
+ <p>Each of these block has an optional boolean configuration element <b>socketTLS</b> and <b>startTLS</b> which is used to toggle
+ use of SSL or TLS for the service.</p>
+
+ <p>With socketTLS (SSL/TLS in Thunderbird), all the communication is encrypted.</p>
+
+ <p>With startTLS (STARTTLS in Thunderbird), the preamble is readable, but the rest is encrypted.</p>
+
+<code>
+* OK JAMES IMAP4rev1 Server Server 192.168.1.4 is ready.
+* CAPABILITY IMAP4rev1 LITERAL+ CHILDREN WITHIN STARTTLS IDLE NAMESPACE UIDPLUS UNSELECT AUTH=PLAIN
+1 OK CAPABILITY completed.
+2 OK STARTTLS Begin TLS negotiation now.
+... rest is encrypted...
+</code>
+
+ <p>You can only enable one of the both at the same time for a service.</p>
+
+ <p>It is also recommended to change the port number on which the service will listen:</p>
+ <ul>
+ <li>POP3 - port 110, Secure POP3 - port 995</li>
+ <li>IMAP - port 143, Secure IMAP4 - port 993</li>
+ <li>SMTP - port 25, Secure SMTP - port 465</li>
+ </ul>
+
+ <p>You will now need to create your certificate store and place it in the james/conf/ folder with the name you defined in the keystore tag.</p>
+
+ </subsection>
+
+ <subsection name="Certificate Keystores">
+
+ <p>To use TLS/SSL inside James you will need a certificate keystore.</p>
+ <p></p>
+
+ <p><b>Creating your own Certificate Keystore</b></p>
+ <p>(Adapted from the Tomcat 4.1 documentation)</p>
+ <p>James currently operates only on JKS format keystores. This is Java's standard "Java KeyStore" format, and is the format created by the keytool command-line utility. This tool is included in the JDK.</p>
+ <p>To import an existing certificate into a JKS keystore, please read the documentation (in your JDK documentation package) about keytool.</p>
+ <p>To create a new keystore from scratch, containing a single self-signed Certificate, execute the following from a terminal command line:</p>
+ <p><code>keytool -genkey -alias james -keyalg RSA -keystore your_keystore_filename</code></p>
+ <p>(The RSA algorithm should be preferred as a secure algorithm, and this also ensures general compatibility with other servers and components.)</p>
+ <p>As a suggested standard, create the keystore in the james/conf directory, with a name like james.keystore.</p>
+ <p>After executing this command, you will first be prompted for the keystore password.</p>
+ <p>Next, you will be prompted for general information about this Certificate, such as company, contact name, and so on. This information may be displayed to users when importing into the certificate store of the client, so make sure that the information provided here matches what they will expect.</p>
+ <p>Important: in the "distinguished name", set the "common name" (CN) to the DNS name of your James server, the one you will use to access it from your mail client (like "mail.xyz.com").</p>
+ <p>Finally, you will be prompted for the key password, which is the password specifically for this Certificate (as opposed to any other Certificates stored in the same keystore file).</p>
+ <p>If everything was successful, you now have a keystore file with a Certificate that can be used by your server.</p>
+ <p>You MUST have only one certificate in the keystore file used by James.</p>
+ <p></p>
+
+ <p><b>Installing a Certificate provided by a Certificate Authority</b></p>
+ <p>(Adapted from the Tomcat 4.1 documentation</p>
+ <p>To obtain and install a Certificate from a Certificate Authority (like verisign.com, thawte.com or trustcenter.de) you should have read the previous section and then follow these instructions:</p>
+ <p>Create a local Certificate Signing Request (CSR)</p>
+ <p>In order to obtain a Certificate from the Certificate Authority of your choice you have to create a so called Certificate Signing Request (CSR). That CSR will be used by the Certificate Authority to create a Certificate that will identify your James server as "secure". To create a CSR follow these steps:</p>
+ <p>Create a local Certificate as described in the previous section.</p>
+ <p>The CSR is then created with:</p>
+ <p>keytool -certreq -keyalg RSA -alias james -file certreq.csr -keystore your_keystore_filename</p>
+ <p>Now you have a file called certreq.csr. The file is encoded in PEM format. You can submit it to the Certificate Authority (look at the documentation of the Certificate Authority website on how to do this). In return you get a Certificate.</p>
+ <p></p>
+ <p>Now that you have your Certificate you can import it into you local keystore. First of all you may have to import a so called Chain Certificate or Root Certificate into your keystore (the major Certificate Authorities are already in place, so it's unlikely that you will need to perform this step). After that you can procede with importing your Certificate.</p>
+ <p>Optionally Importing a so called Chain Certificate or Root Certificate</p>
+ <p>Download a Chain Certificate from the Certificate Authority you obtained the Certificate from.</p>
+ <p>For Verisign.com go to: http://www.verisign.com/support/install/intermediate.html</p>
+ <p>For Trustcenter.de go to: http://www.trustcenter.de/certservices/cacerts/en/en.htm#server</p>
+ <p>For Thawte.com go to: http://www.thawte.com/certs/trustmap.html (seems no longer valid)</p>
+ <p>Import the Chain Certificate into you keystore</p>
+ <p>keytool -import -alias root -keystore your_keystore_filename -trustcacerts -file filename_of_the_chain_certificate</p>
+ <p></p>
+ <p>And finally import your new Certificate (It must be in X509 format):</p>
+ <p>keytool -import -alias james -keystore your_keystore_filename -trustcacerts -file your_certificate_filename</p>
+ <p></p>
+ <p>See also: http://www.agentbob.info/agentbob/79.html</p>
+
+ </subsection>
+
+ <subsection name="Verifying a SSL/TLS-enabled James Server">
+
+ <p>After you've configured a particular server to use TLS/SSL connections, the server port
+ should no longer accept unencrypted TCP/IP connections. This can be tested by using a telnet
+ client to directly connect to the server port. The telnet connection should simply hang until
+ the client times out.</p>
+
+ <p>To validate that the port is properly accepting SSL connections an SSL client can be used to
+ open a connection to the server port. One such client is OpenSSL, available from the
+ <a href="http://www.openssl.org">OpenSSL web site</a>. Follow the instructions provided with
+ the SSL client to create a connection to the server port. Upon connection, the usual
+ server greeting should appear.</p>
+
+ <source>
+/usr/bin/openssl s_client -quiet -connect localhost:465
+depth=0 /C=Unknown/ST=Unknown/L=Unknown/O=Unknown/OU=Unknown/CN=Unknown
+verify error:num=18:self signed certificate
+verify return:1
+depth=0 /C=Unknown/ST=Unknown/L=Unknown/O=Unknown/OU=Unknown/CN=Unknown
+verify return:1
+220 192.168.0.208 SMTP Server (JAMES SMTP Server) ready Thu, 9 Jun
+2011 20:31:07 +0200 (CEST)
+</source>
+
+ </subsection>
+
+ </section>
+
+</body>
+
+</document>
Propchange: james/site-cms/trunk/content/xdoc/config-ssl-tls.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/config-system.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config-system.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config-system.xml (added)
+++ james/site-cms/trunk/content/xdoc/config-system.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,161 @@
+<?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>Apache James Server 3 - Server Wide Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="Server Wide Configuration">
+
+ <subsection name="Introduction">
+
+ <p>There are a number of global configuration files that do not fall into any one
+ component. They have effects that are global in scope across the server.</p>
+
+ <p>Some of these files are crucial, while others can be ignored by any but the most sophisticated
+ server administrators.</p>
+
+ </subsection>
+
+ <subsection name="spring-server.xml">
+
+ <p>In James distribution, the spring files are located under conf/context folder and splitted into a main
+ file (james-server-context.xml) which imports 4 other files (1 per mailbox type): james-mailbox-jcr-context.xml, james-mailbox-jpa-context.xml,
+ james-mailbox-maildir-context.xml, james-mailbox-memory-context.xml.</p>
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/META-INF/org/apache/james/spring-server.xml">spring-server.xml</a> in SVN to
+ get some examples and hints.</p>
+
+ <p>spring beans files are the place where the Apache James Server wiring is done. It should be modified only by expert-users.</p>
+
+ </subsection>
+
+ <subsection name="james-database.properties">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/james-database-template.properties">james-database.properties</a> in SVN to get some examples and hints.</p>
+
+ <p>The database connection in database.properties</p>
+
+ <p>James has the capacity to use a JDBC-compatible database for storage of both message and user
+ data. This section explains how to configure James to utilize a database for storage.</p>
+
+ <p>To avoid vendor-specific issues, the JPA (Java Persistence Architecture) is used (using the Apache OpenJPA implementation).</p>
+
+ <p>There must be a database instance accessible from the James server. An account with appropriate
+ privileges (select, insert, delete into tables, and on initial startup creation of tables) and
+ with sufficient quota for the data to be inserted into the database must be available.</p>
+
+ <p>Also, since James will use JDBC to access the database, an appropriate JDBC driver must be
+ available for installation. You can place the JDBC driver jar in the conf/lib folder, it will
+ be automatically loaded.</p>
+
+ <dl>
+ <dt><strong>database.driverClassName</strong></dt>
+ <dd>he class name of the database driver to be used.</dd>
+ <dt><strong>database.url</strong></dt>
+ <dd>The JDBC connection URL for your database/driver.</dd>
+ <dt><strong>database.username</strong></dt>
+ <dd>The user id of the database account to be used by this connection.</dd>
+ <dt><strong>database.password</strong></dt>
+ <dd>The password of the database account to be used by this connection.</dd>
+ <dt><strong>vendorAdapter.database</strong></dt>
+ <dd>Supported adapters are: DB2, DERBY, H2, HSQL, INFORMIX, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, SYBASE .</dd>
+ <dt><strong>openjpa.streaming</strong></dt>
+ <dd>true or false - Use streaming for Blobs. This is only supported on a limited set of databases atm. You
+ should check if its supported by your DB before enable it. See <a href="http://openjpa.apache.org/builds/latest/docs/manual/ref_guide_mapping_jpa.html">http://openjpa.apache.org/builds/latest/docs/manual/ref_guide_mapping_jpa.html</a> (#7.11. LOB Streaming).</dd>
+ </dl>
+
+ <p>Note for postgresql databases: Add standard_conforming_strings=off to your postgresql.conf, otherwise you
+ will get ""Invalid escape string Hint: Escape string must be empty or one character. {prepstmnt 174928937
+ SELECT t0.mailbox_id, t0.mailbox_highest_modseq, t0.mailbox_last_uid, t0.mailbox_name, t0.mailbox_namespace,
+ t0.mailbox_uid_validity, t0.user_name FROM public.james_mailbox t0 WHERE (t0.mailbox_name LIKE ?
+ ESCAPE '\\' AND t0.user_name = ? AND t0.mailbox_namespace = ?) [params=?, ?, ?]} [code=0, state=22025]"</p>
+
+ </subsection>
+
+ <subsection name="META-INF/persistence.xml">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/META-INF/persistence.xml">META-INF/persistence.xml</a> in SVN to get some examples and hints.</p>
+
+ <p>The JPA mapping and properties are defined in the in META-INF/persistence.xml.</p>
+
+ <p>You can override the definition in external file and importing the external file in the persistence.xml (see jpa-mappings.xml provided example in SVN)</p>
+
+ <source>
+<mapping-file>META-INF/jpa-mappings.xml</mapping-file></source>
+
+ </subsection>
+
+ <subsection name="jmx.properties">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/jmx-template.properties">jmx.properties</a> in SVN to get some examples and hints.</p>
+
+ <p>This is used to configure the JMX MBean server via which all management is achieved (also used by via the james-cli).</p>
+
+ <dl>
+ <dt><strong>jmx.address</strong></dt>
+ <dd>The IP address (host name) the MBean Server will bind/listen to.</dd>
+ <dt><strong>jmx.port</strong></dt>
+ <dd>The port number the MBean Server will bind/listen to.</dd>
+ </dl>
+
+ <p>To access from a remote location, it has been reported that -Dcom.sun.management.jmxremote.ssl=false is
+ needed in the startup script.</p>
+
+ </subsection>
+
+ <subsection name="sqlResources.xml">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/sqlResources.xml">sqlResources.xml</a> in SVN to get some examples and hints.</p>
+
+ <p>This file is deprecated but some mailets... still need it. The standard way to access database
+ is JPA, but some functionalities are not yet migrated and still need the sqlResources.xml resources.</p>
+
+ <p>The precise SQL statements used by Apache James Server to modify and view data stored in the database
+ are specified in sqlResources.xml file.</p>
+
+ <p>If you are using a SQL database with unusual SQL commands or data types, you may
+ need to add special entries to this file. The James team
+ does try to keep sqlResources.xml updated, so if you do run into a
+ special case, please let us know.</p>
+
+ <p>Also, if the database tables are not created a priori, but rather are to be created by James
+ upon startup, special attention should be paid to the "create table" statements in this file. Such
+ statements tend to be both very database and very database instance specific.</p>
+
+ </subsection>
+
+ <subsection name="JCR Repository Configuration">
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/jcr-repository-template.xml">jcr-repository.xml</a> in SVN to get some examples and hints.</p>
+
+ <p>Used to configure the JCR mailbox (if configure in mailbox.xml).</p>
+
+ </subsection>
+
+ </section>
+
+</body>
+
+</document>
+
Propchange: james/site-cms/trunk/content/xdoc/config-system.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/config-users.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config-users.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config-users.xml (added)
+++ james/site-cms/trunk/content/xdoc/config-users.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,238 @@
+<?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>Apache James Server 3 - Users Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="Users Repositories">
+
+ <subsection name="Introduction">
+
+ <p>User repositories are required to store James user information and authentication data</p>
+
+ <p>Consult <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/usersrepository-template.conf">usersrepository.conf</a> in SVN to get some examples and hints.</p>
+
+ </subsection>
+
+ <subsection name="JPA Users Repository">
+
+ <p>JPA (database via OpenJPA) based user repository. This is the default implementation.</p>
+
+ <p>The usersrepository tag as 2 attributes: name="LocalUsers" and class="org.apache.james.user.file.UsersFileRepository"></p>
+
+ <dl>
+ <dt><strong>algorithm</strong></dt>
+ <dd>Algorithm to has passwords. Supported password algorithm are: MD5, SHA-256, SHA-512, NONE</dd>
+ <dt><strong>enableVirtualHosting</strong></dt>
+ <dd>true (default) or false. Defines if the usernames must (true) or may not contain (false) a domain part (user@domain.tld).</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="File Users Repository">
+
+ <p>The File UsersRepository implementations below are DEPRECATED and will get removed in the next release</p>
+ <p>It just listed here for backward-compatibility</p>
+
+ <p>File-based user repositories Use these configurations to store user info in the filesystem.</p>
+
+ <p>The usersrepository tag as 2 attributes:name="LocalUsers" class="org.apache.james.user.file.UsersFileRepository"></p>
+
+ <dl>
+ <dt><strong>destination</strong></dt>
+ <dd>Example: file://var/users/.</dd>
+ <dt><strong>ignoreCase</strong></dt>
+ <dd>true or false.</dd>
+ <dt><strong>enableAliases</strong></dt>
+ <dd>true or false.</dd>
+ <dt><strong>enableForwarding</strong></dt>
+ <dd>true or false.</dd>
+ <dt><strong>enableVirtualHosting</strong></dt>
+ <dd>true (default) or false. Defines if the usernames must (true) or may not contain (false) a domain part (user@domain.tld).</dd>
+ </dl>
+
+ </subsection>
+
+ <subsection name="JDBC Users Repository">
+
+ <p>The JDBC UsersRepository implementations below are DEPRECATED and will get removed in the next release.</p>
+ <p>It just listed here for backward-compatibility.</p>
+
+ </subsection>
+
+ <subsection name="LDAP Users Repository">
+
+ <p>Read-Only LDAP based UsersRepository</p>
+
+ <p>Example:</p>
+
+ <source>
+<repository name="LocalUsers" class="org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository" ldapHost="ldap://myldapserver:389"
+ principal="uid=ldapUser,ou=system" credentials="password" userBase="ou=People,o=myorg.com,ou=system" userIdAttribute="uid"/></source>
+
+<!--
+ <p>This section explains how to enable Apache James Server to use an LDAP directory as a
+ Users Repository.</p>
+
+ <p>We have tried to make the LDAP implementation of UsersRepository as
+ flexible a possible, recognising that each installation will have a unique
+ directory schema.</p>
+
+ <p>We assume that all users that a James Mailserver will handle fall
+ within one single-rooted tree. The root of this tree, ie the lowest node
+ in the directory which is an ancestor for all users served by this
+ mailserver and the mailserver, is called the LDAPRoot. (See diagram)</p>
+
+ <p>It is entirely possible that an organization may have more than one
+ mail server. Consequently, the fact that a user is in the Directory does
+ not imply that this mailserver should handle mail for them.</p>
+
+ <p>This implementation of UsersRepository creates one node (object) for
+ each set of mail users. The set called 'LocalUsers' is the set of users
+ whose mail is handled by this server. Other sets include any mail-lists
+ handled by the server. Each member of a set is recorded as an attribute
+ of these objects. These nodes are child nodes of the mailserver.</p>
+
+ <p>The mailserver will accept mail for local delivery if the user part of
+ the email address matches a member of LocalUsers and if the domain/host
+ part of the email address matches the first servername .
+ (Set servernames autodetect to false and enter the domain served as the
+ first servername, e.g. apache.org).</p>
+
+ <p>For POP3 authentication, the mailserver first finds the user entry in
+ the directory, underLDAPRoot, whose attribute, specified as
+ MailAttribute in conf, matches user@domain. The mailserver authenticates
+ the POP3 user if it can bind to the directory as that user entry with
+ the offered password.</p>
+
+ <p>This implementation does not set passwords in the directory. Use a dummy
+ password when invoking adduser in RemoteManger.</p>
+
+ <p>If ManageGroupAttribute is set to TRUE (as it is by default), then the
+ RemoteManger will add/remove the full DN of the email group to/from the
+ user entry. This facilty allows users to ask the directory what is my
+ mailserver and what email lists am I subscribed to?</p>
+
+ <table cellspacing="0">
+ <tr>
+ <td> </td>
+ <td align="center">Root of Directory
+ <br>Example: dc=org</br>
+ <br>May not be referenced in conf.xml</br>
+ <br>|</br>
+ <br>|</br>
+ </td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td colspan="3" align="center"> - - - - - - - - - - -</td>
+ </tr>
+ <tr>
+ <td align="center" valign="top">|
+ <br>Subtree not served by James</br>
+ <br> e.g.: dc=w3c, dc=org</br>
+ </td>
+ <td align="center" valign="top">|
+ <br>Subtree served by James</br>
+ <br> e.g.: dc=apache, dc=org </br>
+ <br>"LDAPRoot"</br>
+ <br>|</br>
+ </td>
+ <td align="center" valign="top">|
+ <br>Subtree not served by James</br>
+ <br> e.g.: dc=xml, dc=org</br>
+ </td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td>
+ <table cellspace="0">
+ <tr>
+ <td colspan="4" align="center"> - - - - - - - - - - - - - - - - - - - - - - - - - -</td>
+ </tr>
+ <tr>
+ <td align="center" valign="top">|
+ <br>This mailserver </br>
+ <br>cn=mailserver.apache.org</br>
+ <br>|</br>
+ <br> - - - - - - - -</br>
+ </td>
+ <td align="center" valign="top">|
+ <br>A user </br>
+ <br>cn=King Arthur</br>
+ <br> memberOfGroup=</br>
+ <br>cn=LocalUsers etc</br>
+ </td>
+ <td align="center" valign="top">|
+ <br>A user </br>
+ <br>cn=Morgan LeFay </br>
+ </td>
+ <td align="center" valign="top">|
+ <br>Another mailserver </br>
+ <br>cn=oldmail.apache.org</br>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <table cellspace="0">
+ <tr>
+ <td align="center" valign="top"> |
+ <br>LocalUsers</br>
+ <br>member=Arthur</br>
+ </td>
+ <td align="center" valign="top"> |
+ <br>list-james</br>
+ <br>member=Arthur</br>
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td> </td>
+ <td> </td>
+ <td> </td>
+ </tr>
+ </table>
+ </td>
+ <td> </td>
+ </tr>
+ </table>
+-->
+<!--
+ <p>Six entries in JAMES.conf.xml must be set for this to work:
+ <ul>
+ <li>change usersManager - type to ldap.</li>
+ <li>Set the ldapServer element to point to the correct host and port</li>
+ <li>Set LDAPRoot and ThsServerRDN.</li>
+ <li>Set the direcory FDN and password that should be used to write to the directory.</li>
+ <li>Unless all your users have email addresses of the form, name@the-machine-running-James, set servernames-autodetect to false and apecify the your email domain as the first servername.</li>
+ </ul>
+ </p>
+-->
+ </subsection>
+
+ </section>
+
+</body>
+
+</document>
Propchange: james/site-cms/trunk/content/xdoc/config-users.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/config.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/config.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/config.xml (added)
+++ james/site-cms/trunk/content/xdoc/config.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,183 @@
+<?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>Apache James Server 3 - Configuration</title>
+ </properties>
+
+<body>
+
+ <section name="Configure Apache James Server">
+
+ <p>All configuration files resides in the ./conf and ./conf/META-INF folder.</p>
+
+ <p>We ship with default configuration (embedded in jars) and -template files
+ you can use to override the default configuration.</p>
+
+ <p>You can/must configure James for the following:</p>
+
+ <table>
+
+ <tr>
+ <th>Config File Sample</th>
+ <th>Config Area</th>
+ <th>Config Comment</th>
+ </tr>
+
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/domainlist-template.conf">domainlist.conf</a></td>
+ <td><a href="config-domainlist.html">Domain List Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/usersrepository-template.conf">usersrepository.conf</a></td>
+ <td><a href="config-users.html">Users Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/recipientrewritetable-template.conf">recipientrewritetable.conf</a></td>
+ <td><a href="config-recipientrewritetable.html">Recipient Rewrite Table Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/mailbox-template.conf">mailbox.conf</a></td>
+ <td><a href="config-mailbox.html">Mailbox Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/mailrepositorystore-template.conf">mailrepositorystore.conf</a></td>
+ <td><a href="config-mailrepositorystore.html">Mail Repository Stores Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/dnsservice-template.conf">dnsservice.conf</a></td>
+ <td><a href="config-dnsservice.html">DNS Service Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/smtpserver-template.conf">smtpserver.conf</a></td>
+ <td><a href="config-smtp-lmtp.html">SMTP Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/lmtpserver-template.conf">lmtpserver.conf</a></td>
+ <td><a href="config-smtp-lmtp.html">LMTP Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/pop3server-template.conf">pop3server.conf</a></td>
+ <td><a href="config-pop3.html">POP3 Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/imapserver-template.conf">imapserver.conf</a></td>
+ <td><a href="config-imap4.html">IMAP4 Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/mailetcontainer-template.conf">mailetcontainer.conf</a></td>
+ <td><a href="config-mailetcontainer.html">Mailet Container Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/fetchmail-template.conf">fetchmail.conf</a></td>
+ <td><a href="config-fetchmail.html">FetchMail Configuration</a></td>
+ <td></td>
+ </tr>
+<!--
+Removed from trunk for now.
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/james-listmanager.xml">james-listmanager.xml</a></td>
+ <td><a href="config-listmanager.html">List Manager Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/miResources.xml">miResources.xml</a></td>
+ <td>SQL Resources for Mailing lists</td>
+ <td></td>
+ </tr>
+-->
+
+ </table>
+
+ <p>For most advanced system configuration, you can configure James for the following:</p>
+
+ <table>
+
+ <tr>
+ <th>System Config File Sample</th>
+ <th>System Config Area</th>
+ <th>System Config Comment</th>
+ </tr>
+
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/META-INF/org/apache/james/spring-server.xml">spring-server.xml</a></td>
+ <td><a href="config-system.html">System Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/james-database-template.properties">james-database.properties</a></td>
+ <td><a href="config-system.html">System Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/META-INF/persistence-template.xml">META-INF/persistence.xml</a></td>
+ <td><a href="config-system.html">System Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>
+ <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/jmx-template.properties">jmx.properties</a><br/>
+<!--
+ <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/jmx.access">jmx.access</a><br/>
+ <a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/jmx.password">jmx.password</a><br/>
+-->
+ </td>
+ <td><a href="config-system.html">System Configuration</a></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/log4j-template.properties">log4j.properties</a></td>
+ <td>See <a href="monitor-logging.html">monitoring with log4j</a> section.</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/sqlResources-template.xml">sqlResources.xml</a></td>
+ <td><a href="config-system.html">System Configuration</a></td>
+ <td>Deprecated</td>
+ </tr>
+ <tr>
+ <td><a href="https://svn.apache.org/repos/asf/james/app/tags/apache-james-3.0-beta4/src/main/resources/jcr-repository-template.xml">jcr-repository.xml</a></td>
+ <td><a href="config-system.html">System Configuration</a></td>
+ <td></td>
+ </tr>
+
+ </table>
+
+ <p>See also more specific configurations related to <a href="config-tls.html">TLS</a>,
+ <a href="config-sieve.html">Sieve</a> and
+ <a href="config-antispam.html">Antispam</a>.</p>
+
+ </section>
+
+</body>
+
+</document>
Propchange: james/site-cms/trunk/content/xdoc/config.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/dev-build.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/dev-build.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/dev-build.xml (added)
+++ james/site-cms/trunk/content/xdoc/dev-build.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,225 @@
+<?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>Apache James Server 3 - Build Apache James from Source</title>
+</properties>
+
+<body>
+
+ <section name="Why Build from Source?">
+
+ <p>This step is not necessary to use the standard out of the box version of James. A
+ pre-built binary version of James is available from the James download directory.</p>
+
+ <p>But if you wish to customize the James source code, it will be necessary for you to
+ build the distribution yourself.</p>
+
+ <p>You can read on this page how to build from the command line and from eclipse IDE.</p>
+
+ </section>
+
+ <section name="Get Source Code">
+
+ <p>There are two ways to get the James source code.</p>
+
+ <ol>
+ <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>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
+ can be found <a href="http://www.apache.org/dev/version-control.html">here</a>.
+ Apache James Server beta1 repository is <a href="http://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-beta1/">http://svn.apache.org/repos/asf/james/server/tags/james-server-3.0-beta1/</a>.</li>
+ <li>For information, you can download all Apache James sources (server, mailbox, imap, mailet...) if you check out <a href="http://svn.apache.org/repos/asf/james/current">http://svn.apache.org/repos/asf/james/current/</a>.
+ Watch out!: you will get a release, but what we call a "trunk", that is on constant development and debugging.</li>
+ </ol>
+
+ <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="dev.html">architecture</a> page if you want to learn
+ more on the internal source structure.</p>
+
+ </section>
+
+ <section name="Required Tools">
+
+ <p>To run the build you need two third-party tools.</p>
+ <ol>
+ <li>Java Development Kit - You must have a JDK of Java version 1.6 or higher installed to build the
+ James distribution. The exact JDKs available depend on the platform. A JDK must be downloaded and
+ installed before the build can run.</li>
+ <li>Maven 3.0.2 - This is a Java-tailored, XML-configured, extensible build or make system. You need ant (3.0.2+) in order
+ to build James. You can get maven 3.0.2 from <a href="http://maven.apache.org/download.html">here</a>.
+ Installation instructions for maven are also available on the same page <a href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>.</li>
+ </ol>
+ <p>Set (on windows) or export (on Unix) MAVEN_OPTS to tune the memory needed by maven with "MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128m"</p>
+
+ </section>
+
+ <section name="Build James Source from Command Line">
+
+ <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>
+ <li>test - run unit tests for James.</li>
+ <li><b>package - generates all the James distributions, packed. From the root directory, cd to 'container-spring/target' to have the build distribution.</b></li>
+ <li>javadocs:javadocs - builds the James javadocs.</li>
+ <li>site - builds the entirety of the James website.</li>
+ </ul>
+ </p>
+ <p>For example, invoke <code>mvn package</code> to get a zip/tar of James distribution.</p>
+ <p>All built products are output in the <code>container-spring/target</code>
+ 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
+ will be lost after a recompilation. If you are running James for this directory
+ we recommend you backup to avoid losing work. </p>
+ <p>You can also invoke the command line from a shell. Go to the server project cli folder and type mvn exec:java -Dexec.args="-h localhost -p 9999 help"</p>
+
+ </section>
+
+ <section name="Build James Source from Eclipse">
+
+ <subsection name="Import projects in Eclipse with m2eclipse">
+
+ <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 <code>File</code> menu and select <code>Import</code>.
+ Choose <code>Existing Maven Project</code> and click on <code>Next</code> button.</p>
+ <img src="./images/eclipse/eclipse-import-maven-view-1.gif"/>
+
+ </subsection>
+
+ <subsection name="Select Projects to Import">
+
+ <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 <code>Finish</code>
+ to execute the import.</p>
+
+ <img src="./images/eclipse/eclipse-import-maven-view-2.gif"/>
+
+ <p>You can also import other projects from
+ <a href="http://james.apache.org/imap/source-code.html">imap</a>,
+ <a href="http://james.apache.org/mailbox/source-code.html">mailbox</a>
+ and <a href="http://james.apache.org/protocols/source-code.html">protocols</a> to have a
+ more complete view on the used sources code.</p>
+
+ </subsection>
+
+ <subsection name="Enable Workspace Resolution">
+
+ <p>Check that 'Workspace resolution' is enable in m2eclipse plugin.</p>
+ <p>Your changes in code will be directly taken into account.</p>
+ <img src="./images/eclipse/eclipse-m2eclipse-project-dependencies.gif"/>
+
+ </subsection>
+
+ <subsection name="Prepare projects">
+
+ <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 <code>context</code> folder, <code>log4j.properties</code>
+ and <code>META-INF</code> folder from <code>container-spring\src\main\config\james</code>
+ directory to a source folder of <code>container-spring</code> project (you can use for example a
+ new folder called <code>stage</code> as Eclipse source folder).</li>
+ <li>Copy all files (except context folder log4j.properties and META-INF/persistence.xml)
+ from <code>container-spring\src\main\config\james</code> folder to a <code>conf</code> folder
+ (<code>conf</code> folder must be a sub-folder of the JAMES_SRC_HOME directory where you made the check-out).
+ As non-root privilege user, you may need to change the SMTP/IMAP/POP3 ports to values higher than 1024.</li>
+ <li>For ease, you can also create 2 new eclipse projects to edit the files and visualize the created mails/store/...:
+ james-server-container-spring-conf and james-server-container-spring-var.</li>
+ </ol>
+ <img src="./images/eclipse/eclipse-m2eclipse-projects.gif"/>
+
+ </subsection>
+
+ <subsection name="Run James from Eclipse">
+
+ <p>That's it. Run or Debug James in Eclipse (right-click on the Main class) and Have Fun!.</p>
+ <img src="./images/eclipse/eclipse-run-james.gif"/>
+
+ <p>If you change a JPA Entity class, your will need to run 'mvn package'
+ or add the following option to the VM argument of your run configuration
+ '-javaagent:my_home_folder/.m2/repository/org/apache/openjpa/openjpa/2.0.1/openjpa-2.0.1.jar'
+ </p>
+
+ </subsection>
+
+ </section>
+
+ <section name="Build James from NetBeans">
+
+ <p>This was done using NetBeans 7, which comes bundeled with Maven 3, needed to build James 3.
+ Older versions of NetBeans should be able to build James fine, provided that you configure them to use an instance of Maven 3, if they do not have it.
+ I used james 3.0-beta1 release and it builded in 7:40 min on my notebook running Debian Squeeze.
+ </p>
+
+ <subsection name="Getting the sources from the repository">
+ <p>Building James with NetBeans is very easy as it comes with Subersion and Maven support already build in.
+ Maven is bundeled with the IDE, but Subverion is not, so you will have to install Subversion yourself and NetBeans will be able to use it.
+ You can get more details on how to install and where to get Subversion from the NetBeans Help menu by clicking on <strong>Help Contents</strong> and from there go to the <strong>IDE Basics->Version Control and File Hierarchy->Subversion</strong> topic.
+ </p>
+ <p>For Linux users, Subversion is probably packaged by your distribution so use your distribution tools to install it (aptitude, yum, etc.)</p>
+ <p>Once you have Subversion, go to <strong>Team->Subversion->Checkout</strong> menu entry. <br/>
+ You will see an dialog window used to enter the information about the Subversion repository you are going to use. It looks like this:
+ <img src="./images/netbeans/netbeans-svn-checkout1.png"/>. <br/>
+ In the <code>Repository URL</code> field enter the location for James repository and click <code>Next</code>.
+ You can use the following URL to get the trunk or developement version:
+ <a href="http://svn.apache.org/repos/asf/james/server/trunk">http://svn.apache.org/repos/asf/james/server/trunk</a>.<br/>
+ After this you will be presented with another dialog window where you can configure which folders to check out and where to save them on your machine.
+ <img src="./images/netbeans/netbeans-svn-checkout2.png"/>. <br/>
+ If you supplied the above URL you can click <code>Finish</code> to get trunk version and start hacking.
+ You can choose another folder by clicking <code>Browse</code>. A new dialog window will open and from there you cand browse
+ the whole subversion repository. I wanted to build James 3.0beta so I choosed <code>james-serve-3.0-beta1</code> under james/server/tags/ folder.
+ <img src="./images/netbeans/netbeans-svn-checkout-browse.png"/>. <br/>
+ </p>
+ <p>After you click <code>Finish</code> NetBeans will checkout the sources. It will detect the Maven project and ask you if you wish to open the project.
+ If you open the project you will see in the Projects Window (<code>CTRL+1</code> if not visible) something similar to the next image:<br/>
+ <img src="./images/netbeans/netbeans-james-project.png"/>.
+ </p>
+
+ </subsection>
+
+ <subsection name="Building the project">
+ <p> Building the project does not require too much work. Just go to <code>Run->Build Project</code> menu option.
+ Make sure that James is the main project (if you have other projects open) or NetBeans will build that project instead of James.
+ Once the build is finished you will find the binary distribution in <code>container-spring/target</code> directory.
+ <img src="./images/netbeans/james-build-dir.png"/>. <br/>
+ </p>
+ </subsection>
+
+ </section>
+
+ <section name="Build James Source from other IDEs">
+
+ <p>We will be happy to include on this page any other tutorial you could send
+ use about developing James with your favorite Integrated Development Environment.</p>
+
+ </section>
+
+</body>
+
+</document>
Propchange: james/site-cms/trunk/content/xdoc/dev-build.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/dev-database-schema.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/dev-database-schema.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/dev-database-schema.xml (added)
+++ james/site-cms/trunk/content/xdoc/dev-database-schema.xml Mon May 14 08:45:02 2012
@@ -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>Apache James Server 3 - Dev - Database Schema</title>
+ </properties>
+
+<body>
+
+ <section name="Database Schema">
+
+ <img src="images/database/james-database-schema-derby_1000.png"/>
+
+ <p>The users is in the JAMESUSER table.</p>
+
+ <p>Depending on your virtualHosting config, JAMESUSER.NAME is the email
+ address (or the user part that must be completed with a domain).</p>
+
+ <p>The user has MAILBOXes via the SUBSCRIPTION table.</p>
+
+ <p>The email are in MESSAGE (belonging to a MAILBOX via MEMBERSHIP).
+ You have to look in the HEADER table to get all the detailed
+ information (from, to, cc, bcc,...).
+ </p>
+
+ </section>
+
+</body>
+
+</document>
Propchange: james/site-cms/trunk/content/xdoc/dev-database-schema.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
Added: james/site-cms/trunk/content/xdoc/dev-extend-mailet.xml
URL: http://svn.apache.org/viewvc/james/site-cms/trunk/content/xdoc/dev-extend-mailet.xml?rev=1338063&view=auto
==============================================================================
--- james/site-cms/trunk/content/xdoc/dev-extend-mailet.xml (added)
+++ james/site-cms/trunk/content/xdoc/dev-extend-mailet.xml Mon May 14 08:45:02 2012
@@ -0,0 +1,171 @@
+<?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>Apache James Server 3 - Writing a Custom Mailet</title>
+ </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
+as part of the Mailet package.</p>
+<p>In this discussion we will assume that any mailet being implemented is a subclass of
+GenericMailet. The GenericMailet class serves to abstract away of the configuration and
+logging details. While it provides a noop implementation of the init() and destroy() methods,
+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="config-mailetcontainer.html">SpoolManager configuration
+section</a>, mailets are configured with a set of String (name, value) pairs. These values are
+passed into the Mailet upon initialization (although the details of this process are hidden by
+the GenericMailet implementation). GenericMailet provides access to this configuration
+information through use of the getInitParameter(String) method. Passing in the name of the
+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.
+Logging is done by calling one of the two logging methods on GenericMailet - log(String)
+or log(String,Throwable). Logging is available inside the init(), destroy(), and service(Mail)
+methods.</p>
+<p>The value of getMailetInfo() for the Mailet is prepended to the log entries for that
+Mailet. So it may be desirable for you to override this method so you can distinguish mailet
+log entries by Mailet.</p>
+<p>Alternatively, you can instanciate your own logger and log with different level, as show in the
+following snippet (don't forget to update the log4j.properties so you log are taken into account).</p>
+<code>
+package com.test;
+
+import javax.mail.MessagingException;
+
+import org.apache.mailet.Mail;
+import org.apache.mailet.base.GenericMailet;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class MyMailet extends GenericMailet{
+ private static final Logger logger = LoggerFactory.getLogger(MyMailet.class);
+ @Override
+ public void service(Mail mail) throws MessagingException {
+ log("log via mailet logger with INFO level");
+ logger.info("Log via slf4j with INFO level !!! Add log4j.logger.com.test=INFO, CONS, FILE in the log4j.properties");
+ logger.debug("Log via slf4j with DEBUG level !!! Add log4j.logger.com.test=DEBUG, CONS, FILE in the log4j.properties");
+ }
+}
+</code>
+</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
+Initialization phase is where configuration parsing and per-Mailet resource creation generally
+take place. Depending on your Mailet, it may or may not be necessary to do any initialization
+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
+passed in as an instance of the Mail interface, which is part of the Mailet API.</p>
+<p>The Mail interface is essentially a light wrapper around JavaMail's MimeMessage class with a
+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
+Destruction phase is where per-Mailet resource release generally takes place. Depending
+on your Mailet, it may or may not be necessary to do any destruction
+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
+additional steps necessary to actually deploy the Mailet.</p>
+<subsection name="Adding Your Mailet to the Classpath">
+<p>
+The Mailet must be added to James' classpath so that the Mailet can be loaded by James. There
+are three ways to add a custom Mailet to the classpath so that James will be able to load the
+Mailet. These are:
+</p>
+<p>
+1a. Download the source distribution, add a jar file containing the custom files to the lib
+directory of the unpacked source distribution, and build a new .sar file by following the
+directions <a href="build-instructions.html">here</a>. This new .sar file will now
+include your custom classes.
+</p>
+<p>
+or
+</p>
+<p>
+1b. Place a jar file containing the custom class files in the lib subdirectory of the James
+installation. It will also be necessary to unpack the JavaMail and James jar files from
+the provided .sar file and add them to this directory.
+</p>
+<p>
+or
+</p>
+<p>
+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 mailetcontainer.xml. For example:
+<p>
+<source>
+<!-- Set the Java packages from which to load mailets and matchers -->
+<mailetpackages>
+ <mailetpackage>org.apache.james.transport.mailets</mailetpackage>
+ <mailetpackage>org.apache.james.transport.mailets.smime</mailetpackage>
+ <mailetpackage>your.costum.package.transport-mailets</mailetpackage>
+</mailetpackages>
+</source>
+</p>
+After that restart james.
+</p>
+</subsection>
+
+<subsection name="James Configuration">
+<p>Configuration of the processor chain is discussed
+<a href="config-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="dev-provided-mailets.html">here</a>.
+</p>
+</subsection>
+
+</section>
+
+</body>
+</document>
Propchange: james/site-cms/trunk/content/xdoc/dev-extend-mailet.xml
------------------------------------------------------------------------------
svn:keywords = Id Author Revision HeadURL
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org