Author: eric
Date: Thu Apr 19 07:17:45 2012
New Revision: 1327848
URL: http://svn.apache.org/viewvc?rev=1327848&view=rev
Log:
Add pop3 and imap4 on protocols documentation
Added:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-package.png
(with props)
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-withtest-package.png
(with props)
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png
(with props)
james/protocols/trunk/src/site/xdoc/imap4.xml
james/protocols/trunk/src/site/xdoc/pop3.xml
james/protocols/trunk/src/site/xdoc/smtp.xml
Modified:
james/protocols/trunk/src/site/site.xml
james/protocols/trunk/src/site/xdoc/index.xml
james/protocols/trunk/src/site/xdoc/source-code.xml
Added:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-package.png
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-package.png?rev=1327848&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-package.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-withtest-package.png
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-withtest-package.png?rev=1327848&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap-withtest-package.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png?rev=1327848&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
james/protocols/trunk/src/site/resources/images/uml/org.apache.james.imap.api.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: james/protocols/trunk/src/site/site.xml
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/site.xml?rev=1327848&r1=1327847&r2=1327848&view=diff
==============================================================================
--- james/protocols/trunk/src/site/site.xml (original)
+++ james/protocols/trunk/src/site/site.xml Thu Apr 19 07:17:45 2012
@@ -36,6 +36,9 @@
<menu name="Documentation">
<item name="Introduction" href="/index.html" />
+ <item name="SMTP" href="/smtp.html" />
+ <item name="POP3" href="/pop3.html" />
+ <item name="IMAP4" href="/imap4.html" />
<item name="Source Code" href="/source-code.html" />
</menu>
Added: james/protocols/trunk/src/site/xdoc/imap4.xml
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/xdoc/imap4.xml?rev=1327848&view=auto
==============================================================================
--- james/protocols/trunk/src/site/xdoc/imap4.xml (added)
+++ james/protocols/trunk/src/site/xdoc/imap4.xml Thu Apr 19 07:17:45 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 govaerning permissions and limitations
+ under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Apache James Protocols IMAP4</title>
+ <author email="[email protected]">Apache James Protocols
IMAP4</author>
+ </properties>
+
+<body>
+
+ <section name="What Is Apache James Protocols IMAP4?">
+ <p>A library providing a flexible codec for IMAP4, command processors
+ and a sample data access layer.</p>
+ <p>In combination with a socket layer, and a mailbox persistence,
+ this library can be used to create an IMAP server.</p>
+ <p><a href='http://james.apache.org/server/rfclist/imap4/rfc2060.txt'>RFC
2060 IMAP4rev1</a>
+ is functionally complete, tested and usable. The data access layer is
still
+ under optimization on performance perspectives. API is susceptible to
change.</p>
+ <p>You can <a href="http://james.apache.org/download.cgi";>download</a>
current 0.3 release.
+ The <a href="apidocs/">API</a> are susceptible to evolve.</p>
+ <p>There are many extensions defined for IMAP (see a list <a
href="http://www.iana.org/assignments/imap4-capabilities";>here</a>)</p>
+ <p>Apache James IMAP implements the following:</p>
+ <ul>
+ <li>IMAP4rev1 (RFC 3501 http://www.ietf.org/rfc/rfc3501.txt)</li>
+ <li>NAMESPACE (in release 0.2) (RFC 2342
http://www.ietf.org/rfc/rfc2342.txt)</li>
+ <li>IDLE (in release 0.2) (RFC 2177
http://www.ietf.org/rfc/rfc2177.txt)</li>
+ <li>LITERAL+ (in release 0.2)</li>
+ <li>CHILDREN (in release 0.2)</li>
+ <li>WITHIN (in release 0.2)</li>
+ <li>UIDPLUS (in release 0.2)</li>
+ <li>UNSELECT (in release 0.2)</li>
+ <li>I18NLEVEL=1 (in release 0.2.1)</li>
+ <li>ESEARCH (in release 0.2.1)</li>
+ <li>SEARCHRES (in release 0.2.1)</li>
+ <li>AUTH=PLAIN (in release 0.2.1)</li>
+ <li>SASL-IR (in release 0.2.1)</li>
+ <li>ENABLE (in release 0.2.1)</li>
+ <li>CONDSTORE (RFC 4551 http://www.ietf.org/rfc/rfc4551.txt in release
0.3)</li>
+ <li>RESYNCH (RFC 5162 http://www.ietf.org/rfc/rfc5162.txt in trunk)</li>
+ </ul>
+ <p>We follow RFC2683 recommandations for our implementations:</p>
+ <ul>
+ <li>IMAP4 Implementation Recommandations (RFC 2683
http://www.ietf.org/rfc/rfc2683.txt)</li>
+ </ul>
+ <p>Interesting features:</p>
+ <ul>
+ <li>Users FLAGS</li>
+ </ul>
+ <p>Other RFCs of interest we are looking at:</p>
+ <ul>
+ <li>IMAP4 SORT and THREAD Extensions (RFC 5256
http://www.ietf.org/rfc/rfc5256.txt)</li>
+ </ul>
+ <p>We have <a
href="http://svn.apache.org/repos/asf/james/mailbox-integration-tester/trunk/";>integration
tests</a> for IMAP.</p>
+ <p>Our implementation is also tested against external tools such as <a
href="http://www.imapwiki.org/ImapTest";>http://www.imapwiki.org/ImapTest</a>.</p>
+ </section>
+
+ <section name='Apache James IMAP in Server and as component'>
+ <p><a href='http://james.apache.org/server/3'>Apache James Server 3</a>
supports IMAP
+ (using this library).</p>
+ <p>The <a href="source-code.html">source code</a> page contains
information on how
+ to develop on James IMAP.</p>
+ <img src="images/uml/org.apache.james.imap-package.png"/>
+ </section>
+
+</body>
+
+</document>
Modified: james/protocols/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/xdoc/index.xml?rev=1327848&r1=1327847&r2=1327848&view=diff
==============================================================================
--- james/protocols/trunk/src/site/xdoc/index.xml (original)
+++ james/protocols/trunk/src/site/xdoc/index.xml Thu Apr 19 07:17:45 2012
@@ -35,10 +35,9 @@
<section name="Apache James Protocols in Server and as Component">
<p>The framework is currently used by James Server in conjunction with
Netty to provide a
- high performance and extensible SMTP and POP3 Server.</p>
- <p>At the moment only the SMTP and POP3 protocols are included, but others
will follow such as IMAP.</p>
- <p>You can read more about protocols used for SMTP in James Server
- on the <a
href="http://james.apache.org/server/3/dev-extend-smtp-hook.html";>SMTP
Hooks</a> page.</p>
+ high performance and extensible <a href="smtp.html">SMTP</a>,
+ <a href="pop3.html">POP3</a> and <a href="imap4.html">IMAP4</a>
Server.</p>
+ <p>At the moment those 3 standard mail protocols are included, but others
will follow.</p>
</section>
<section name='Develop with Apache James Protocols'>
Added: james/protocols/trunk/src/site/xdoc/pop3.xml
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/xdoc/pop3.xml?rev=1327848&view=auto
==============================================================================
--- james/protocols/trunk/src/site/xdoc/pop3.xml (added)
+++ james/protocols/trunk/src/site/xdoc/pop3.xml Thu Apr 19 07:17:45 2012
@@ -0,0 +1,35 @@
+<?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 govaerning permissions and limitations
+ under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Apache James Protocols POP3</title>
+ <author email="[email protected]">Apache James</author>
+ </properties>
+
+<body>
+
+ <section name="Apache James Protocols POP3">
+ </section>
+
+</body>
+
+</document>
Added: james/protocols/trunk/src/site/xdoc/smtp.xml
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/xdoc/smtp.xml?rev=1327848&view=auto
==============================================================================
--- james/protocols/trunk/src/site/xdoc/smtp.xml (added)
+++ james/protocols/trunk/src/site/xdoc/smtp.xml Thu Apr 19 07:17:45 2012
@@ -0,0 +1,35 @@
+<?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 govaerning permissions and limitations
+ under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Apache James Protocols SMTP</title>
+ <author email="[email protected]">Apache James</author>
+ </properties>
+
+<body>
+
+ <section name="Apache James Protocols SMTP">
+ </section>
+
+</body>
+
+</document>
Modified: james/protocols/trunk/src/site/xdoc/source-code.xml
URL:
http://svn.apache.org/viewvc/james/protocols/trunk/src/site/xdoc/source-code.xml?rev=1327848&r1=1327847&r2=1327848&view=diff
==============================================================================
--- james/protocols/trunk/src/site/xdoc/source-code.xml (original)
+++ james/protocols/trunk/src/site/xdoc/source-code.xml Thu Apr 19 07:17:45 2012
@@ -36,6 +36,12 @@
</subsection>
</section>
+ <section name="Build Source Code">
+ <p>You can read a tutorial on how to build Apache James Server on <a
href="http://james.apache.org/server/3/dev-build.html";>http://james.apache.org/server/3/dev-build.html</a>.</p>
+ <p>The SVN URLs and the project names must be adapted, but the
requirements and process are the same and you can inspire
+ from the build the Apache James IMAP libraries.</p>
+ </section>
+
<section name="Source Organization">
<subsection name="Modules">
<div style="float:left; margin=4px;">
@@ -54,6 +60,36 @@
</subsection>
</section>
+ <section name="IMAP4 Source Code">
+ <subsection name="Modules">
+ <div style="float:left; margin:4px;">
+ <img src="images/uml/org.apache.james.imap-withtest-package.png"/>
+ </div>
+ </subsection>
+ <div style="clear:both; float:none;"/>
+ <subsection name="Apache James IMAP API">
+ <p><code>apache-james-imap-api</code> contains the interfaces,
exceptions and Constants needed by the other projects.</p>
+ <p>The following diagram represents some key (not all) interfaces of the
IMAP API project.</p>
+<!-- Add an updated image... -->
+<!-- <img src="images/uml/org.apache.james.imap.api.png"/>-->
+ </subsection>
+ <subsection name="Apache James IMAP Message">
+ <p><code>apache-james-imap-message</code> allows to encode, decode and
structure the IMAP requests and responses.</p>
+ <p>It will provide among other the ImapRequestMessage and
ImapResponseMessage implementation to be processed
+ by the apache-james-imap-processor project.</p>
+ </subsection>
+ <subsection name="Apache James IMAP Processor">
+ <p><code>apache-james-imap-processor</code> implements the Chain Of
Responsibility design pattern.</p>
+ <p>ImapRequestMessage and ImapResponder will be passed to the list of
Processors that
+ will execute doProcess if applicable.</p>
+ </subsection>
+ <subsection name="Apache James Integeration Test">
+ <p>A <a
href="https://svn.apache.org/repos/asf/james/mailbox-integration-tester/trunk/";>specific
integration project</a> is
+ responsible to test the IMAP protocol in conjunction with the <a
href="http://james.apache.org/mailbox";>Apache James mailbox</a> components.</p>
+ </subsection>
+
+ </section>
+
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
