| 1 |
=============================== |
| 2 |
Automatic Creation of Mailboxes |
| 3 |
=============================== |
| 4 |
|
| 5 |
Cyrus IMAP features the ability to create mailboxes automatically; |
| 6 |
|
| 7 |
* for successful login events, |
| 8 |
|
| 9 |
* for email messages that arrive for a user, |
| 10 |
|
| 11 |
* when a Sieve script uses the "fileinto" action. |
| 12 |
|
| 13 |
When operating an IT infrastructure, Cyrus IMAP may only be one part of |
| 14 |
such larger environment. When adding a user |
| 15 |
*John Doe <[email protected]>*, several pieces may need to fall or |
| 16 |
put in place to ensure the account is fully functional. |
| 17 |
|
| 18 |
Cyrus IMAP allows the automatic creation of John's INBOX, and selected |
| 19 |
sub-folders, either when John first logs in to Cyrus IMAP, or when the |
| 20 |
first message is to be delivered to John's INBOX. |
| 21 |
|
| 22 |
Additional features of this functionality include; |
| 23 |
|
| 24 |
* the automatic creation of a Sieve script for |
| 25 |
:ref:`imap-features-server-side-filtering`. |
| 26 |
|
| 27 |
* setting a storage quota and message quota for the user, |
| 28 |
|
| 29 |
* automatic subscription to folders in the |
| 30 |
:ref:`imap-features-namespaces-personal`, |
| 31 |
|
| 32 |
* automatic subscription to a selection of or all shared folders. |
| 33 |
|
| 34 |
.. IMPORTANT:: |
| 35 |
|
| 36 |
Third party solutions incorporating Cyrus IMAP, and distributors of |
| 37 |
Cyrus IMAP (such as your Linux distribution) may have disabled this |
| 38 |
functionality altogether, during the building of the packages -- |
| 39 |
most likely because they employ different means to get user's |
| 40 |
mailboxes created. |
| 41 |
|
| 42 |
Cyrus IMAP does not currently strip options from man-pages that are |
| 43 |
rendered irrelevant by the functionality not being built in, so |
| 44 |
while the man-page on your system may refer to settings related to |
| 45 |
this functionality, the actual functionality may not be available. |
| 46 |
|
| 47 |
To enable the automatic creation of mailboxes, set the following options |
| 48 |
in :cyrusman:`imapd.conf(5)`. |
| 49 |
|
| 50 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 51 |
:start-after: startblob autocreate_quota |
| 52 |
:end-before: endblob autocreate_quota |
| 53 |
|
| 54 |
|
| 55 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 56 |
:start-after: startblob autocreate_post |
| 57 |
:end-before: endblob autocreate_post |
| 58 |
|
| 59 |
Other settings in :cyrusman:`imapd.conf(5)` affecting automatic |
| 60 |
options. |
| 61 |
|
| 62 |
Autocreation of mailboxes |
| 63 |
------------------------- |
| 64 |
|
| 65 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 66 |
:start-after: startblob autocreate_inbox_folders |
| 67 |
:end-before: endblob autocreate_inbox_folders |
| 68 |
|
| 69 |
Automatic quota settings |
| 70 |
------------------------ |
| 71 |
|
| 72 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 73 |
:start-after: startblob autocreate_quota_messages |
| 74 |
:end-before: endblob autocreate_quota_messages |
| 75 |
|
| 76 |
|
| 77 |
Autocreation of Sieve scripts |
| 78 |
----------------------------- |
| 79 |
|
| 80 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 81 |
:start-after: startblob autocreate_sieve_folders |
| 82 |
:end-before: endblob autocreate_sieve_folders |
| 83 |
|
| 84 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 85 |
:start-after: startblob autocreate_sieve_script |
| 86 |
:end-before: endblob autocreate_sieve_script |
| 87 |
|
| 88 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 89 |
:start-after: startblob autocreate_sieve_script_compile |
| 90 |
:end-before: endblob autocreate_sieve_script_compile |
| 91 |
|
| 92 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 93 |
:start-after: startblob autocreate_sieve_script_compiled |
| 94 |
:end-before: endblob autocreate_sieve_script_compiled |
| 95 |
|
| 96 |
Automated folder subscriptions |
| 97 |
------------------------------ |
| 98 |
|
| 99 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 100 |
:start-after: startblob autocreate_subscribe_folders |
| 101 |
:end-before: endblob autocreate_subscribe_folders |
| 102 |
|
| 103 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 104 |
:start-after: startblob autocreate_subscribe_sharedfolders |
| 105 |
:end-before: endblob autocreate_subscribe_sharedfolders |
| 106 |
|
| 107 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 108 |
:start-after: startblob autocreate_subscribe_sharedfolders_all |
| 109 |
:end-before: endblob autocreate_subscribe_sharedfolders_all |
| 110 |
|
| 111 |
Autocreation of users |
| 112 |
--------------------- |
| 113 |
|
| 114 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 115 |
:start-after: startblob autocreate_users |
| 116 |
:end-before: endblob autocreate_users |
| 117 |
|
| 118 |
See :cyrusman:`imapd.conf(5)` for the full documentation of |
| 119 |
all options. |
| 120 |
|
| 121 |
.. seealso:: |
| 122 |
|
| 123 |
* :ref:`imap-features-murder` |
| 124 |
* :ref:`imap-features-mailbox-distribution` |
| 125 |
* :ref:`imap-features-quota` |
| 126 |
|
| 127 |
Limitations to the Automatic Creation of Mailboxes |
| 128 |
================================================== |
| 129 |
|
| 130 |
#. A user may in fact be able to successfully login to IMAP with both a |
| 131 |
full primary recipient email address such as |
| 132 |
``[email protected]``, as well as a secondary recipient email |
| 133 |
address such as ``[email protected]``. |
| 134 |
|
| 135 |
Unless a process known as login username canonification is used, |
| 136 |
this could result in two different mailbox hierarchies being |
| 137 |
created; |
| 138 |
|
| 139 |
* ``user/[email protected]`` |
| 140 |
|
| 141 |
* ``user/[email protected]`` |
| 142 |
|
| 143 |
#. When a user *Jane Gi <[email protected]>* marries *John Doe* and |
| 144 |
adopts her new husband's surname, her primary recipient email |
| 145 |
address may change to become ``[email protected]``. |
| 146 |
|
| 147 |
Note that *John Doe* does not need to be an ``example.org`` user for |
| 148 |
such event to occur, and that many countries allow the husband to |
| 149 |
take the maiden name of their spouse instead -- so even if the |
| 150 |
employees and/or associates of an organization running Cyrus IMAP |
| 151 |
are exclusively male, this may still apply to that organization. |
| 152 |
|
| 153 |
The functionality stated in this document does **not** rename |
| 154 |
``user/[email protected]`` to become |
| 155 |
``user/[email protected]``. |
| 156 |
|
| 157 |
Back to :ref:`imap-features` |