You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by er...@apache.org on 2010/11/09 08:47:24 UTC
svn commit: r1032880 - in /james/server/trunk/src/site: ./ xdoc/
Author: eric
Date: Tue Nov 9 07:47:24 2010
New Revision: 1032880
URL: http://svn.apache.org/viewvc?rev=1032880&view=rev
Log:
Clearly distinguish extensions dev and provided extensions - Update on quick start.
Added:
james/server/trunk/src/site/xdoc/dev-extend-mailet.xml
- copied unchanged from r1032463, james/server/trunk/src/site/xdoc/dev-extend-custom-mailet.xml
james/server/trunk/src/site/xdoc/dev-extend-matcher.xml
- copied unchanged from r1032463, james/server/trunk/src/site/xdoc/dev-extend-custom-matcher.xml
james/server/trunk/src/site/xdoc/dev-extend-smtp-hook.xml
- copied, changed from r1032463, james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml
james/server/trunk/src/site/xdoc/dev-provided-smtp-hooks.xml
james/server/trunk/src/site/xdoc/dev-provided.xml
Removed:
james/server/trunk/src/site/xdoc/dev-extend-custom-mailet.xml
james/server/trunk/src/site/xdoc/dev-extend-custom-matcher.xml
james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml
Modified:
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/dev-extend.xml
james/server/trunk/src/site/xdoc/feature-queue-priority.xml
james/server/trunk/src/site/xdoc/quick-start.xml
Modified: james/server/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1032880&r1=1032879&r2=1032880&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Tue Nov 9 07:47:24 2010
@@ -88,12 +88,15 @@
<menu name="Developers Corner">
<item name="Architecture" href="/dev.html" />
<item name="Build from source" href="/dev-build.html" />
- <item name="Provided Mailets" href="/dev-provided-mailets.html" />
- <item name="Provided Matchers" href="/dev-provided-matchers.html" />
- <item name="Extend James" href="/dev-extend.html" collapse="true" >
- <item name="Custom Mailet" href="/dev-extend-custom-mailet.html" />
- <item name="Custom Matcher" href="/dev-extend-custom-matcher.html" />
- <item name="Hook SMTP" href="/dev-extend-hook-smtp.html" />
+ <item name="Develop Extensions" href="/dev-extend.html" collapse="true" >
+ <item name="Mailet" href="/dev-extend-mailet.html" />
+ <item name="Matcher" href="/dev-extend-matcher.html" />
+ <item name="Hook SMTP" href="/dev-extend-smtp-hook.html" />
+ </item>
+ <item name="Provided Extensions" href="/dev-provided.html" collapse="true" >
+ <item name="Mailets" href="/dev-provided-mailets.html" />
+ <item name="Matchers" href="/dev-provided-matchers.html" />
+ <item name="SMTP Hooks" href="/dev-provided-smtp-hooks.html" />
</item>
<item name="Javadoc" href="/apidocs/index.html" />
</menu>
Copied: james/server/trunk/src/site/xdoc/dev-extend-smtp-hook.xml (from r1032463, james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml)
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev-extend-smtp-hook.xml?p2=james/server/trunk/src/site/xdoc/dev-extend-smtp-hook.xml&p1=james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml&r1=1032463&r2=1032880&rev=1032880&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml (original)
+++ james/server/trunk/src/site/xdoc/dev-extend-smtp-hook.xml Tue Nov 9 07:47:24 2010
@@ -30,6 +30,10 @@
<p>The James SMTP Server Component allows to easy write your own code which will get executed
in the SMTP-Transaction. Thats a bit different then using a Mailet a.k.a Mailet-API.</p>
+ <p>The James SMTP Server comes with a few interfaces which helps you to "hook-in" a
+ specific SMTP Command. That means your class which implements the given interface(s) will get
+ called after the SMTP-Command was parsed and depending on your implementation it will handle it.</p>
+
<p>As your code will get executed before the mail was even accepted. This can help you in many ways,
most times its used for rejecting SPAM/Junk within the SMTP-Dialog. But it can be used for
other things too.</p>
@@ -90,69 +94,6 @@
</section>
- <section name="Supported Hooks in James Server">
-
- <p>The James SMTP Server comes with a few interfaces which helps you to "hook-in" a
- specific SMTP Command. That means your class which implements the given interface(s) will get
- called after the SMTP-Command was parsed and depending on your implementation it will handle it.</p>
-
- <p>In detail the following hooks are supported:</p>
-
- <subsection name="AuthHook">
- <p>Allows to hook in your code for authenticate users for sending mail via SMTP AUTH.
- You could for example query your own database table to see if a user should be allowed to
- send mail with the given username and password.</p>
- </subsection>
-
- <subsection name="ConnectionHandler">
- <p>Allows to hook in your code on a new connection. So you could just drop it
- or do something else.</p>
- </subsection>
-
- <subsection name="HeloHook">
- <p>Allows to hook in your code in the HELO and EHLO commands.</p>
- </subsection>
-
- <subsection name="MailHook">
- <p>Allows to hook in your code in the MAIL command. Like checking the sender
- which was given with MAIL FROM: <whatever@example></p>
- </subsection>
-
- <subsection name="MailParametersHook">
- <p>Allows to hook in given parameters in the EHLO command.</p>
- </subsection>
-
- <subsection name="JamesMessageHook">
-
- <p>Allow to hook in your code after the email was received via the DATA command and
- was marked for queuing by the CLRF.CRLF sequence. This will get executed right before
- the message will actual get queued.</p>
-
- <p>IMPORTANT: If you want to do heavy processing here
- and not want to reject the method based on a criteria you are most times better of to
- use the Mailet API!</p>
-
- </subsection>
-
- <subsection name="QuitHook">
- <p>Allow to hook in your code in the QUIT command.</p>
- </subsection>
-
- <subsection name="RcptHook">
- <p>Allows to hook in your code in the RCPT command. Like implementing a custom logic to
- check if the mail for a given recipient should get accepted or rejected.</p>
- </subsection>
-
- <subsection name="UnknownCmdHook">
- <p>Allows to hook in your code on every unknown command.</p>
- </subsection>
-
- <subsection name="MailPriorityHandler">
- <p>Allows to set priority on mails for the spool queues, depending on the destination domain.</p>
- </subsection>
-
- </section>
-
</body>
</document>
Modified: james/server/trunk/src/site/xdoc/dev-extend.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev-extend.xml?rev=1032880&r1=1032879&r2=1032880&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-extend.xml (original)
+++ james/server/trunk/src/site/xdoc/dev-extend.xml Tue Nov 9 07:47:24 2010
@@ -31,28 +31,32 @@
<subsection name="Custom Mailet">
- See the <a href="dev-extend-custom-mailet.html">custom mailet</a> page for more information.
+ <p>See the <a href="dev-extend-mailet.html">mailet</a> page for more information.</p>
</subsection>
<subsection name="Custom Matcher">
- See the <a href="dev-extend-custom-mailet.html">custom matcher</a> page for more information.
+ <p>See the <a href="dev-extend-mailet.html">matcher</a> page for more information.</p>
</subsection>
<subsection name="SMTP Hook">
- See the <a href="dev-extend-hook-smtp.html">SMTP Hook</a> page for more information.
+ <p>See the <a href="dev-extend-hook-smtp.html">SMTP Hook</a> page for more information.</p>
</subsection>
<subsection name="Mailbox Store">
+ <p>See the <a href="http://james.apache.org/mailbox">mailbox</a> project for more information.</p>
+
</subsection>
<subsection name="Mailbox Listeners">
+ <p>See the <a href="http://james.apache.org/mailbox">mailbox</a> project for more information.</p>
+
</subsection>
<subsection name="Queue">
Added: james/server/trunk/src/site/xdoc/dev-provided-smtp-hooks.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev-provided-smtp-hooks.xml?rev=1032880&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-provided-smtp-hooks.xml (added)
+++ james/server/trunk/src/site/xdoc/dev-provided-smtp-hooks.xml Tue Nov 9 07:47:24 2010
@@ -0,0 +1,88 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Provided SMTP Hooks</title>
+ </properties>
+
+<body>
+
+ <section name="Provided Hooks in James Server">
+
+ <p>The following hooks are supported:</p>
+
+ <subsection name="AuthHook">
+ <p>Allows to hook in your code for authenticate users for sending mail via SMTP AUTH.
+ You could for example query your own database table to see if a user should be allowed to
+ send mail with the given username and password.</p>
+ </subsection>
+
+ <subsection name="ConnectionHandler">
+ <p>Allows to hook in your code on a new connection. So you could just drop it
+ or do something else.</p>
+ </subsection>
+
+ <subsection name="HeloHook">
+ <p>Allows to hook in your code in the HELO and EHLO commands.</p>
+ </subsection>
+
+ <subsection name="MailHook">
+ <p>Allows to hook in your code in the MAIL command. Like checking the sender
+ which was given with MAIL FROM: <whatever@example></p>
+ </subsection>
+
+ <subsection name="MailParametersHook">
+ <p>Allows to hook in given parameters in the EHLO command.</p>
+ </subsection>
+
+ <subsection name="JamesMessageHook">
+
+ <p>Allow to hook in your code after the email was received via the DATA command and
+ was marked for queuing by the CLRF.CRLF sequence. This will get executed right before
+ the message will actual get queued.</p>
+
+ <p>IMPORTANT: If you want to do heavy processing here
+ and not want to reject the method based on a criteria you are most times better of to
+ use the Mailet API!</p>
+
+ </subsection>
+
+ <subsection name="QuitHook">
+ <p>Allow to hook in your code in the QUIT command.</p>
+ </subsection>
+
+ <subsection name="RcptHook">
+ <p>Allows to hook in your code in the RCPT command. Like implementing a custom logic to
+ check if the mail for a given recipient should get accepted or rejected.</p>
+ </subsection>
+
+ <subsection name="UnknownCmdHook">
+ <p>Allows to hook in your code on every unknown command.</p>
+ </subsection>
+
+ <subsection name="MailPriorityHandler">
+ <p>Allows to set priority on mails for the spool queues, depending on the destination domain.</p>
+ </subsection>
+
+ </section>
+
+</body>
+</document>
Added: james/server/trunk/src/site/xdoc/dev-provided.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev-provided.xml?rev=1032880&view=auto
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-provided.xml (added)
+++ james/server/trunk/src/site/xdoc/dev-provided.xml Tue Nov 9 07:47:24 2010
@@ -0,0 +1,72 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+ <properties>
+ <title>James 3.0 - Extend James</title>
+ </properties>
+
+<body>
+
+<section name="James Provided Extensions">
+
+ <subsection name="Provided Mailet">
+
+ <p>See the <a href="dev-provided-mailets.html">provided mailets</a> page for more information.</p>
+
+ </subsection>
+
+ <subsection name="Provided Matcher">
+
+ <p>See the <a href="dev-provided-mailets.html">provided matchers</a> page for more information.</p>
+
+ </subsection>
+
+ <subsection name="Provided SMTP Hook">
+
+ <p>See the <a href="dev-provided-smtp-hooks.html">provided SMTP Hooks</a> page for more information.</p>
+
+ </subsection>
+
+ <subsection name="Mailbox Store">
+
+ <p>See the <a href="http://james.apache.org/mailbox">mailbox</a> project for more information.</p>
+
+ </subsection>
+
+ <subsection name="Mailbox Listeners">
+
+ <p>See the <a href="http://james.apache.org/mailbox">mailbox</a> project for more information.</p>
+
+ </subsection>
+
+ <subsection name="Queue">
+
+ </subsection>
+
+ <subsection name="Queue Listeners">
+
+ </subsection>
+
+</section>
+
+</body>
+
+</document>
Modified: james/server/trunk/src/site/xdoc/feature-queue-priority.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/feature-queue-priority.xml?rev=1032880&r1=1032879&r2=1032880&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/feature-queue-priority.xml (original)
+++ james/server/trunk/src/site/xdoc/feature-queue-priority.xml Tue Nov 9 07:47:24 2010
@@ -47,7 +47,7 @@
<p>There are two scenarios to set priority in the queue.</p>
<ul>
- <li>Write a <a href="dev-extend-hook-smtp.html">SMTP hook</a> which sets the header
+ <li>Write a <a href="dev-extend-smtp-hook.html">SMTP hook</a> which sets the header
and add the hook to smtphandler chain.</li>
<li>You could also add the header in a mailet to let remotedelivery
pick it up again on redelivery.</li>
Modified: james/server/trunk/src/site/xdoc/quick-start.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/quick-start.xml?rev=1032880&r1=1032879&r2=1032880&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/quick-start.xml (original)
+++ james/server/trunk/src/site/xdoc/quick-start.xml Tue Nov 9 07:47:24 2010
@@ -34,21 +34,21 @@
Step 0: Requirements
####################
-JRE 1.5+
-root (linux/unix) or Administrator (Windows)
-libc6 (linux)
-512MB RAM
+ * JRE 1.5+
+ * root (linux/unix) or Administrator (Windows)
+ * libc6 (linux)
+ * 512MB RAM
Step 1: Download
#################
-Download james-server-container-spring-3.0-M2-bin.zip from http://james.apache.org/download.cgi#Apache_James_Server
+ * Download james-server-container-spring-3.0-M2-bin.zip from http://james.apache.org/download.cgi#Apache_James_Server
Step 2: Deploy
##############
-Unzip james-server-container-spring-3.0-M2-bin.zip.
-You should have a folder with sub-folders bin, conf, lib, log, var and four text files.
+ * Unzip james-server-container-spring-3.0-M2-bin.zip.
+ * You should have a folder with sub-folders bin, conf, lib, log, var and four text files.
$ unzip james-server-container-spring-3.0-M2-bin.tar.gz
$ cd james-server-container-spring-3.0-M2
@@ -67,7 +67,7 @@ drwxrwxrwx. 6 root root 4096 2010-11-06
Step 3: Configure
#################
-All configuration files reside in the conf folder.
+ * All configuration files reside in the conf folder.
$ cd conf
$ ls -l
@@ -125,8 +125,11 @@ Step 4: Start
#############
$ cd bin
-$ ./james start (!! you need libc6 installed on Linux - sudo apt-get install libc6-i386 libc6-dev-i386 on ubuntu)
-You can see log result in the log/james-server.log file.
+$ ./james start
+
+ * !! you need libc6 installed on Linux - sudo apt-get install libc6-i386 libc6-dev-i386 on ubuntu
+
+ * You can see log result in the log/james-server.log file.
Step 5: Create Domains and Users
################################
@@ -150,8 +153,8 @@ quit
Bye
Connection closed by foreign host.
-For example, YOUR_DOMAIN=localhost.net, YOUR_NAME=test, so you will have a test@localhost.net user.
-The username to use in you mail client will be test@localhost.net.
+ * For example, YOUR_DOMAIN=localhost.net, YOUR_NAME=test, so you will have a test@localhost.net user.
+ * The username to use in you mail client will be test@localhost.net.
Step 6: Test
############
@@ -184,6 +187,7 @@ Step 7: Manage
##############
7.1. Manage via telnet
+
$ telnet localhost 4555
Trying 127.0.0.1...
Connected to localhost.
@@ -220,13 +224,15 @@ user [repositoryname] change to anothe
verify [username] verify if specified user exist
7.2. Manage via JMX
-Launch jconsole (or any other JMX client) and connect on URL=service:jmx:rmi:///jndi/rmi://localhost:9999/jmxrmi
+
+ * Launch jconsole (or any other JMX client) and connect on URL=service:jmx:rmi:///jndi/rmi://localhost:9999/jmxrmi
Step 8: Monitor
##############
-Monitor the ./log/james-server.log log file.
-Monitor via JMX (launch any JMX client and connect to URL=service:jmx:rmi:///jndi/rmi://localhost:9999/jmxrmi)
+ * Monitor the ./log/james-server.log log file.
+
+ * Monitor via JMX (launch any JMX client and connect to URL=service:jmx:rmi:///jndi/rmi://localhost:9999/jmxrmi)
</source>
<p>Time to fine-tune your James Server!</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org