| 1 |
==== |
| 2 |
JMAP |
| 3 |
==== |
| 4 |
|
| 5 |
About JMAP |
| 6 |
========== |
| 7 |
|
| 8 |
`JMAP <http://jmap.io/>`_ is an alternate mechanism for synchronising a mail |
| 9 |
client with a mail server, intended as a replacement for IMAP. It is a |
| 10 |
transport-agnostic, stateless JSON-based API, aiming to be compatible with the |
| 11 |
IMAP data model, but with reduced data usage and more efficient synchronisation. |
| 12 |
|
| 13 |
Configuration |
| 14 |
============= |
| 15 |
|
| 16 |
.. todo:: |
| 17 |
|
| 18 |
Stop duplication in this and developer-jmap by moving a chunk of this |
| 19 |
information into /assets and include instead. |
| 20 |
|
| 21 |
JMAP support needs to be compiled in to the server using additional |
| 22 |
compile flags. Depending on your distribution, your package provider may |
| 23 |
have already done so. If not, check the |
| 24 |
:ref:`JMAP developer guide <developer-jmap>` for instructions on how to do |
| 25 |
so manually, assuming you have the source. |
| 26 |
|
| 27 |
.. sidebar:: JMAP configuration |
| 28 |
|
| 29 |
|change-default-config| |
| 30 |
|
| 31 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 32 |
:start-after: startblob conversations |
| 33 |
:end-before: endblob conversations |
| 34 |
|
| 35 |
| |
| 36 |
|
| 37 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 38 |
:start-after: startblob conversations_db |
| 39 |
:end-before: endblob conversations_db |
| 40 |
|
| 41 |
Once it's compiled, JMAP needs to be enabled in :cyrusman:`imapd.conf(5)`. |
| 42 |
|
| 43 |
Enable :ref:`conversation support <imap-concepts-deployment-db-conversations>` |
| 44 |
|
| 45 |
* In :cyrusman:`imapd.conf(5)`, set ``conversations: 1``, ``conversations_db: twoskip`` |
| 46 |
* Create a conversations.db for each user using |
| 47 |
:cyrusman:`ctl_conversationsdb(8)`: ``ctl_conversationsdb -b -r`` |
| 48 |
|
| 49 |
JMAP clients |
| 50 |
============ |
| 51 |
|
| 52 |
The official JMAP website maintains a list of `known clients with JMAP support |
| 53 |
<http://jmap.io/software.html>`_. |
| 54 |
|
| 55 |
The Cyrus :ref:`JMAP developer guide <developer-jmap>` has information on using |
| 56 |
the sample test clients. |
| 57 |
|
| 58 |
.. _jmap-implementation: |
| 59 |
|
| 60 |
JMAP implementation status |
| 61 |
========================== |
| 62 |
|
| 63 |
The JMAP implementation in Cyrus is at various stages of maturity. |
| 64 |
|
| 65 |
Implemented |
| 66 |
----------- |
| 67 |
|
| 68 |
* The core protocol (:rfc:`8620`), except for PushSubscription |
| 69 |
* JMAP for Mail (:rfc:`8621`) |
| 70 |
* JMAP Blob Management Extension (:rfc:`9404`) |
| 71 |
* JMAP for Quotas (:rfc:`9425`) |
| 72 |
* JMAP for Sieve Scripts (:rfc:`9661`) |
| 73 |
* A JMAP Subprotocol for WebSocket (:rfc:`8887`) |
| 74 |
|
| 75 |
In development |
| 76 |
-------------- |
| 77 |
|
| 78 |
* JMAP for Calendars (:draft:`draft-ietf-jmap-calendars`) |
| 79 |
* JMAP for Contacts (:draft:`draft-ietf-jmap-contacts`) |
| 80 |
* JMAP Sharing (:draft:`draft-ietf-jmap-sharing`) |
| 81 |
* Handling MDN with JMAP (:rfc:`9007`) |
| 82 |
|
| 83 |
Not implemented |
| 84 |
--------------- |
| 85 |
* JMAP for Tasks (:draft:`draft-ietf-jmap-tasks`) |
| 86 |
* JMAP SMIME Signature Verification Extensions(:rfc:`9219`) |