blob: 7666e8cd1547d0b28b61ab0210a80cf4375b42af [file] [log] [blame]
<?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 &#x2013; Apache James Protocols IMAP4</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="author" content="Apache James Protocols IMAP4" />
<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">
<strong>IMAP4</strong>
</li>
<li class="none">
<a href="../protocols/source-code.html" title="Source Code">Source Code</a>
</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="What_Is_Apache_James_Protocols_IMAP4.3F"></a>What Is Apache James Protocols IMAP4?</h2>
<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 class="externalLink" 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 class="externalLink" 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 class="externalLink" 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 on master)</li>
<li>MOVE (RFC 6851 https://tools.ietf.org/html/rfc6851 on master). This is enabled only if you use a MailboxManager exposing the Move capability</li>
<li>METADATA Extension (RFC 5464 http://www.ietf.org/rfc/rfc5464.txt on master). This is enabled only if you use a MailboxManager exposing the Annotation capability</li>
</ul>
<p>We follow RFC2683 recommendations for our implementations:</p>
<ul>
<li>IMAP4 Implementation Recommendations (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 class="externalLink" href="https://github.com/apache/james-project/tree/master/mpt">integration tests</a> for IMAP.</p>
<p>Our implementation is also tested against external tools such as <a class="externalLink" href="http://www.imapwiki.org/ImapTest">http://www.imapwiki.org/ImapTest</a>.</p>
</section>
<section>
<h2><a name="Apache_James_IMAP_in_Server_and_as_component"></a>Apache James IMAP in Server and as component</h2>
<p><a class="externalLink" href="http://james.apache.org/server">Apache James Server 3.6.0</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" alt="" />
</section>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">Copyright &#169; 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>