Author: eric
Date: Sat Nov 6 16:04:57 2010
New Revision: 1032106
URL: http://svn.apache.org/viewvc?rev=1032106&view=rev
Log:
Miscellaneous format and naming typos/enhancements + MailPriorityHandler
Added:
james/server/trunk/src/site/xdoc/dev-extend-custom-mailet.xml
- copied unchanged from r1031965,
james/server/trunk/src/site/xdoc/dev-custom-mailet.xml
james/server/trunk/src/site/xdoc/dev-extend-custom-matcher.xml
- copied unchanged from r1031965,
james/server/trunk/src/site/xdoc/dev-custom-matcher.xml
Removed:
james/server/trunk/src/site/xdoc/dev-custom-mailet.xml
james/server/trunk/src/site/xdoc/dev-custom-matcher.xml
Modified:
james/server/trunk/src/site/site.xml
james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml
james/server/trunk/src/site/xdoc/dev-extend.xml
james/server/trunk/src/site/xdoc/feature-stores.xml
Modified: james/server/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/site.xml?rev=1032106&r1=1032105&r2=1032106&view=diff
==============================================================================
--- james/server/trunk/src/site/site.xml (original)
+++ james/server/trunk/src/site/site.xml Sat Nov 6 16:04:57 2010
@@ -90,8 +90,8 @@
<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-custom-mailet.html" />
- <item name="Custom Matcher" href="/dev-custom-matcher.html" />
+ <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>
<item name="Javadoc" href="/apidocs/index.html" />
Modified: 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-hook-smtp.xml?rev=1032106&r1=1032105&r2=1032106&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml (original)
+++ james/server/trunk/src/site/xdoc/dev-extend-hook-smtp.xml Sat Nov 6
16:04:57 2010
@@ -20,7 +20,7 @@
<document>
<properties>
- <title>James Protocols - SMTP Hooks</title>
+ <title>James - SMTP Hooks</title>
</properties>
<body>
@@ -43,6 +43,53 @@
</section>
+ <section name="Custom Hooks Implementations">
+
+ <subsection name="Why a Custom Hook">
+
+ <p>What to do if the Hook API is not enough for you ? You want for
example
+ to write a code which handles a new command like "YOURCOOLCOMMAND:
whate...@example".</p>
+
+ <p>For this kind of needs you should implement the CommandHandler
interface.
+ This gives you a lower-level API to handle this kind of tasks. If you
want
+ to support a custom Hook in your CommandHandler its the best
+ to just extend AbstractHookableCmdHandler.</p>
+
+ </subsection>
+
+ <subsection name="Things to Remember ">
+
+ <p>Be aware that your implementation needs to be thread-safe as it will
get used as singleton.
+ If you need to store temporary informations within the SMTP
Transaction/Session you should
+ use the SMTPSession.getState().put(...) and
SMTPSession.getConnectionState().put(...) methods.</p>
+
+ <p>For a more explanation see the <a
href="http://james.apache.org/protocols/apidocs/index.html";>apidocs</a> for the
protocols library which
+ is used by James SMTP Server.</p>
+
+ </subsection>
+
+ <subsection name="Get your Hook implementations loaded">
+
+ <p>Just create a jar file which contains your code and put it in
/path/to/james/conf/lib/
+ folder. The jar will get picked up by the ClassLoader automatic then.</p>
+
+ <p>After that open the smtpserver.xml file and add your hook to the
<code><handlers></handlers></code> block in the order you
+ want to have it executed. So if you have 2 MailHook implementation make
sure the first one
+ which is listed in smtpserver.xml is the one you want to call first.</p>
+
+ </subsection>
+
+ <subsection name="Return-Codes">
+
+ <p>Each of the Hooks need to return a HookResult to tell the SMTPServer
+ if the next registered Hook should get called or not.</p>
+
+ <p>For this the HookReturnCode is used.</p>
+
+ </subsection>
+
+ </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
@@ -100,55 +147,12 @@
<p>Allows to hook in your code on every unknown command.</p>
</subsection>
- </section>
-
- <section name="Return-Codes">
-
- <p>Each of the above mention Hooks need to return a HookResult to tell the
SMTPServer
- if the next registered Hook should get called or not.</p>
-
- <p>For this the HookReturnCode is used.</p>
-
- </section>
-
- <section name="Custom Hooks Implementations">
-
- <subsection name="Why a Custom Hook">
-
- <p>What to do if the Hook API is not enough for you ? You want for
example
- to write a code which handles a new command like "YOURCOOLCOMMAND:
whate...@example".</p>
-
- <p>For this kind of needs you should implement the CommandHandler
interface.
- This gives you a lower-level API to handle this kind of tasks. If you
want
- to support a custom Hook in your CommandHandler its the best
- to just extend AbstractHookableCmdHandler.</p>
-
- </subsection>
-
- <subsection name="Things to Remember ">
-
- <p>Be aware that your implementation needs to be thread-safe as it will
get used as singleton.
- If you need to store temporary informations within the SMTP
Transaction/Session you should
- use the SMTPSession.getState().put(...) and
SMTPSession.getConnectionState().put(...) methods.</p>
-
- <p>For a more explanation see the <a
href="http://james.apache.org/protocols/apidocs/index.html";>apidocs</a> for the
protocols library which
- is used by James SMTP Server.</p>
-
- </subsection>
-
- <subsection name="Get your Hook implementations loaded">
-
- <p>Just create a jar file which contains your code and put it in
/path/to/james/conf/lib/
- folder. The jar will get picked up by the ClassLoader automatic then.</p>
-
- <p>After that open the smtpserver.xml file and add your hook to the
<code><handlers></handlers></code> block in the order you
- want to have it executed. So if you have 2 MailHook implementation make
sure the first one
- which is listed in smtpserver.xml is the one you want to call first.</p>
-
+ <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=1032106&r1=1032105&r2=1032106&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev-extend.xml (original)
+++ james/server/trunk/src/site/xdoc/dev-extend.xml Sat Nov 6 16:04:57 2010
@@ -31,10 +31,20 @@
<subsection name="Custom Mailet">
+ See the <a href="dev-extend-custom-mailet.html">custom mailet</a> page for
more information.
+
</subsection>
<subsection name="Custom Matcher">
+ See the <a href="dev-extend-custom-mailet.html">custom matcher</a> page
for more information.
+
+ </subsection>
+
+ <subsection name="SMTP Hook">
+
+ See the <a href="dev-extend-hook-smtp.html">SMTP Hook</a> page for more
information.
+
</subsection>
<subsection name="Mailbox Store">
@@ -52,11 +62,7 @@
<subsection name="Queue Listeners">
</subsection>
-
- <subsection name="SMTP Hook">
-
- </subsection>
-
+
</section>
</body>
Modified: james/server/trunk/src/site/xdoc/feature-stores.xml
URL:
http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/feature-stores.xml?rev=1032106&r1=1032105&r2=1032106&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/feature-stores.xml (original)
+++ james/server/trunk/src/site/xdoc/feature-stores.xml Sat Nov 6 16:04:57 2010
@@ -61,6 +61,10 @@ And "file:///var/mail/spool/" (note the
</subsection>
+<subsection name="Database (JPA) Repositories">
+
+</subsection>
+
<subsection name="Database (JDBC) Repositories">
<p>Database repositories store all data in an administrator-supplied database.
Configuration is somewhat
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
