| 1 |
.. _imap-admin-locations-spool: |
| 2 |
|
| 3 |
Spool Directories |
| 4 |
================= |
| 5 |
|
| 6 |
Default Spool location |
| 7 |
---------------------- |
| 8 |
|
| 9 |
The main Cyrus IMAP mail data directory structure is the spool, and its |
| 10 |
location is defined by ``partition-name`` entries in |
| 11 |
:cyrusman:`imapd.conf(5)`. |
| 12 |
|
| 13 |
Additionally, on servers with more than one spool partition, that |
| 14 |
partition in which new user mailboxes are to be created is specified by |
| 15 |
the ``defaultpartition`` directive. |
| 16 |
|
| 17 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 18 |
:start-after: startblob partition-name |
| 19 |
:end-before: endblob partition-name |
| 20 |
|
| 21 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 22 |
:start-after: startblob defaultpartition |
| 23 |
:end-before: endblob defaultpartition |
| 24 |
|
| 25 |
.. note:: |
| 26 |
|
| 27 |
There is nothing magical about the name "default" and in fact any |
| 28 |
name may be used for the default-partition. We'll use the name |
| 29 |
"main" in this documentation. |
| 30 |
|
| 31 |
* Sample:: |
| 32 |
|
| 33 |
defaultpartition: main |
| 34 |
partition-main: /var/spool/cyrus |
| 35 |
|
| 36 |
|
| 37 |
Additional Spool locations |
| 38 |
-------------------------- |
| 39 |
|
| 40 |
.. include:: /assets/mailspool-parts-explain.rst |
| 41 |
|
| 42 |
Metadata Partitions |
| 43 |
=================== |
| 44 |
|
| 45 |
.. include:: /assets/metadata-parts-explain.rst |
| 46 |
|
| 47 |
The configuration directives to do so are quite similar to |
| 48 |
those for data partitions: |
| 49 |
|
| 50 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 51 |
:start-after: startblob metapartition_files |
| 52 |
:end-before: endblob metapartition_files |
| 53 |
|
| 54 |
.. include:: /imap/reference/manpages/configs/imapd.conf.rst |
| 55 |
:start-after: startblob metapartition-name |
| 56 |
:end-before: endblob metapartition-name |
| 57 |
|
| 58 |
Again, building on our examples above: |
| 59 |
|
| 60 |
* Sample:: |
| 61 |
|
| 62 |
defaultpartition: main |
| 63 |
partition-main: /var/spool/cyrus |
| 64 |
partition-am: /var/spool/cyrus-am |
| 65 |
partition-nz: /var/spool/cyrus-nz |
| 66 |
partition-shared: /var/spool/cyrus-shared |
| 67 |
metapartition_files: header index cache expunge squat annotations |
| 68 |
metapartition-main: /var/spool/cyrusmeta/main |
| 69 |
metapartition-am: /var/spool/cyrusmeta/am |
| 70 |
metapartition-nz: /var/spool/cyrusmeta/nz |
| 71 |
metapartition-shared: /var/spool/cyrusmeta/shared |