| 1 |
:tocdepth: 3 |
| 2 |
|
| 3 |
==================================== |
| 4 |
Cyrus IMAP 3.6.0-beta3 Release Notes |
| 5 |
==================================== |
| 6 |
|
| 7 |
Download from GitHub: |
| 8 |
|
| 9 |
* https://github.com/cyrusimap/cyrus-imapd/releases/download/cyrus-imapd-3.6.0-beta3/cyrus-imapd-3.6.0-beta3.tar.gz |
| 10 |
* https://github.com/cyrusimap/cyrus-imapd/releases/download/cyrus-imapd-3.6.0-beta3/cyrus-imapd-3.6.0-beta3.tar.gz.sig |
| 11 |
|
| 12 |
.. _relnotes-3.6.0-beta3-changes: |
| 13 |
|
| 14 |
Major changes since the 3.4 series |
| 15 |
================================== |
| 16 |
|
| 17 |
* All members of a newly created mailbox hierarchy will now be selectable |
| 18 |
mailboxes. In other words, when creating mailbox user.foo.A.B.C, both |
| 19 |
user.foo.A and user.foo.A.B will also be created as real mailboxes. |
| 20 |
* XFER will no longer move individual mailboxes that would leave unselectable |
| 21 |
mailboxes behind in the user heirarchy. |
| 22 |
* Update IMAP PREVIEW extension from |
| 23 |
:draft:`draft-ietf-extra-imap-fetch-preview-07` to :rfc:`8970`. |
| 24 |
* JMAP Blob handling updated to :draft:`draft-ietf-jmap-blob-04` |
| 25 |
* Always return 'blobId' and 'size' in Contact/setcreate, Contact/setupdate, |
| 26 |
and Contact/get responses. |
| 27 |
* Added Bearer authentication for :rfc:`7519` JSON Web Tokens. See |
| 28 |
`http_jwt_key` and `http_jwt_max_age` in :cyrusman:`imapd.conf(5)`. |
| 29 |
* Added `icalendar_max_size` and `vcard_max_size` :cyrusman:`imapd.conf(5)` |
| 30 |
options to limit the size of iCalendar and vCard resources that can be |
| 31 |
stored. |
| 32 |
* Added `caldav_accept_invalid_rrules` :cyrusman:`imapd.conf(5)` option to |
| 33 |
configure whether invalid RRULES should be accepted or rejected. They |
| 34 |
were previously always rejected. |
| 35 |
* The `event_extra_params` :cyrusman:`imapd.conf(5)` option now supports |
| 36 |
a `vnd.fastmail.jmapEmail` selector, which adds a JMAP Email object to |
| 37 |
event messages. If you enable this selector, you might consider removing |
| 38 |
`vnd.cmu.envelope`, `vnd.cmu.emailid`, and `vnd.cmu.threadid`, as they |
| 39 |
would be redundant. |
| 40 |
* Added `search_maxsize` :cyrusman:`imapd.conf(5)` option to limit how much |
| 41 |
of long message body parts are indexed by Xapian, which can improve indexing |
| 42 |
and snippet-generation latency. The default is 4MB. An earlier |
| 43 |
implementation applied a hardcoded 4MB limit to entire messages; systems |
| 44 |
that had this implementation may notice an increase in index size due to |
| 45 |
more text now being indexed. |
| 46 |
* The :cyrusman:`squatter(8)` `-s delta` option now requires the delta |
| 47 |
argument. |
| 48 |
* Added an upper limit to :cyrusman:`sync_client(8)`'s exponential reconnect |
| 49 |
backoff, configurable with the `sync_reconnect_maxwait` |
| 50 |
:cyrusman:`imapd.conf(5)` option. |
| 51 |
* :cyrusman:`sync_client(8)` now recognises when the remote |
| 52 |
:cyrusman:`sync_server(8)` has been shut down cleanly, and doesn't log a |
| 53 |
bunch of disconnection errors about it. |
| 54 |
* :cyrusman:`sync_client(8)` `-A` mode now keeps processing subsequent |
| 55 |
mailboxes after errors (reconnecting to the replica if necessary), instead |
| 56 |
of bailing out at the first error. This means everything that can be |
| 57 |
replicated is replicated. |
| 58 |
* New :cyrusman:`sync_client(8)` `-N` option to skip users that are currently |
| 59 |
being replicated by another process, rather than blocking on the lock only |
| 60 |
to have nothing left to do once it's been obtained. |
| 61 |
* Added an inactivity timeout for WebSocket connections, configurable with |
| 62 |
the `websocket_timeout` :cyrusman:`imapd.conf(5)` option. |
| 63 |
* Mailboxes and user metadata directories are now organised on disk by UUID |
| 64 |
rather than by mailbox name. See :ref:`relnotes_3.6.0-beta3_storage_changes` below. |
| 65 |
* Sieve scripts are now stored in a special mailbox, rather than in |
| 66 |
`sievedir`. Compiled bytecode is still stored in `sievedir`. The name of |
| 67 |
the mailbox can be overridden with the `sieve_folder` |
| 68 |
:cyrusman:`imapd.conf(5)` option (default: '#sieve'). |
| 69 |
* Experimental `processimip` Sieve action, for updating calendar entries |
| 70 |
based on iMIP (:rfc:`6047`) messages. |
| 71 |
* Support for JMAP Push (:rfc:`8620`) over EventSource, with polling interval |
| 72 |
controlled by the `jmap_pushpoll` :cyrusman:`imapd.conf(5)` option |
| 73 |
(default: 60s). |
| 74 |
* Experimental support for JMAP Push over WebSockets, if Cyrus has been |
| 75 |
compiled with WebSockets enabled. Controlled by the same `jmap_pushpoll` |
| 76 |
option. |
| 77 |
* When a MIME part Content-Type header incorrectly specifies multiple charsets, |
| 78 |
Cyrus now checks each charset for validity and uses the last valid one. |
| 79 |
Previously, it would just use the first one, which is often junk when |
| 80 |
multiple are present. |
| 81 |
* JMAP Email/query and XCONV IMAP extension commands no longer ignore the SEEN |
| 82 |
state of messages in the "Trash" mailbox when evaluating conversation flags. |
| 83 |
Queries must explicitly exclude the "Trash" mailbox to ignore SEEN state of |
| 84 |
messages in "Trash". |
| 85 |
* JMAP Contact.importance property is now a per-user property rather than |
| 86 |
shared. |
| 87 |
* JMAP Contacts now uses Apple-style labels on vCard ADR/TEL/EMAIL properties |
| 88 |
(via property grouping). |
| 89 |
* JMAP Contacts avatars can now reference any valid blob, not only blobs |
| 90 |
originally uploaded via JMAP. |
| 91 |
* Preliminary support for building with OpenSSL 3. |
| 92 |
|
| 93 |
|
| 94 |
.. _relnotes_3.6.0-beta3_storage_changes: |
| 95 |
|
| 96 |
Storage changes |
| 97 |
=============== |
| 98 |
|
| 99 |
.. Note:: Please consult :ref:`upgrade` prior to upgrading. |
| 100 |
|
| 101 |
Mailboxes and user metadata directories are now organised on disk by UUID |
| 102 |
rather than by mailbox name. |
| 103 |
|
| 104 |
At startup (or when you run `ctl_cyrusdb -r` manually), |
| 105 |
:cyrusman:`ctl_cyrusdb(8)` will upgrade mailboxes.db to accommodate both |
| 106 |
old-style and new-style storage. |
| 107 |
|
| 108 |
By default, new top-level mailboxes will be created in the new style. |
| 109 |
Mailboxes that already exist will remain in the old style until you convert |
| 110 |
them with :cyrusman:`relocate_by_id(8)`. New mailboxes below the top level |
| 111 |
will be created in the same style as their parent mailbox. |
| 112 |
|
| 113 |
The new :cyrusman:`cyr_ls(8)` tool can be used to examine the on-disk |
| 114 |
contents of a given mailbox name. :cyrusman:`mbpath(8)` can be used to find |
| 115 |
where on disk a given mailbox and its metadata are. |
| 116 |
|
| 117 |
If you want new top level mailboxes to be created in the old style, you |
| 118 |
can enable the `mailbox_legacy_dirs` :cyrusman:`imapd.conf(5)` option, which |
| 119 |
defaults to **off**. With this turned on, you may still use `relocate_by_id` |
| 120 |
to convert them to the new style. |
| 121 |
|
| 122 |
Updates to default configuration |
| 123 |
================================ |
| 124 |
|
| 125 |
The :cyrusman:`cyr_info(8)` `conf`, `conf-all` and `conf-default` subcommands |
| 126 |
accept an `-s <version>` argument to highlight :cyrusman:`imapd.conf(5)` |
| 127 |
options that are new or whose behaviour has changed since the specified |
| 128 |
version. We recommend using this when evaluating a new Cyrus version to |
| 129 |
check which configuration options you will need to examine and maybe set or |
| 130 |
change during the process. |
| 131 |
|
| 132 |
* The `reverseuniqueids` :cyrusman:`imapd.conf(5)` option is now deprecated |
| 133 |
and unused. Reverse UNIQUEID records are now standard and cannot be turned |
| 134 |
off. |
| 135 |
|
| 136 |
Security fixes |
| 137 |
============== |
| 138 |
|
| 139 |
* None so far |
| 140 |
|
| 141 |
Significant bugfixes |
| 142 |
==================== |
| 143 |
|
| 144 |
* Fixed :issue:`3325`: email addresses with quoted-string names were stored in |
| 145 |
the cache and search indexes without quotes, which could cause |
| 146 |
inconsistencies in handling. Affected mailboxes can be fixed by first |
| 147 |
running :cyrusman:`reconstruct(8)` to repair the cache, and then |
| 148 |
:cyrusman:`squatter(8)` to reindex the mailbox. |
| 149 |
* Fixed :issue:`3421`: PROPFIND <C:schedule-calendar-transp> now returns an |
| 150 |
XML element instead of text. (thanks Дилян Палаузов) |
| 151 |
* Fixed :issue:`3896`: the `-d` (dump) and `-u` (undump) options to |
| 152 |
:cyrusman:`ctl_mboxlist(8)` now correctly dump and undump all fields in |
| 153 |
mailboxes.db entries. The intermediary file format is now JSON. |
| 154 |
* Fixed :issue:`4035`: `ctl_cyrusdb -r` now recovers from mailboxes.db |
| 155 |
records with missing uniqueids, instead of crashing. A new `-P` option to |
| 156 |
:cyrusman:`reconstruct(8)` enables repairing mailboxes whose header files |
| 157 |
are missing uniqueids. |