| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| 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. |
| --> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- Generated by Apache Maven Doxia at 2021-11-12 --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| <title>Apache James Project – Source Code</title> |
| <style type="text/css" media="all"> |
| @import url("../css/james.css"); |
| @import url("../css/maven-base.css"); |
| @import url("../css/maven-theme.css"); |
| @import url("../css/site.css"); |
| @import url("../js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css"); |
| @import url("../js/jquery/css/print.css"); |
| @import url("../js/fancybox/jquery.fancybox-1.3.4.css"); |
| </style> |
| <script type="text/javascript" src="../js/jquery/js/jquery-1.4.2.min.js"></script> |
| <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> |
| <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> |
| <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> |
| <meta name="Date-Revision-yyyymmdd" content="20211112" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-1384591-1']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <a href="../index.html" id="bannerLeft" title="james-logo.png"> |
| |
| |
| <img src="../images/logos/james-logo.png" alt="James Project" /> |
| </a> |
| <a href="https://www.apache.org/index.html" id="bannerRight"> |
| |
| |
| <img src="images/logos/asf_logo_small.png" alt="The Apache Software Foundation" /> |
| </a> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2021-11-12</span> |
| </div> |
| <div class="xright"> <a href="../index.html" title="Home">Home</a> |
| | |
| <a href="../documentation.html" title="James">James</a> |
| | |
| <a href="../mime4j/index.html" title="Mime4J">Mime4J</a> |
| | |
| <a href="../jsieve/index.html" title="jSieve">jSieve</a> |
| | |
| <a href="../jspf/index.html" title="jSPF">jSPF</a> |
| | |
| <a href="../jdkim/index.html" title="jDKIM">jDKIM</a> |
| |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| <h5>James components</h5> |
| <ul> |
| <li class="collapsed"> |
| <a href="../documentation.html" title="About James">About James</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../server/index.html" title="Server">Server</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../mailet/index.html" title="Mailets">Mailets</a> |
| </li> |
| <li class="collapsed"> |
| <a href="../mailbox/index.html" title="Mailbox">Mailbox</a> |
| </li> |
| <li class="expanded"> |
| <a href="../protocols/index.html" title="Protocols">Protocols</a> |
| <ul> |
| <li class="none"> |
| <a href="../protocols/smtp.html" title="SMTP">SMTP</a> |
| </li> |
| <li class="none"> |
| <a href="../protocols/pop3.html" title="POP3">POP3</a> |
| </li> |
| <li class="none"> |
| <a href="../protocols/imap4.html" title="IMAP4">IMAP4</a> |
| </li> |
| <li class="none"> |
| <strong>Source Code</strong> |
| </li> |
| <li class="none"> |
| <a href="../protocols/apidocs/index.html" title="Javadoc">Javadoc</a> |
| </li> |
| <li class="none"> |
| <a href="https://issues.apache.org/jira/browse/PROTOCOLS" title="Issue Tracker">Issue Tracker</a> |
| </li> |
| <li class="none"> |
| <a href="../download.cgi#Apache_James_Protocols" title="Download Releases">Download Releases</a> |
| </li> |
| </ul> |
| </li> |
| <li class="collapsed"> |
| <a href="../mpt/index.html" title="MPT">MPT</a> |
| </li> |
| </ul> |
| <h5>Apache Software Foundation</h5> |
| <ul> |
| <li> |
| <strong> |
| <a title="ASF" href="http://www.apache.org/">ASF</a> |
| </strong> |
| </li> |
| <li> |
| <a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a> |
| </li> |
| <li> |
| <a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a> |
| </li> |
| <li> |
| <a title="License" href="http://www.apache.org/licenses/" >License</a> |
| </li> |
| <li> |
| <a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| </li> |
| <li> |
| <a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a> |
| </li> |
| <li> |
| <a title="Security" href="http://www.apache.org/security/">Security</a> |
| </li> |
| </ul> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| |
| |
| |
| |
| <section> |
| <h2><a name="Get_Source_Code"></a>Get Source Code</h2> |
| <section> |
| <h3><a name="Anonymous_Access"></a>Anonymous Access</h3> |
| |
| <p>The source can be checked out anonymously from GIT with the following command.</p> |
| |
| <p>$ git clone http://git-wip-us.apache.org/repos/asf/james-project.git</p> |
| |
| <p>$ cd protocols</p> |
| </section> |
| |
| <section> |
| <h3><a name="Developer_Access"></a>Developer Access</h3> |
| |
| <p>Everyone can access the GIT repository via HTTP, but Committers must checkout the GIT repository via HTTPS.</p> |
| |
| <p>$ git clone https://git-wip-us.apache.org/repos/asf/james-project.git</p> |
| |
| <p>$ cd protocols</p> |
| </section> |
| </section> |
| |
| <section> |
| <h2><a name="Build_Source_Code"></a>Build Source Code</h2> |
| |
| <p>You can read a tutorial on how to build Apache James Server on <a class="externalLink" href="http://james.apache.org/server/dev-build.html">http://james.apache.org/server/dev-build.html</a>.</p> |
| |
| <p>The GIT 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> |
| <h2><a name="Source_Organization"></a>Source Organization</h2> |
| <section> |
| <h3><a name="Modules"></a>Modules</h3> |
| |
| <div style="float:left; margin=4px;"> |
| <img src="images/uml/org.apache.james.protocols-package.png" alt="" /> |
| </div> |
| </section> |
| |
| <div style="clear:both; float:none;" /> |
| <section> |
| <h3><a name="James_Protocols_API"></a>James Protocols API</h3> |
| |
| <p>apache-james-protocols-api contains the interfaces, exceptions and Constants needed by the other projects.</p> |
| </section> |
| <section> |
| <h3><a name="James_Protocols_Implementation"></a>James Protocols Implementation</h3> |
| |
| <p>apache-james-protocols-impl provides common services that can be used by any mail protocol.</p> |
| </section> |
| <section> |
| <h3><a name="James_Protocols_SMTP"></a>James Protocols SMTP</h3> |
| |
| <p>apache-james-protocols-smtp implements the SMTP protocols with <a class="externalLink" href="http://james.apache.org/server/dev-extend-smtp-hook.html">hooks</a> for extensions.</p> |
| </section> |
| </section> |
| |
| <section> |
| <h2><a name="IMAP4_Source_Code"></a>IMAP4 Source Code</h2> |
| <section> |
| <h3><a name="Modules"></a>Modules</h3> |
| |
| <div style="float:left; margin:4px;"> |
| <img src="images/uml/org.apache.james.imap-withtest-package.png" alt="" /> |
| </div> |
| </section> |
| |
| <div style="clear:both; float:none;" /> |
| <section> |
| <h3><a name="Apache_James_IMAP_API"></a>Apache James IMAP API</h3> |
| |
| <p>apache-james-imap-api 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> |
| |
| |
| </section> |
| <section> |
| <h3><a name="Apache_James_IMAP_Message"></a>Apache James IMAP Message</h3> |
| |
| <p>apache-james-imap-message 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> |
| </section> |
| <section> |
| <h3><a name="Apache_James_IMAP_Processor"></a>Apache James IMAP Processor</h3> |
| |
| <p>apache-james-imap-processor 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> |
| </section> |
| <section> |
| <h3><a name="Apache_James_Integration_Test"></a>Apache James Integration Test</h3> |
| |
| <p>A <a class="externalLink" href="https://github.com/apache/james-project/tree/master/mpt">specific integration project</a> is |
| responsible to test the IMAP protocol in conjunction with the <a class="externalLink" href="http://james.apache.org/mailbox">Apache James mailbox</a> components.</p> |
| </section> |
| |
| </section> |
| |
| |
| |
| |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright">Copyright © 2006-2021 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
