Debian Codegraph @

doc/html/imap/download/installation/http/jmap.html

raw
1 <!DOCTYPE html>
2 <html class="writer-html5" lang="en" data-content_root="../../../../">
3 <head>
4 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5
6 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7 <title>JMAP &mdash; Cyrus IMAP 3.12.3 documentation</title>
8 <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
9 <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=86f27845" />
10 <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=eafc0fe6" />
11 <link rel="stylesheet" href="../../../../_static/cyrus.css" type="text/css" />
12
13
14
15 <script src="../../../../_static/jquery.js?v=8dae8fb0"></script>
16 <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17 <script src="../../../../_static/documentation_options.js?v=2c828074"></script>
18 <script src="../../../../_static/doctools.js?v=888ff710"></script>
19 <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
20 <script src="../../../../_static/js/theme.js"></script>
21 <link rel="index" title="Index" href="../../../../genindex.html" />
22 <link rel="search" title="Search" href="../../../../search.html" />
23 <link rel="next" title="RSS Feeds" href="rss.html" />
24 <link rel="prev" title="WebDAV" href="webdav.html" />
25 </head>
26
27 <body class="wy-body-for-nav">
28 <div class="wy-grid-for-nav">
29 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
30 <div class="wy-side-scroll">
31 <div class="wy-side-nav-search" >
32
33
34
35 <a href="../../../../index.html" class="icon icon-home">
36 Cyrus IMAP
37 </a>
38 <div class="version">
39 3.12.3
40 </div>
41 <div role="search">
42 <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
43 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
44 <input type="hidden" name="check_keywords" value="yes" />
45 <input type="hidden" name="area" value="default" />
46 </form>
47 </div>
48 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
49 <p class="caption" role="heading"><span class="caption-text">Cyrus IMAP</span></p>
50 <ul class="current">
51 <li class="toctree-l1"><a class="reference internal" href="../../../../download.html">Download</a></li>
52 <li class="toctree-l1"><a class="reference internal" href="../../../../quickstart.html">Quickstart Guide</a></li>
53 <li class="toctree-l1"><a class="reference internal" href="../../../../overview.html">Overview</a></li>
54 <li class="toctree-l1 current"><a class="reference internal" href="../../../../setup.html">Setup</a><ul class="current">
55 <li class="toctree-l2"><a class="reference internal" href="../../../developer/compiling.html">Compiling</a></li>
56 <li class="toctree-l2 current"><a class="reference internal" href="../../../installing.html">Installing Cyrus</a><ul class="current">
57 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#install-cyrus">Install Cyrus</a></li>
58 <li class="toctree-l3 current"><a class="reference internal" href="../../../installing.html#optional-components">Optional Components</a><ul class="current">
59 <li class="toctree-l4 current"><a class="reference internal" href="../manage-dav.html">HTTP modules</a></li>
60 <li class="toctree-l4"><a class="reference internal" href="../virus.html">Virus Scanner</a></li>
61 </ul>
62 </li>
63 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#setting-up-syslog">Setting up syslog</a></li>
64 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#create-cyrus-environment">Create Cyrus environment</a></li>
65 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#launch-cyrus">Launch Cyrus</a></li>
66 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#send-a-test-email">Send a test email</a></li>
67 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#checking-carddav-and-caldav">Checking CardDAV and CalDAV</a></li>
68 <li class="toctree-l3"><a class="reference internal" href="../../../installing.html#troubleshooting">Troubleshooting</a></li>
69 </ul>
70 </li>
71 <li class="toctree-l2"><a class="reference internal" href="../../upgrade.html">Upgrading to 3.12</a></li>
72 <li class="toctree-l2"><a class="reference internal" href="../../../concepts/deployment.html">Configuration Guide</a></li>
73 </ul>
74 </li>
75 <li class="toctree-l1"><a class="reference internal" href="../../../../operations.html">Operations</a></li>
76 <li class="toctree-l1"><a class="reference internal" href="../../../../developers.html">Developers</a></li>
77 <li class="toctree-l1"><a class="reference internal" href="../../../../support.html">Support/Community</a></li>
78 </ul>
79 <p class="caption" role="heading"><span class="caption-text">Cyrus SASL</span></p>
80 <ul>
81 <li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
82 </ul>
83
84 </div>
85 </div>
86 </nav>
87
88 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
89 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
90 <a href="../../../../index.html">Cyrus IMAP</a>
91 </nav>
92
93 <div class="wy-nav-content">
94 <div class="rst-content">
95 <div role="navigation" aria-label="Page navigation">
96 <ul class="wy-breadcrumbs">
97 <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
98 <li class="breadcrumb-item"><a href="../../../../setup.html">Setup</a></li>
99 <li class="breadcrumb-item"><a href="../../../installing.html">Installing Cyrus</a></li>
100 <li class="breadcrumb-item"><a href="../manage-dav.html">HTTP modules</a></li>
101 <li class="breadcrumb-item active">JMAP</li>
102 <li class="wy-breadcrumbs-aside">
103 <a href="https://github.com/cyrusimap/cyrus-imapd/blob/master/docsrc/imap/download/installation/http/jmap.rst" class="fa fa-github"> Edit on GitHub</a>
104 </li>
105 </ul>
106 <hr/>
107 </div>
108 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
109 <div itemprop="articleBody">
110
111 <section id="jmap">
112 <h1>JMAP<a class="headerlink" href="#jmap" title="Link to this heading"></a></h1>
113 <section id="about-jmap">
114 <h2>About JMAP<a class="headerlink" href="#about-jmap" title="Link to this heading"></a></h2>
115 <p><a class="reference external" href="http://jmap.io/">JMAP</a> is an alternate mechanism for synchronising a mail
116 client with a mail server, intended as a replacement for IMAP. It is a
117 transport-agnostic, stateless JSON-based API, aiming to be compatible with the
118 IMAP data model, but with reduced data usage and more efficient synchronisation.</p>
119 </section>
120 <section id="configuration">
121 <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h2>
122 <p>JMAP support needs to be compiled in to the server using additional
123 compile flags. Depending on your distribution, your package provider may
124 have already done so. If not, check the
125 <a class="reference internal" href="../../../developer/jmap.html#developer-jmap"><span class="std std-ref">JMAP developer guide</span></a> for instructions on how to do
126 so manually, assuming you have the source.</p>
127 <aside class="sidebar">
128 <p class="sidebar-title">JMAP configuration</p>
129 <blockquote>
130 <div><p><em>This shows the default value: change it in imapd.conf to suit your needs.</em></p>
131 </div></blockquote>
132 <blockquote>
133 <div><p><code class="docutils literal notranslate"><span class="pre">conversations:</span></code> 0</p>
134 <blockquote>
135 <div><p>Enable the XCONVERSATIONS extensions. Extract conversation
136 tracking information from incoming messages and track them
137 in per-user databases.</p>
138 </div></blockquote>
139 </div></blockquote>
140 <div class="line-block">
141 <div class="line"><br /></div>
142 </div>
143 <blockquote>
144 <div><p><code class="docutils literal notranslate"><span class="pre">conversations_db:</span></code> skiplist</p>
145 <blockquote>
146 <div><p>The cyrusdb backend to use for the per-user conversations database.</p>
147 <p>Allowed values: <em>skiplist</em>, <em>sql</em>, <em>twoskip</em>, <em>zeroskip</em></p>
148 </div></blockquote>
149 </div></blockquote>
150 </aside>
151 <p>Once it's compiled, JMAP needs to be enabled in <a class="reference internal" href="../../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>.</p>
152 <p>Enable <a class="reference internal" href="../../../concepts/deployment/databases.html#imap-concepts-deployment-db-conversations"><span class="std std-ref">conversation support</span></a></p>
153 <blockquote>
154 <div><ul class="simple">
155 <li><p>In <a class="reference internal" href="../../../reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>, set <code class="docutils literal notranslate"><span class="pre">conversations:</span> <span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">conversations_db:</span> <span class="pre">twoskip</span></code></p></li>
156 <li><p>Create a conversations.db for each user using
157 <a class="reference internal" href="../../../reference/manpages/systemcommands/ctl_conversationsdb.html#std-cyrusman-ctl_conversationsdb-8">ctl_conversationsdb(8)</a>: <code class="docutils literal notranslate"><span class="pre">ctl_conversationsdb</span> <span class="pre">-b</span> <span class="pre">-r</span></code></p></li>
158 </ul>
159 </div></blockquote>
160 </section>
161 <section id="jmap-clients">
162 <h2>JMAP clients<a class="headerlink" href="#jmap-clients" title="Link to this heading"></a></h2>
163 <p>The official JMAP website maintains a list of <a class="reference external" href="http://jmap.io/software.html">known clients with JMAP support</a>.</p>
164 <p>The Cyrus <a class="reference internal" href="../../../developer/jmap.html#developer-jmap"><span class="std std-ref">JMAP developer guide</span></a> has information on using
165 the sample test clients.</p>
166 </section>
167 <section id="jmap-implementation-status">
168 <span id="jmap-implementation"></span><h2>JMAP implementation status<a class="headerlink" href="#jmap-implementation-status" title="Link to this heading"></a></h2>
169 <p>The JMAP implementation in Cyrus is at various stages of maturity.</p>
170 <section id="implemented">
171 <h3>Implemented<a class="headerlink" href="#implemented" title="Link to this heading"></a></h3>
172 <ul class="simple">
173 <li><p>The core protocol (<span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc8620.html"><strong>RFC 8620</strong></a>), except for PushSubscription</p></li>
174 <li><p>JMAP for Mail (<span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc8621.html"><strong>RFC 8621</strong></a>)</p></li>
175 <li><p>JMAP Blob Management Extension (<span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc9404.html"><strong>RFC 9404</strong></a>)</p></li>
176 <li><p>JMAP for Quotas (<span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc9425.html"><strong>RFC 9425</strong></a>)</p></li>
177 <li><p>JMAP for Sieve Scripts (<span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc9661.html"><strong>RFC 9661</strong></a>)</p></li>
178 <li><p>A JMAP Subprotocol for WebSocket (<span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc8887.html"><strong>RFC 8887</strong></a>)</p></li>
179 </ul>
180 </section>
181 <section id="in-development">
182 <h3>In development<a class="headerlink" href="#in-development" title="Link to this heading"></a></h3>
183 <ul class="simple">
184 <li><p>JMAP for Calendars (<a class="reference external" href="https://tools.ietf.org/html/draft-ietf-jmap-calendars">draft-ietf-jmap-calendars</a>)</p></li>
185 <li><p>JMAP for Contacts (<a class="reference external" href="https://tools.ietf.org/html/draft-ietf-jmap-contacts">draft-ietf-jmap-contacts</a>)</p></li>
186 <li><p>JMAP Sharing (<a class="reference external" href="https://tools.ietf.org/html/draft-ietf-jmap-sharing">draft-ietf-jmap-sharing</a>)</p></li>
187 <li><p>Handling MDN with JMAP (<span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc9007.html"><strong>RFC 9007</strong></a>)</p></li>
188 </ul>
189 </section>
190 <section id="not-implemented">
191 <h3>Not implemented<a class="headerlink" href="#not-implemented" title="Link to this heading"></a></h3>
192 <ul class="simple">
193 <li><p>JMAP for Tasks (<a class="reference external" href="https://tools.ietf.org/html/draft-ietf-jmap-tasks">draft-ietf-jmap-tasks</a>)</p></li>
194 <li><p>JMAP SMIME Signature Verification Extensions(<span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc9219.html"><strong>RFC 9219</strong></a>)</p></li>
195 </ul>
196 </section>
197 </section>
198 </section>
199
200
201 </div>
202 </div>
203 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
204 <a href="webdav.html" class="btn btn-neutral float-left" title="WebDAV" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
205 <a href="rss.html" class="btn btn-neutral float-right" title="RSS Feeds" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
206 </div>
207
208 <hr/>
209
210 <div role="contentinfo">
211 <p>&#169; Copyright 1993–2026, The Cyrus Team.</p>
212 </div>
213
214 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
215 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
216 provided by <a href="https://readthedocs.org">Read the Docs</a>.
217
218
219 </footer>
220 </div>
221 </div>
222 </section>
223 </div>
224 <script>
225 jQuery(function () {
226 SphinxRtdTheme.Navigation.enable(true);
227 });
228 </script>
229
230
231
232
233 </body>
234 </html>