Debian Codegraph @

doc/html/_sources/imap/reference/manpages/configs/imapd.conf.rst.txt

raw
1 .. auto-generated by config2rst 1.6 on framework
2
3
4 .. cyrusman:: imapd.conf(5)
5
6 .. _imap-reference-manpages-configs-imapd.conf:
7
8 ==============
9 **imapd.conf**
10 ==============
11
12
13
14
15
16
17
18
19
20 IMAP configuration file
21
22 DESCRIPTION
23 ===========
24
25 **/etc/imapd.conf**
26 is the configuration file for the Cyrus IMAP server. It defines
27 local parameters for IMAP.
28
29 Each line of the **/etc/imapd.conf** file has the form
30 *option*: *value*
31
32 where *option* is the name of the configuration option being set
33 and *value* is the value that the configuration option is being
34 set to.
35
36 Although there is no limit to the length of a line, a \`\`\\''
37 (backslash) character may be used as the last character on a line to
38 force it to continue on the next one. No additional whitespace is
39 inserted before or after the \`\`\\''. Note that a line that is split
40 using \`\`\\'' character(s) is still considered a single line.
41
42 For example
43 *option*:\\
44
45 *value*\ 1 *value*\ 2 \\
46
47 *value*\ 3
48
49 is equivalent to
50 *option*: *value*\ 1 *value*\ 2 *value*\ 3
51
52 Blank lines and lines beginning with \`\`#'' are ignored.
53
54 For boolean and enumerated options, the values \`\`yes'', \`\`on'', \`\`t'',
55 \`\`true'' and \`\`\ 1'' turn the option on, the values \`\`no'', \`\`off'',
56 \`\`f'', \`\`false'' and \`\`\ 0'' turn the option off.
57
58 Duration options take the form of a number followed by a unit, for example
59 **\ 32m** (32 minutes). Units are **d** (days), **h** (hours), **m**
60 (minutes) and **s** (seconds). Multiple units can be combined and will
61 be summed together, for example **\ 1h30m** is equivalent to **\ 90m**. If
62 no unit is specified, an option-specific backward-compatible default unit
63 is assumed (documented on an option-by-option basis). These are simple time
64 units: 1d=24h, 1h=60m, 1m=60s (daylight savings, timezones, leap adjustments,
65 etc are not considered).
66
67 Byte size options take the form of a number followed by a unit, for example
68 **\ 1KiB** (1 kibibyte). Units are **B** (bytes), **KiB** (kibibytes),
69 **MiB** (mebibytes), and **GiB** (gibibytes), which may also be spelt
70 **KB**, **MB**, and **GB**. Units are parsed without regard to case.
71 Note that regardless of spelling, these units are always powers of 2, and
72 never metric. That is, 1GiB = 1024MiB, 1MiB = 1024KiB, 1KiB = 1024B. If no
73 unit is specified, an option-specific backward-compatible default unit is
74 assumed (documented on an option-by-option basis).
75
76 FIELD DESCRIPTIONS
77 ==================
78
79
80 The sections below detail options that can be placed in the
81 **/etc/imapd.conf** file, and show each option's default value.
82 Some options have no default value, these are listed with
83 \`\`<no default>''. Some options default to the empty string, these
84 are listed with \`\`<none>''.
85
86
87 .. startblob acl_admin_implies_write
88
89 ``acl_admin_implies_write:`` 0
90
91 If enabled, any user with the admin ACL on a mailbox implicitly
92 gets the ability to write to that mailbox as well.
93
94 .. endblob acl_admin_implies_write
95
96 .. startblob addressbookprefix
97
98 ``addressbookprefix:`` #addressbooks
99
100 The prefix for the addressbook mailboxes hierarchies. The hierarchy
101 delimiter will be automatically appended. The public addressbook
102 hierarchy will be at the toplevel of the shared namespace. A
103 user's personal addressbook hierarchy will be a child of their Inbox.
104
105 .. endblob addressbookprefix
106
107 .. startblob admins
108
109 ``admins:`` <empty string>
110
111 The list of userids with administrative rights. Separate each userid
112 with a space. Sites using Kerberos authentication may use
113 separate "admin" instances.
114
115 Note that accounts used by users should not be administrators.
116 Administrative accounts should not receive mail. That is, if user
117 "jbRo" is a user reading mail, he should not also be in the admins line.
118 Some problems may occur otherwise, most notably the ability of
119 administrators to create top-level mailboxes visible to users,
120 but not writable by users.
121
122 .. endblob admins
123
124 .. startblob afspts_localrealms
125
126 ``afspts_localrealms:`` <none>
127
128 The list of realms which are to be treated as local, and thus stripped
129 during identifier canonicalization (for the AFSPTS ptloader module).
130 This is different from loginrealms in that it occurs later in the
131 authorization process (as the user id is canonified for PTS lookup).
132
133 .. endblob afspts_localrealms
134
135 .. startblob afspts_mycell
136
137 ``afspts_mycell:`` <none>
138
139 Cell to use for AFS PTS lookups. Defaults to the local cell.
140
141
142 .. endblob afspts_mycell
143
144 .. startblob allowallsubscribe
145
146 ``allowallsubscribe:`` 0
147
148 Allow subscription to nonexistent mailboxes. This option is
149 typically used on backend servers in a Murder so that users can
150 subscribe to mailboxes that don't reside on their "home" server.
151 This option can also be used as a workaround for IMAP clients which
152 don't play well with nonexistent or unselectable mailboxes (e.g.,
153 Microsoft Outlook).
154
155 .. endblob allowallsubscribe
156
157 .. startblob allowanonymouslogin
158
159 ``allowanonymouslogin:`` 0
160
161 Permit logins by the user "anonymous" using any password. Also
162 allows use of the SASL ANONYMOUS mechanism.
163
164 .. endblob allowanonymouslogin
165
166 .. startblob allowapop
167
168 ``allowapop:`` 1
169
170 Allow use of the POP3 APOP authentication command.
171
172 Note that this command requires that SASL is compiled with APOP
173 support, that the plaintext passwords are available in a SASL auxprop
174 backend (e.g., sasldb), and that the system can provide enough entropy
175 (e.g., from /dev/urandom) to create a challenge in the banner.
176
177 .. endblob allowapop
178
179 .. startblob allowdeleted
180
181 ``allowdeleted:`` 0
182
183 Allow access to deleted and expunged data via vendor.cmu-\* access.
184
185
186 .. endblob allowdeleted
187
188 .. startblob allownewnews
189
190 ``allownewnews:`` 0
191
192 Allow use of the NNTP NEWNEWS command.
193
194 Note that this is a very expensive command and should only be
195 enabled when absolutely necessary.
196
197 .. endblob allownewnews
198
199 .. startblob allowplaintext
200
201 ``allowplaintext:`` 0
202
203 If enabled, allows the use of cleartext passwords on the wire.
204
205 By default, the use of cleartext passwords requires a TLS/SSL
206 encryption layer to be negotiated prior to any cleartext
207 authentication mechanisms being advertised or allowed. To require a
208 TLS/SSL encryption layer to be negotiated prior to ANY
209 authentication, see the *tls_required* option.
210
211 .. endblob allowplaintext
212
213 .. startblob allowsetacl
214
215 ``allowsetacl:`` 1
216
217 Defaults to enabled. If disabled, disallows the use of the SETACL
218 command at all via IMAP.
219
220 .. endblob allowsetacl
221
222 .. startblob allowspecialusesubfolder
223
224 ``allowspecialusesubfolder:`` 0
225
226 If enabled, allows special-use folders to be moved into subfolders
227
228 By default, cyrus does not allow a special-use folder to be moved or
229 renamed if the new folder is not a direct folder of the users INBOX.
230 This was implemented to prevent clients renaming Sent to Trash/Sent,
231 which would confused other clients.
232
233 .. endblob allowspecialusesubfolder
234
235 .. startblob allowstarttls
236
237 ``allowstarttls:`` 0
238
239 If enabled, allows upgrading a plaintext connection to use TLS
240 (a.k.a opportunistic TLS) via a protocol specific
241 command/mechanism. IMAP, LMTP, NNTP, and ManageSieve use the
242 STARTTLS command. POP3 uses the STLS command. HTTP uses the
243 Upgrade header field.
244
245 .. endblob allowstarttls
246
247 .. startblob allowusermoves
248
249 ``allowusermoves:`` 0
250
251 Allow moving user accounts (with associated meta-data) via RENAME
252 or XFER.
253
254 Note that measures should be taken to make sure that the user being
255 moved is not logged in, and cannot login during the move. Failure
256 to do so may result in the user's meta-data (seen state,
257 subscriptions, etc) being corrupted or out of date.
258
259 .. endblob allowusermoves
260
261 .. startblob altnamespace
262
263 ``altnamespace:`` 1
264
265 Use the alternate IMAP namespace, where personal folders reside at the
266 same level in the hierarchy as INBOX.
267
268 This option ONLY applies where interaction takes place with the
269 client/user. Currently this is limited to the IMAP protocol (imapd)
270 and Sieve scripts (lmtpd). This option does NOT apply to admin tools
271 such as cyradm (admins ONLY), reconstruct, quota, etc., NOR does it
272 affect LMTP delivery of messages directly to mailboxes via
273 plus-addressing. The default changed in 3.0 from off to on.
274
275 .. endblob altnamespace
276
277 .. startblob altprefix
278
279 ``altprefix:`` Alt Folders
280
281 Alternative INBOX spellings that can't be accessed in altnamespace
282 otherwise go under here.
283
284 .. endblob altprefix
285
286 .. startblob annotation_db
287
288 ``annotation_db:`` twoskip
289
290 The cyrusdb backend to use for mailbox annotations.
291
292 Allowed values: *skiplist*, *twoskip*, *zeroskip*
293
294
295 .. endblob annotation_db
296
297 .. startblob annotation_db_path
298
299 ``annotation_db_path:`` <none>
300
301 The absolute path to the annotations db file. If not specified,
302 will be configdirectory/annotations.db
303
304 .. endblob annotation_db_path
305
306 .. startblob anyoneuseracl
307
308 ``anyoneuseracl:`` 1
309
310 Should non-admin users be allowed to set ACLs for the 'anyone'
311 user on their mailboxes? In a large organization this can cause
312 support problems, but it's enabled by default.
313
314 .. endblob anyoneuseracl
315
316 .. startblob annotation_allow_undefined
317
318 ``annotation_allow_undefined:`` 0
319
320 Allow clients to store values for entries which are not
321 defined either by Cyrus or in the annotations_definitions
322 file.
323
324 .. endblob annotation_allow_undefined
325
326 .. startblob annotation_definitions
327
328 ``annotation_definitions:`` <none>
329
330 File containing external (third-party) annotation definitions.
331
332 Each line of the file specifies the properties of an annotation and
333 has the following form:
334
335 *name*, *scope*, *attrib-type*, *proxy-type*,
336 *attrib-names*, *acl*
337
338 *name*
339 is the hierarchical name as in :rfc:`5257` or :rfc:`5464` (in the latter case,
340 without the leading **/shared** or **/private**). For example,
341 /vendor/acme/blurdybloop.
342
343 *scope*
344 specifies whether the annotation is for the **server**, a
345 **mailbox**, or a **message**.
346
347 *attrib-type*
348 specifies the attribute data type, which is used only to check the
349 string value passed by clients when setting annotations. The
350 *attrib-type* is one of:
351
352 **string**
353 any value is accepted.
354
355 **content-type**
356 this obsolete data type, which was useful for early drafts of the standard,
357 is accepted but silently translated to **string**.
358
359 **boolean**
360 only the strings "true" or "false" are accepted. Checking is
361 case-insensitive but the value is forced to lowercase.
362
363 **int**
364 integers are accepted.
365
366 **uint**
367 non-negative integers are accepted.
368
369
370 *proxy-type*
371 specifies whether this attribute is for the **backend** or
372 **proxy** servers or both (**proxy_and_backend**)
373
374 *attrib-names*
375 is the space-separated list of available attributes for the
376 annotation. Possible attribute names are **value.shared**,
377 **value.priv**, and **value** (which permits both **value.priv**
378 and **value.shared**). The attribute names **size**,
379 **size.shared**, and **size.priv** are accepted but ignored; these
380 attributes are automatically provided by the server if the corresponding
381 **value** attribute is specified. Some obsolete attributes, which were
382 defined early drafts of the standard, are accepted and ignored with a
383 warning.
384
385 *extra-permissions*
386 is the extra ACL permission bits required for setting this annotation, in
387 standard IMAP ACL permission bit string format. Note that this is
388 in addition to the permission bits specified in :rfc:`5257` and :rfc:`5464`,
389 so leaving this field empty is harmless. Note also that there is no way
390 to specify that an annotation can only be set by an admin user; in
391 particular the **a** permission bit does not achieve this.
392
393 Blank lines and lines beginning with \`\`#'' are ignored.
394
395
396 .. endblob annotation_definitions
397
398 .. startblob annotation_callout
399
400 ``annotation_callout:`` <none>
401
402 The pathname of a callout to be used to automatically add annotations
403 or flags to a message when it is appended to a mailbox. The path can
404 be either an executable (including a script), or a UNIX domain
405 socket.
406
407 .. endblob annotation_callout
408
409 .. startblob annotation_callout_disable_append
410
411 ``annotation_callout_disable_append:`` 0
412
413 Disables annotations on append with xrunannotator.
414
415
416 .. endblob annotation_callout_disable_append
417
418 .. startblob annotation_enable_legacy_commands
419
420 ``annotation_enable_legacy_commands:`` 0
421
422 Whether to enable the legacy GETANNOTATION/SETANNOTATION commands.
423 These commands are deprecated and will be removed in the future,
424 but might be useful in the meantime for supporting old clients that
425 do not implement the :rfc:`5464` IMAP METADATA extension.
426
427 .. endblob annotation_enable_legacy_commands
428
429 .. startblob aps_topic
430
431 ``aps_topic:`` <none>
432
433 Topic for Apple Push Service registration.
434
435
436 .. endblob aps_topic
437
438 .. startblob aps_topic_caldav
439
440 ``aps_topic_caldav:`` <none>
441
442 Topic for Apple Push Service registration for CalDAV.
443
444
445 .. endblob aps_topic_caldav
446
447 .. startblob aps_topic_carddav
448
449 ``aps_topic_carddav:`` <none>
450
451 Topic for Apple Push Service registration for CardDAV.
452
453
454 .. endblob aps_topic_carddav
455
456 .. startblob aps_expiry
457
458 ``aps_expiry:`` 1d
459
460 Time after which a CalDAV/CardDAV push subscription will expire.
461 A client will have to refresh the subscription in order to continue to
462 receive push notifications.
463
464 .. endblob aps_expiry
465
466 .. startblob archive_enabled
467
468 ``archive_enabled:`` 0
469
470 Is archiving enabled for this server. You also need to have an
471 archivepartition for the mailbox. Archiving allows older email
472 to be stored on slower, cheaper disks - even within the same
473 mailbox, as distinct from partitions.
474
475 .. endblob archive_enabled
476
477 .. startblob archive_days
478
479 ``archive_days:`` <none>
480
481 Deprecated in favour of *archive_after*.
482
483
484 .. endblob archive_days
485
486 .. startblob archive_after
487
488 ``archive_after:`` 7d
489
490 The duration after which to move messages to the archive partition
491 if archiving is enabled.
492
493 For backward compatibility, if no unit is specified, days is
494 assumed.
495
496 .. endblob archive_after
497
498 .. startblob archive_maxsize
499
500 ``archive_maxsize:`` 1024 K
501
502 The size of the largest message that won't be archived immediately.
503
504 For backward compatibility, if no unit is specified, kibibytes is
505 assumed.
506
507 .. endblob archive_maxsize
508
509 .. startblob archive_keepflagged
510
511 ``archive_keepflagged:`` 0
512
513 If set, messages with the \\Flagged system flag won't be archived,
514 provided they are smaller than **archive_maxsize**.
515
516 .. endblob archive_keepflagged
517
518 .. startblob archivepartition-name
519
520 ``archivepartition-name:`` <none>
521
522 The pathname of the archive partition *name*, corresponding to
523 spool partition **partition-name**. For any mailbox residing in
524 a directory on **partition-name**, the archived messages will be
525 stored in a corresponding directory on **archivepartition-name**.
526 Note that not every **partition-name** option is strictly required
527 to have a corresponding **archivepartition-name** option, but that
528 without one there's no benefit to enabling archiving.
529
530 .. endblob archivepartition-name
531
532 .. startblob auditlog
533
534 ``auditlog:`` 0
535
536 Should cyrus output log entries for every action taken on a message
537 file or mailboxes list entry? It's noisy so disabled by default, but
538 can be very useful for tracking down what happened if things look strange.
539
540 .. endblob auditlog
541
542 .. startblob auth_mech
543
544 ``auth_mech:`` unix
545
546 The authorization mechanism to use.
547
548 Allowed values: *unix*, *pts*, *krb5*, *mboxgroups*
549
550
551 .. endblob auth_mech
552
553 .. startblob autocreateinboxfolders
554
555 ``autocreateinboxfolders:`` <none>
556
557 Deprecated in favor of *autocreate_inbox_folders*.
558
559
560 .. endblob autocreateinboxfolders
561
562 .. startblob autocreatequota
563
564 ``autocreatequota:`` <none>
565
566 Deprecated in favor of *autocreate_quota*.
567
568
569 .. endblob autocreatequota
570
571 .. startblob autocreatequotamsg
572
573 ``autocreatequotamsg:`` -1
574
575 Deprecated in favor of *autocreate_quota_messages*.
576
577
578 .. endblob autocreatequotamsg
579
580 .. startblob autosievefolders
581
582 ``autosievefolders:`` <none>
583
584 Deprecated in favor of *autocreate_sieve_folders*.
585
586
587 .. endblob autosievefolders
588
589 .. startblob generate_compiled_sieve_script
590
591 ``generate_compiled_sieve_script:`` 0
592
593 Deprecated in favor of *autocreate_sieve_script_compile*.
594
595
596 .. endblob generate_compiled_sieve_script
597
598 .. startblob autocreate_sieve_compiled_script
599
600 ``autocreate_sieve_compiled_script:`` <none>
601
602 Deprecated in favor of *autocreate_sieve_script_compiled*.
603
604
605 .. endblob autocreate_sieve_compiled_script
606
607 .. startblob autosubscribeinboxfolders
608
609 ``autosubscribeinboxfolders:`` <none>
610
611 Deprecated in favor of *autocreate_subscribe_folders*.
612
613
614 .. endblob autosubscribeinboxfolders
615
616 .. startblob autosubscribesharedfolders
617
618 ``autosubscribesharedfolders:`` <none>
619
620 Deprecated in favor of *autocreate_subscribe_sharedfolders*.
621
622
623 .. endblob autosubscribesharedfolders
624
625 .. startblob autosubscribe_all_sharedfolders
626
627 ``autosubscribe_all_sharedfolders:`` 0
628
629 Deprecated in favor of *autocreate_subscribe_sharedfolders_all*.
630
631
632 .. endblob autosubscribe_all_sharedfolders
633
634 .. startblob autocreate_acl
635
636 ``autocreate_acl:`` <none>
637
638 If folders are to be created by *autocreate_inbox_folders*, this
639 setting can be used to apply additional ACLs to the autocreated
640 folders. The syntax is "autocreate_acl folder identifier rights",
641 where *folder* must match one of the *autocreate_inbox_folders*
642 folders, *identifier* must be a valid cyrus identifier, and
643 *rights* must be a valid cyrus rights string. Multiple
644 identifier|rights pairs can be assigned to a single folder by providing
645 this setting multiple times.
646
647 For example, "autocreate_acl Plus anyone p" would allow lmtp delivery
648 to a folder named "Plus".
649
650
651 .. endblob autocreate_acl
652
653 .. startblob autocreate_inbox_folders
654
655 ``autocreate_inbox_folders:`` <none>
656
657 If a user does not have an INBOX already, and the INBOX is to be
658 created, create the list of folders in this setting as well.
659 *autocreate_inbox_folders* is a list of INBOX's subfolders
660 separated by a "|", that are automatically created by the server
661 under the following two scenarios. Leading and trailing whitespace is
662 stripped, so "Junk | Trash" results in two folders: "Junk" and
663 "Trash". See also the *xlist-flag* option, for setting
664 special-use flags on autocreated folders.
665
666 INBOX folders are created under both the following conditions:
667
668 1.
669 The user logins via the IMAP or the POP3 protocol.
670 *autocreate_quota* option must have a value of zero or greater.
671
672 2.
673 A message arrives for the user through the *lmtpd(8)*.
674 *autocreate_post* option must be enabled.
675
676
677
678 .. endblob autocreate_inbox_folders
679
680 .. startblob autocreate_post
681
682 ``autocreate_post:`` 0
683
684 If enabled, when *lmtpd(8)* receives an incoming mail for an
685 INBOX that does not exist, then the INBOX is automatically created
686 by *lmtpd(8)* and delivery of the message continues.
687
688 .. endblob autocreate_post
689
690 .. startblob autocreate_quota
691
692 ``autocreate_quota:`` -1
693
694 If set to a value of zero or higher, users have their INBOX folders
695 created upon a successful login event or upon *lmtpd(8)*
696 message delivery if *autocreate_post* is enabled, provided their
697 INBOX did not yet already exist.
698
699 The user's quota is set to the value if it is greater than zero,
700 otherwise the user has unlimited quota.
701
702 Note that quota has kibibyte granularity. Values specified here will
703 be truncated to the nearest whole kibibyte.
704
705 For backward compatibility, if no unit is specified, kibibytes is
706 assumed.
707
708 .. endblob autocreate_quota
709
710 .. startblob autocreate_quota_messages
711
712 ``autocreate_quota_messages:`` -1
713
714 If set to a value of zero or higher, users who have their INBOX
715 folders created upon a successful login event (see
716 *autocreate_quota*), or upon *lmtpd(8)* message delivery if
717 *autocreate_post* is enabled, receive the message quota
718 configured in this option.
719
720 The default of -1 disables assigning message quota.
721
722 For consistency with *autocreate_quota*, a value of zero is treated
723 as unlimited message quota, rather than a message quota of zero.
724
725 .. endblob autocreate_quota_messages
726
727 .. startblob autocreate_sieve_folders
728
729 ``autocreate_sieve_folders:`` <none>
730
731 A "|" separated list of subfolders of INBOX that will be
732 automatically created, if requested by a sieve filter, through the
733 "fileinto" action. The default is to create no folders
734 automatically.
735
736 Leading and trailing whitespace is stripped from each folder, so a
737 setting of "Junk | Trash" will create two folders: "Junk" and
738 "Trash".
739
740 .. endblob autocreate_sieve_folders
741
742 .. startblob autocreate_sieve_script
743
744 ``autocreate_sieve_script:`` <none>
745
746 The full path of a file that contains a sieve script. This script
747 automatically becomes a user's initial default sieve filter script.
748
749 When this option is not defined, no default sieve filter is created.
750 The file must be readable by the Cyrus daemon.
751
752 .. endblob autocreate_sieve_script
753
754 .. startblob autocreate_sieve_script_compile
755
756 ``autocreate_sieve_script_compile:`` 0
757
758 If set to yes and no compiled sieve script file exists, the sieve script which is
759 compiled on the fly will be saved in the file name that autocreate_sieve_compiledscript
760 option points to. In order a compiled script to be generated, autocreate_sieve_script and
761 autocreate_sieve_compiledscript must have valid values.
762
763 .. endblob autocreate_sieve_script_compile
764
765 .. startblob autocreate_sieve_script_compiled
766
767 ``autocreate_sieve_script_compiled:`` <none>
768
769 The full path of a file that contains a compiled in bytecode sieve script. This script
770 automatically becomes a user's initial default sieve filter script. If this option is
771 not specified, or the filename doesn't exist then the script defined by
772 autocreate_sieve_script is compiled on the fly and installed as the user's default
773 sieve script.
774
775 .. endblob autocreate_sieve_script_compiled
776
777 .. startblob autocreate_subscribe_folders
778
779 ``autocreate_subscribe_folders:`` <none>
780
781 A list of folder names, separated by "|", that the users get automatically subscribed to,
782 when their INBOX is created. These folder names must have been included in the
783 autocreateinboxfolders option of the imapd.conf.
784
785 .. endblob autocreate_subscribe_folders
786
787 .. startblob autocreate_subscribe_sharedfolders
788
789 ``autocreate_subscribe_sharedfolders:`` <none>
790
791 A list of shared folders (bulletin boards), separated by "|", that the users get
792 automatically subscribed to, after their INBOX is created. The shared folder must
793 have been created and the user must have the required permissions to get subscribed
794 to it. Otherwise, subscribing to the shared folder fails.
795
796 .. endblob autocreate_subscribe_sharedfolders
797
798 .. startblob autocreate_subscribe_sharedfolders_all
799
800 ``autocreate_subscribe_sharedfolders_all:`` 0
801
802 If set to yes, the user is automatically subscribed to all shared folders, one has permission
803 to subscribe to.
804
805 .. endblob autocreate_subscribe_sharedfolders_all
806
807 .. startblob autocreate_users
808
809 ``autocreate_users:`` anyone
810
811 A space separated list of users and/or groups that are allowed their INBOX to be
812 automatically created.
813
814 .. endblob autocreate_users
815
816 .. startblob autoexpunge
817
818 ``autoexpunge:`` 0
819
820 If set to yes, then all \Deleted messages will be automatically expunged whenever
821 an index is closed, whether CLOSE, UNSELECT, SELECT or on disconnect.
822
823 .. endblob autoexpunge
824
825 .. startblob backuppartition-name
826
827 ``backuppartition-name:`` <none>
828
829 Deprecated. No longer used.
830
831
832 .. endblob backuppartition-name
833
834 .. startblob backup_compact_minsize
835
836 ``backup_compact_minsize:`` 0
837
838 Deprecated. No longer used.
839
840
841 .. endblob backup_compact_minsize
842
843 .. startblob backup_compact_maxsize
844
845 ``backup_compact_maxsize:`` 0
846
847 Deprecated. No longer used.
848
849
850 .. endblob backup_compact_maxsize
851
852 .. startblob backup_compact_work_threshold
853
854 ``backup_compact_work_threshold:`` 1
855
856 Deprecated. No longer used.
857
858
859 .. endblob backup_compact_work_threshold
860
861 .. startblob backup_staging_path
862
863 ``backup_staging_path:`` <none>
864
865 Deprecated. No longer used.
866
867
868 .. endblob backup_staging_path
869
870 .. startblob backup_retention_days
871
872 ``backup_retention_days:`` <none>
873
874 Deprecated. No longer used.
875
876
877 .. endblob backup_retention_days
878
879 .. startblob backup_retention
880
881 ``backup_retention:`` 7d
882
883 Deprecated. No longer used.
884
885
886 .. endblob backup_retention
887
888 .. startblob backup_db
889
890 ``backup_db:`` twoskip
891
892 Deprecated. No longer used.
893
894
895 .. endblob backup_db
896
897 .. startblob backup_db_path
898
899 ``backup_db_path:`` <none>
900
901 Deprecated. No longer used.
902
903
904 .. endblob backup_db_path
905
906 .. startblob backup_keep_previous
907
908 ``backup_keep_previous:`` 0
909
910 Deprecated. No longer used.
911
912
913 .. endblob backup_keep_previous
914
915 .. startblob boundary_limit
916
917 ``boundary_limit:`` 1000
918
919 messages are parsed recursively and a deep enough MIME structure
920 can cause a stack overflow. Do not parse deeper than this many
921 layers of MIME structure. The default of 1000 is much higher
922 than any sane message should have.
923
924 .. endblob boundary_limit
925
926 .. startblob caldav_accept_invalid_rrules
927
928 ``caldav_accept_invalid_rrules:`` 0
929
930 Accept invalid RRULEs (e.g. FREQ=WEEKLY;BYMONTHDAY=15)
931 rather than rejecting them as errors.
932
933 .. endblob caldav_accept_invalid_rrules
934
935 .. startblob caldav_alarm_db_path
936
937 ``caldav_alarm_db_path:`` <none>
938
939 Path to the caldav_alarm database file - defaults to
940 $confdir/caldav_alarm.sqlite3 if not set
941
942 .. endblob caldav_alarm_db_path
943
944 .. startblob caldav_alarm_support_components
945
946 ``caldav_alarm_support_components:`` VEVENT VTODO
947
948 Space-separated list of iCalendar component types for which
949 calalarmd generates alarms.
950 Allowed values: *VEVENT*, *VTODO*
951
952
953 .. endblob caldav_alarm_support_components
954
955 .. startblob caldav_alarm_suppress_file
956
957 ``caldav_alarm_suppress_file:`` <none>
958
959 If this file exists, calalarmd will not process events
960
961
962 .. endblob caldav_alarm_suppress_file
963
964 .. startblob caldav_allowattach
965
966 ``caldav_allowattach:`` 1
967
968 Enable managed attachments support on the CalDAV server.
969
970
971 .. endblob caldav_allowattach
972
973 .. startblob caldav_allowcalendaradmin
974
975 ``caldav_allowcalendaradmin:`` 0
976
977 Enable per-user calendar administration web UI on the CalDAV server.
978
979
980 .. endblob caldav_allowcalendaradmin
981
982 .. startblob caldav_allowscheduling
983
984 ``caldav_allowscheduling:`` on
985
986 Enable calendar scheduling operations. If set to "apple", the
987 server will emulate Apple CalendarServer behavior as closely as
988 possible.
989 Allowed values: *off*, *on*, *apple*
990
991
992 .. endblob caldav_allowscheduling
993
994 .. startblob caldav_create_attach
995
996 ``caldav_create_attach:`` 1
997
998 Create the 'Attachments' collection if it doesn't already exist.
999
1000
1001 .. endblob caldav_create_attach
1002
1003 .. startblob caldav_create_default
1004
1005 ``caldav_create_default:`` 1
1006
1007 Create the 'Default' calendar if it doesn't already exist.
1008
1009
1010 .. endblob caldav_create_default
1011
1012 .. startblob caldav_create_sched
1013
1014 ``caldav_create_sched:`` 1
1015
1016 Create the 'Inbox' and 'Outbox' calendars if they don't already exist.
1017
1018
1019 .. endblob caldav_create_sched
1020
1021 .. startblob caldav_historical_age
1022
1023 ``caldav_historical_age:`` 7d
1024
1025 How long after an occurrence of event or task has concluded
1026 that it is considered 'historical'. Changes to historical
1027 occurrences of events or tasks WILL NOT have invite or reply
1028 messages sent for them. A negative value means that events
1029 and tasks are NEVER considered historical.
1030
1031 For backward compatibility, if no unit is specified, days is
1032 assumed.
1033
1034 .. endblob caldav_historical_age
1035
1036 .. startblob caldav_maxdatetime
1037
1038 ``caldav_maxdatetime:`` 20380119T031407Z
1039
1040 The latest date and time accepted by the server (ISO format). This
1041 value is also used for expanding non-terminating recurrence rules.
1042
1043 Note that increasing this value will require the DAV databases for
1044 calendars to be reconstructed with the **dav_reconstruct**
1045 utility in order to see its effect on serer-side time-based
1046 queries.
1047
1048 .. endblob caldav_maxdatetime
1049
1050 .. startblob caldav_mindatetime
1051
1052 ``caldav_mindatetime:`` 19011213T204552Z
1053
1054 The earliest date and time accepted by the server (ISO format).
1055
1056
1057 .. endblob caldav_mindatetime
1058
1059 .. startblob caldav_realm
1060
1061 ``caldav_realm:`` <none>
1062
1063 The realm to present for HTTP authentication of CalDAV resources.
1064 If not set (the default), the value of the "servername" option will
1065 be used.
1066
1067 .. endblob caldav_realm
1068
1069 .. startblob calendarprefix
1070
1071 ``calendarprefix:`` #calendars
1072
1073 The prefix for the calendar mailboxes hierarchies. The hierarchy
1074 delimiter will be automatically appended. The public calendar
1075 hierarchy will be at the toplevel of the shared namespace. A
1076 user's personal calendar hierarchy will be a child of their Inbox.
1077
1078 .. endblob calendarprefix
1079
1080 .. startblob calendar_default_displayname
1081
1082 ``calendar_default_displayname:`` personal
1083
1084 The displayname to be used when creating a user's 'Default' calendar.
1085
1086
1087 .. endblob calendar_default_displayname
1088
1089 .. startblob calendar_user_address_set
1090
1091 ``calendar_user_address_set:`` <none>
1092
1093 Space-separated list of domains corresponding to calendar user
1094 addresses for which the server is responsible. If not set (the
1095 default), the value of the "defaultdomain" option will be used.
1096
1097 .. endblob calendar_user_address_set
1098
1099 .. startblob calendar_component_set
1100
1101 ``calendar_component_set:`` VEVENT VTODO VJOURNAL VFREEBUSY VAVAILABILITY VPOLL
1102
1103 Space-separated list of iCalendar component types that calendar
1104 object resources may contain in a calendar collection.
1105 This restriction is only set at calendar creation time and only
1106 if the CalDAV client hasn't specified a restriction in the creation
1107 request.
1108 Allowed values: *VEVENT*, *VTODO*, *VJOURNAL*, *VFREEBUSY*, *VAVAILABILITY*, *VPOLL*
1109
1110
1111 .. endblob calendar_component_set
1112
1113 .. startblob calendar_minimum_alarm_interval
1114
1115 ``calendar_minimum_alarm_interval:`` 5m
1116
1117 The minimum allowed interval between alarms for a recurring event.
1118 Primarily used to suppress alarms for MINUTELY and SECONDLY recurrences.
1119 The minimum value is 0, which will allow all alarms.
1120
1121 .. endblob calendar_minimum_alarm_interval
1122
1123 .. startblob calendar_suppress_duplicate_alarms
1124
1125 ``calendar_suppress_duplicate_alarms:`` 1
1126
1127 Suppress duplicate calendar alarms in calalarmd. If this is set,
1128 then at most one alarm notification is sent for any given alarm
1129 action, point in time and calendar event.
1130
1131 .. endblob calendar_suppress_duplicate_alarms
1132
1133 .. startblob carddav_allowaddmember
1134
1135 ``carddav_allowaddmember:`` 0
1136
1137 Enable support for POST add-member on the CardDAV server.
1138
1139
1140 .. endblob carddav_allowaddmember
1141
1142 .. startblob carddav_allowaddressbookadmin
1143
1144 ``carddav_allowaddressbookadmin:`` 0
1145
1146 Enable per-user addressbook administration web UI on the CardDAV server.
1147
1148
1149 .. endblob carddav_allowaddressbookadmin
1150
1151 .. startblob carddav_realm
1152
1153 ``carddav_realm:`` <none>
1154
1155 The realm to present for HTTP authentication of CardDAV resources.
1156 If not set (the default), the value of the "servername" option will
1157 be used.
1158
1159 .. endblob carddav_realm
1160
1161 .. startblob carddav_repair_vcard
1162
1163 ``carddav_repair_vcard:`` 0
1164
1165 If enabled, VCARDs with invalid content are attempted to be repaired
1166 during creation.
1167
1168 .. endblob carddav_repair_vcard
1169
1170 .. startblob chatty
1171
1172 ``chatty:`` 0
1173
1174 If yes, syslog tags and commands for every IMAP command, mailboxes
1175 for every LMTP connection, every POP3 command, etc.
1176
1177 .. endblob chatty
1178
1179 .. startblob client_bind
1180
1181 ``client_bind:`` 0
1182
1183 If enabled, a specific IP will be bound when performing a client
1184 connection. **client_bind_name** is used if it is set, otherwise
1185 **servername** is used. This is useful on multi-homed servers where
1186 Cyrus should not use other services' interfaces.
1187
1188 If not enabled (the default), no bind will be performed. Client
1189 connections will use an IP chosen by the operating system.
1190
1191 .. endblob client_bind
1192
1193 .. startblob client_bind_name
1194
1195 ``client_bind_name:`` <none>
1196
1197 IPv4, IPv6 address or hostname to bind for client connections when
1198 **client_bind** is enabled. If not set (the default),
1199 servername will be used.
1200
1201 .. endblob client_bind_name
1202
1203 .. startblob client_timeout
1204
1205 ``client_timeout:`` 10s
1206
1207 Time to wait before returning a timeout failure when performing a
1208 client connection (e.g. in a murder environment).
1209
1210 For backward compatibility, if no unit is specified, seconds is
1211 assumed.
1212
1213 .. endblob client_timeout
1214
1215 .. startblob commandmintimer
1216
1217 ``commandmintimer:`` <none>
1218
1219 Time in floating point seconds. Any imap command that takes longer than
1220 this time is logged.
1221
1222 .. endblob commandmintimer
1223
1224 .. startblob configdirectory
1225
1226 ``configdirectory:`` <none>
1227
1228 The pathname of the IMAP configuration directory. This field is
1229 required.
1230
1231 .. endblob configdirectory
1232
1233 .. startblob createonpost
1234
1235 ``createonpost:`` 0
1236
1237 Deprecated in favor of *autocreate_post*.
1238
1239
1240 .. endblob createonpost
1241
1242 .. startblob conversations
1243
1244 ``conversations:`` 0
1245
1246 Enable the XCONVERSATIONS extensions. Extract conversation
1247 tracking information from incoming messages and track them
1248 in per-user databases.
1249
1250 .. endblob conversations
1251
1252 .. startblob conversations_counted_flags
1253
1254 ``conversations_counted_flags:`` <none>
1255
1256 space-separated list of flags for which per-conversation counts
1257 will be kept. Note that you need to reconstruct the conversations
1258 database with ctl_conversationsdb if you change this option on a
1259 running server, or the counts will be wrong.
1260
1261 .. endblob conversations_counted_flags
1262
1263 .. startblob conversations_db
1264
1265 ``conversations_db:`` skiplist
1266
1267 The cyrusdb backend to use for the per-user conversations database.
1268
1269 Allowed values: *skiplist*, *sql*, *twoskip*, *zeroskip*
1270
1271
1272 .. endblob conversations_db
1273
1274 .. startblob conversations_expire_days
1275
1276 ``conversations_expire_days:`` <none>
1277
1278 Deprecated in favor of *conversations_expire_after*.
1279
1280
1281 .. endblob conversations_expire_days
1282
1283 .. startblob conversations_expire_after
1284
1285 ``conversations_expire_after:`` 90d
1286
1287 How long the conversations database keeps the message tracking
1288 information needed for receiving new messages in existing
1289 conversations.
1290
1291 For backward compatibility, if no unit is specified, days is
1292 assumed.
1293
1294 .. endblob conversations_expire_after
1295
1296 .. startblob conversations_keep_existing
1297
1298 ``conversations_keep_existing:`` 1
1299
1300 During conversations cleanup, don't clean up if there are still existing emails
1301 with one of the mentioned CIDs.
1302
1303 .. endblob conversations_keep_existing
1304
1305 .. startblob conversations_max_thread
1306
1307 ``conversations_max_thread:`` 100
1308
1309 maximum size for a single thread. Threads will split if they have this many
1310 messages in them and another message arrives.
1311
1312 .. endblob conversations_max_thread
1313
1314 .. startblob conversations_max_guidrecords
1315
1316 ``conversations_max_guidrecords:`` 5000
1317
1318 maximum records with the same guid. This is just a sanity check to stop the same
1319 email being added and removed over and over.
1320
1321 .. endblob conversations_max_guidrecords
1322
1323 .. startblob conversations_max_guidexists
1324
1325 ``conversations_max_guidexists:`` 100
1326
1327 maximum records with the same guid. This maps to "labels", so with the default
1328 of 100, you can only have 100 labels on an email in JMAP.
1329
1330 .. endblob conversations_max_guidexists
1331
1332 .. startblob conversations_max_guidinfolder
1333
1334 ``conversations_max_guidinfolder:`` 10
1335
1336 maximum records with the same guid in the same folder. You can't do this via JMAP,
1337 but could via IMAP. The default of 10 should be heaps normally!
1338
1339 .. endblob conversations_max_guidinfolder
1340
1341 .. startblob crossdomains
1342
1343 ``crossdomains:`` 0
1344
1345 Enable cross domain sharing. This works best with alt namespace and
1346 unix hierarchy separators on, so you get Other Users/[email protected]/...
1347
1348 .. endblob crossdomains
1349
1350 .. startblob crossdomains_onlyother
1351
1352 ``crossdomains_onlyother:`` 0
1353
1354 only show the domain for users in other domains than your own (for
1355 backwards compatibility if you're already sharing.
1356
1357 .. endblob crossdomains_onlyother
1358
1359 .. startblob cyrus_group
1360
1361 ``cyrus_group:`` <none>
1362
1363 The name of the group Cyrus services will run as. If not configured, the
1364 primary group of cyrus_user will be used. Can be further overridden by
1365 setting the $CYRUS_GROUP environment variable.
1366
1367 .. endblob cyrus_group
1368
1369 .. startblob cyrus_user
1370
1371 ``cyrus_user:`` <none>
1372
1373 The username to use as the 'cyrus' user. If not configured, the compile
1374 time default will be used. Can be further overridden by setting the
1375 $CYRUS_USER environment variable.
1376
1377 .. endblob cyrus_user
1378
1379 .. startblob davdriveprefix
1380
1381 ``davdriveprefix:`` #drive
1382
1383 The prefix for the DAV storage mailboxes hierarchies. The hierarchy
1384 delimiter will be automatically appended. The public storage
1385 hierarchy will be at the toplevel of the shared namespace. A
1386 user's personal storage hierarchy will be a child of their Inbox.
1387
1388 .. endblob davdriveprefix
1389
1390 .. startblob davnotificationsprefix
1391
1392 ``davnotificationsprefix:`` #notifications
1393
1394 The prefix for the DAV notifications hierarchy. The hierarchy
1395 delimiter will be automatically appended. The public notifications
1396 hierarchy will be at the toplevel of the shared namespace. A
1397 user's personal notifications hierarchy will be a child of their Inbox.
1398
1399 .. endblob davnotificationsprefix
1400
1401 .. startblob dav_realm
1402
1403 ``dav_realm:`` <none>
1404
1405 The realm to present for HTTP authentication of generic DAV
1406 resources (principals). If not set (the default), the value of the
1407 "servername" option will be used.
1408
1409 .. endblob dav_realm
1410
1411 .. startblob dav_lock_timeout
1412
1413 ``dav_lock_timeout:`` 20s
1414
1415 The maximum time to wait for a write lock on the per-user DAV database
1416 before timeout. For HTTP requests, the HTTP status code 503 is returned
1417 if the lock can not be obtained within this time.
1418
1419 For backward compatibility, if no unit is specified, seconds is
1420 assumed.
1421
1422 .. endblob dav_lock_timeout
1423
1424 .. startblob debug
1425
1426 ``debug:`` 0
1427
1428 If enabled, allow syslog() to pass LOG_DEBUG messages.
1429
1430 This can be toggled for a running process by sending it SIGUSR1.
1431
1432
1433 .. endblob debug
1434
1435 .. startblob debug_command
1436
1437 ``debug_command:`` <none>
1438
1439 Debug command to be used by processes started with -D option. The string
1440 is a C format string that gets 3 options: the first is the name of the
1441 executable (as specified in the cmd parameter in cyrus.conf). The second
1442 is the pid (integer) and the third is the service ID.
1443 Example: /usr/local/bin/gdb /usr/cyrus/bin/%s %d
1444
1445 .. endblob debug_command
1446
1447 .. startblob debug_log_sync_partition_choice
1448
1449 ``debug_log_sync_partition_choice:`` 0
1450
1451 If enabled, replication will log which partition it chose for staging.
1452 This is mainly useful for regression testing the sync_client -a switch.
1453
1454 .. endblob debug_log_sync_partition_choice
1455
1456 .. startblob debug_slowio
1457
1458 ``debug_slowio:`` 0
1459
1460 If enabled, I/O operations will be artificially slowed down. This option
1461 has no effect unless Cyrus was compiled with the --enable-debug-slowio
1462 configure argument. This is mainly useful for testing certain edge case
1463 handling.
1464
1465 .. endblob debug_slowio
1466
1467 .. startblob debug_writefail_guid
1468
1469 ``debug_writefail_guid:`` <none>
1470
1471 If set, any arriving message with this guid will fail as if the underlying
1472 disk write had failed, pretending to be a disk full condition. This is
1473 mainly useful for regression testing certain edge case handling.
1474 Currently only implemented for replication uploads.
1475
1476 .. endblob debug_writefail_guid
1477
1478 .. startblob defaultacl
1479
1480 ``defaultacl:`` anyone lrs
1481
1482 The Access Control List (ACL) placed on a newly-created (non-user)
1483 mailbox that does not have a parent mailbox.
1484
1485 .. endblob defaultacl
1486
1487 .. startblob defaultdomain
1488
1489 ``defaultdomain:`` internal
1490
1491 The default domain for virtual domain support.
1492
1493
1494 .. endblob defaultdomain
1495
1496 .. startblob defaultpartition
1497
1498 ``defaultpartition:`` <none>
1499
1500 The partition name used by default for new mailboxes. If not
1501 specified, the partition with the most free space will be used for
1502 new mailboxes.
1503
1504 Note that the partition specified by this option must also be
1505 specified as *partition-name*, where you substitute 'name'
1506 for the alphanumeric string you set *defaultpartition* to.
1507
1508 .. endblob defaultpartition
1509
1510 .. startblob defaultsearchtier
1511
1512 ``defaultsearchtier:`` <empty string>
1513
1514 Name of the default tier that messages will be indexed to. Search
1515 indexes can be organized in tiers to allow index storage in different
1516 directories and physical media. See the man page of squatter for
1517 details. The default search tier also requires the definition
1518 of an according *searchtierpartition-name* entry.
1519
1520 This option MUST be specified for xapian search.
1521
1522 .. endblob defaultsearchtier
1523
1524 .. startblob defaultserver
1525
1526 ``defaultserver:`` <none>
1527
1528 The backend server name used by default for new mailboxes. If not
1529 specified, the server with the most free space will be used for new
1530 mailboxes.
1531
1532 .. endblob defaultserver
1533
1534 .. startblob deletedprefix
1535
1536 ``deletedprefix:`` DELETED
1537
1538 With **delete_mode** set to *delayed*, the
1539 **deletedprefix** setting defines the prefix for the hierarchy of
1540 deleted mailboxes.
1541
1542 The hierarchy delimiter will be automatically appended.
1543
1544
1545 .. endblob deletedprefix
1546
1547 .. startblob delete_mode
1548
1549 ``delete_mode:`` delayed
1550
1551 The manner in which mailboxes are deleted. In the default
1552 *delayed* mode, mailboxes that are being deleted are renamed to
1553 a special mailbox hierarchy under the **deletedprefix**, to be
1554 removed later by **cyr_expire(8)**.
1555
1556 In *immediate* mode, the mailbox is removed from the filesystem
1557 immediately.
1558
1559 Allowed values: *immediate*, *delayed*
1560
1561
1562 .. endblob delete_mode
1563
1564 .. startblob delete_unsubscribe
1565
1566 ``delete_unsubscribe:`` 0
1567
1568 Whether to also unsubscribe from mailboxes when they are deleted.
1569 Note that this behaviour contravenes :rfc:`3501` section 6.3.9, but
1570 may be useful for avoiding user/client software confusion.
1571
1572 .. endblob delete_unsubscribe
1573
1574 .. startblob deleteright
1575
1576 ``deleteright:`` c
1577
1578 Deprecated - only used for backwards compatibility with existing
1579 installations. Lists the old :rfc:`2086` right which was used to
1580 grant the user the ability to delete a mailbox. If a user has this
1581 right, they will automatically be given the new 'x' right.
1582
1583 .. endblob deleteright
1584
1585 .. startblob disable_user_namespace
1586
1587 ``disable_user_namespace:`` 0
1588
1589 Preclude list command on user namespace. If set to 'yes', the
1590 LIST response will never include any other user's mailbox. Admin
1591 users will always see all mailboxes.
1592
1593 .. endblob disable_user_namespace
1594
1595 .. startblob disable_shared_namespace
1596
1597 ``disable_shared_namespace:`` 0
1598
1599 Preclude list command on shared namespace. If set to 'yes', the
1600 LIST response will never include any non-user mailboxes. Admin
1601 users will always see all mailboxes.
1602
1603 .. endblob disable_shared_namespace
1604
1605 .. startblob disconnect_on_vanished_mailbox
1606
1607 ``disconnect_on_vanished_mailbox:`` 0
1608
1609 If enabled, IMAP/POP3/NNTP clients will be disconnected by the
1610 server if the currently selected mailbox is (re)moved by another
1611 session. Otherwise, the missing mailbox is treated as empty while
1612 in use by the client.
1613
1614 .. endblob disconnect_on_vanished_mailbox
1615
1616 .. startblob ischedule_dkim_domain
1617
1618 ``ischedule_dkim_domain:`` <none>
1619
1620 The domain to be reported as doing iSchedule DKIM signing.
1621
1622
1623 .. endblob ischedule_dkim_domain
1624
1625 .. startblob ischedule_dkim_key_file
1626
1627 ``ischedule_dkim_key_file:`` <none>
1628
1629 File containing the private key for iSchedule DKIM signing.
1630
1631
1632 .. endblob ischedule_dkim_key_file
1633
1634 .. startblob ischedule_dkim_required
1635
1636 ``ischedule_dkim_required:`` 1
1637
1638 A DKIM signature is required on received iSchedule requests.
1639
1640
1641 .. endblob ischedule_dkim_required
1642
1643 .. startblob ischedule_dkim_selector
1644
1645 ``ischedule_dkim_selector:`` <none>
1646
1647 Name of the selector subdividing the domain namespace. This
1648 specifies the actual key used for iSchedule DKIM signing within the
1649 domain.
1650
1651 .. endblob ischedule_dkim_selector
1652
1653 .. startblob duplicate_db
1654
1655 ``duplicate_db:`` twoskip
1656
1657 The cyrusdb backend to use for the duplicate delivery suppression
1658 and sieve.
1659 Allowed values: *skiplist*, *sql*, *twoskip*, *zeroskip*
1660
1661
1662 .. endblob duplicate_db
1663
1664 .. startblob duplicate_db_path
1665
1666 ``duplicate_db_path:`` <none>
1667
1668 The absolute path to the duplicate db file. If not specified,
1669 will be configdirectory/deliver.db
1670
1671 .. endblob duplicate_db_path
1672
1673 .. startblob duplicatesuppression
1674
1675 ``duplicatesuppression:`` 1
1676
1677 If enabled, lmtpd will suppress delivery of a message to a mailbox if
1678 a message with the same message-id (or resent-message-id) is recorded
1679 as having already been delivered to the mailbox. Records the mailbox
1680 and message-id/resent-message-id of all successful deliveries.
1681
1682 .. endblob duplicatesuppression
1683
1684 .. startblob event_content_inclusion_mode
1685
1686 ``event_content_inclusion_mode:`` standard
1687
1688 The mode in which message content may be included with MessageAppend and
1689 MessageNew. "standard" mode is the default behavior in which message is
1690 included up to a size with the notification. In "message" mode, the message
1691 is included and may be truncated to a size. In "header" mode, it includes
1692 headers truncated to a size. In "body" mode, it includes body truncated
1693 to a size. In "headerbody" mode, it includes full headers and body truncated
1694 to a size.
1695 Allowed values: *standard*, *message*, *header*, *body*, *headerbody*
1696
1697
1698 .. endblob event_content_inclusion_mode
1699
1700 .. startblob event_content_size
1701
1702 ``event_content_size:`` 0
1703
1704 Truncate the message content that may be included with MessageAppend and
1705 MessageNew. Set 0 to include the entire message itself.
1706
1707 If no unit is specified, bytes is assumed.
1708
1709 .. endblob event_content_size
1710
1711 .. startblob event_exclude_flags
1712
1713 ``event_exclude_flags:`` <none>
1714
1715 Don't send event notification for given IMAP flag(s).
1716
1717
1718 .. endblob event_exclude_flags
1719
1720 .. startblob event_exclude_specialuse
1721
1722 ``event_exclude_specialuse:`` \\Junk
1723
1724 Don't send event notification for folder with given special-use attributes.
1725 Set ALL for any folder.
1726
1727 .. endblob event_exclude_specialuse
1728
1729 .. startblob event_extra_params
1730
1731 ``event_extra_params:`` timestamp
1732
1733 Space-separated list of extra parameters to add to any appropriated event.
1734
1735 Allowed values: *bodyStructure*, *clientAddress*, *diskUsed*, *flagNames*, *messageContent*, *messageSize*, *messages*, *modseq*, *service*, *timestamp*, *uidnext*, *vnd.cmu.midset*, *vnd.cmu.unseenMessages*, *vnd.cmu.envelope*, *vnd.cmu.sessionId*, *vnd.cmu.mailboxACL*, *vnd.cmu.mbtype*, *vnd.cmu.davFilename*, *vnd.cmu.davUid*, *vnd.fastmail.clientId*, *vnd.fastmail.sessionId*, *vnd.fastmail.convExists*, *vnd.fastmail.convUnseen*, *vnd.fastmail.cid*, *vnd.fastmail.counters*, *vnd.fastmail.jmapEmail*, *vnd.fastmail.jmapStates*, *vnd.cmu.emailid*, *vnd.cmu.threadid*, *vnd.cmu.visibleUsers*
1736
1737
1738 .. endblob event_extra_params
1739
1740 .. startblob event_groups
1741
1742 ``event_groups:`` message mailbox
1743
1744 Space-separated list of groups of related events to turn on notification.
1745
1746 Allowed values: *message*, *quota*, *flags*, *access*, *mailbox*, *subscription*, *calendar*, *applepushservice*, *jmap*
1747
1748
1749 .. endblob event_groups
1750
1751 .. startblob event_notifier
1752
1753 ``event_notifier:`` <none>
1754
1755 Notifyd(8) method to use for "EVENT" notifications which are based on
1756 the :rfc:`5423`. If not set, "EVENT" notifications are disabled.
1757
1758 .. endblob event_notifier
1759
1760 .. startblob expunge_mode
1761
1762 ``expunge_mode:`` delayed
1763
1764 The mode in which messages (and their corresponding cache entries)
1765 are expunged. "semidelayed" mode is the old behavior in which the
1766 message files are purged at the time of the EXPUNGE, but index
1767 and cache records are retained to facilitate QRESYNC.
1768 In "delayed" mode, which is the default since Cyrus 2.5.0,
1769 the message files are also retained, allowing unexpunge to
1770 rescue them. In "immediate" mode, both the message files and the
1771 index records are removed as soon as possible. In all cases,
1772 nothing will be finally purged until all other processes have
1773 closed the mailbox to ensure they never see data disappear under
1774 them. In "semidelayed" or "delayed" mode, a later run of "cyr_expire"
1775 will clean out the retained records (and possibly message files).
1776 This reduces the amount of I/O that takes place at the time of
1777 EXPUNGE and should result in greater responsiveness for the client,
1778 especially when expunging a large number of messages.
1779 Allowed values: *immediate*, *semidelayed*, *delayed*
1780
1781
1782 .. endblob expunge_mode
1783
1784 .. startblob failedloginpause
1785
1786 ``failedloginpause:`` 3s
1787
1788 Time to pause after a failed login.
1789
1790 For backward compatibility, if no unit is specified, seconds is
1791 assumed.
1792
1793 .. endblob failedloginpause
1794
1795 .. startblob fatals_abort
1796
1797 ``fatals_abort:`` 0
1798
1799 If enabled, when fatal errors are detected, Cyrus will call abort()
1800 to produce a core dump, unless the error was due to a misbehaving
1801 client. This is useful if you have the ability to debug a core dump.
1802
1803 If not enabled (the default), the process will exit normally with
1804 an error code.
1805
1806 .. endblob fatals_abort
1807
1808 .. startblob flushseenstate
1809
1810 ``flushseenstate:`` 1
1811
1812 Deprecated. No longer used.
1813
1814
1815 .. endblob flushseenstate
1816
1817 .. startblob foolstupidclients
1818
1819 ``foolstupidclients:`` 0
1820
1821 If enabled, only list the personal namespace when a LIST "\*" is performed
1822 (it changes the request to a LIST "INBOX\*").
1823
1824 .. endblob foolstupidclients
1825
1826 .. startblob force_sasl_client_mech
1827
1828 ``force_sasl_client_mech:`` <none>
1829
1830 Force preference of a given SASL mechanism for client side operations
1831 (e.g., murder environments). This is separate from (and overridden by)
1832 the ability to use the <host shortname>_mechs option to set preferred
1833 mechanisms for a specific host.
1834
1835 .. endblob force_sasl_client_mech
1836
1837 .. startblob global_lock
1838
1839 ``global_lock:`` 1
1840
1841 Use a global shared lock for ALL writes, allowing the global lock
1842 wrapper tool to freeze the world
1843
1844 .. endblob global_lock
1845
1846 .. startblob fulldirhash
1847
1848 ``fulldirhash:`` 0
1849
1850 If enabled, uses an improved directory hashing scheme which hashes
1851 on the entire username instead of using just the first letter as
1852 the hash. This changes hash algorithm used for quota and user
1853 directories and if *hashimapspool* is enabled, the entire mail
1854 spool.
1855
1856 Note that this option CANNOT be changed on a live system. The
1857 server must be quiesced and then the directories moved with the
1858 **rehash** utility.
1859
1860 .. endblob fulldirhash
1861
1862 .. startblob hashimapspool
1863
1864 ``hashimapspool:`` 0
1865
1866 If enabled, the partitions will also be hashed, in addition to the
1867 hashing done on configuration directories. This is recommended if
1868 one partition has a very bushy mailbox tree.
1869
1870 .. endblob hashimapspool
1871
1872 .. startblob hostname_mechs
1873
1874 ``hostname_mechs:`` <none>
1875
1876 Force a particular list of SASL mechanisms to be used when authenticating
1877 to the backend server hostname (where hostname is the short hostname of
1878 the server in question). If it is not specified it will query the server
1879 for available mechanisms and pick one to use. - Cyrus Murder
1880
1881 .. endblob hostname_mechs
1882
1883 .. startblob hostname_password
1884
1885 ``hostname_password:`` <none>
1886
1887 The password to use for authentication to the backend server hostname
1888 (where hostname is the short hostname of the server) - Cyrus Murder
1889
1890 .. endblob hostname_password
1891
1892 .. startblob httpallowcompress
1893
1894 ``httpallowcompress:`` 1
1895
1896 If enabled, the server will compress response payloads if the client
1897 indicates that it can accept them. Note that the compressed data
1898 will appear in telemetry logs, leaving only the response headers as
1899 human-readable.
1900
1901 .. endblob httpallowcompress
1902
1903 .. startblob httpallowcors
1904
1905 ``httpallowcors:`` <none>
1906
1907 A wildmat pattern specifying a list of origin URIs ( scheme "://"
1908 host [ ":" port ] ) that are allowed to make Cross-Origin Resource
1909 Sharing (CORS) requests on the server. By default, CORS requests
1910 are disabled.
1911
1912 Note that the scheme and host should both be lowercase, the port
1913 should be omitted if using the default for the scheme (80 for http,
1914 443 for https), and there should be no trailing '/' (e.g.:
1915 "http://www.example.com:8080", "https://example.org").
1916
1917 .. endblob httpallowcors
1918
1919 .. startblob httpallowtrace
1920
1921 ``httpallowtrace:`` 0
1922
1923 Allow use of the TRACE method.
1924
1925 Note that sensitive data might be disclosed by the response.
1926
1927 .. endblob httpallowtrace
1928
1929 .. startblob httpallowedurls
1930
1931 ``httpallowedurls:`` <none>
1932
1933 Space-separated list of relative URLs (paths) rooted at
1934 "httpdocroot" (see below) to be served by httpd. If set, this
1935 option will limit served static content to only those paths specified
1936 (returning "404 Not Found" to any other client requested URLs).
1937 Otherwise, httpd will serve any content found in "httpdocroot".
1938
1939 Note that any path specified by "rss_feedlist_template" is an
1940 exception to this rule.
1941
1942 .. endblob httpallowedurls
1943
1944 .. startblob httpcontentmd5
1945
1946 ``httpcontentmd5:`` 0
1947
1948 If enabled, HTTP responses will include a Content-MD5 header for
1949 the purpose of providing an end-to-end message integrity check
1950 (MIC) of the payload body. Note that enabling this option will
1951 use additional CPU to generate the MD5 digest, which may be ignored
1952 by clients anyways.
1953
1954 .. endblob httpcontentmd5
1955
1956 .. startblob httpdocroot
1957
1958 ``httpdocroot:`` <none>
1959
1960 If set, http will serve the static content (html/text/jpeg/gif
1961 files, etc) rooted at this directory. Otherwise, httpd will not
1962 serve any static content.
1963
1964 .. endblob httpdocroot
1965
1966 .. startblob httpkeepalive
1967
1968 ``httpkeepalive:`` 20s
1969
1970 Set the length of the HTTP server's keepalive heartbeat. The
1971 default is 20 seconds. The minimum value is 0, which will disable
1972 the keepalive heartbeat. When enabled, if a request takes longer
1973 than *httpkeepalive* to process, the server will send the client
1974 provisional responses every *httpkeepalive* until the final
1975 response can be sent.
1976
1977 For backward compatibility, if no unit is specified, seconds is
1978 assumed.
1979
1980 .. endblob httpkeepalive
1981
1982 .. startblob httplogheaders
1983
1984 ``httplogheaders:`` <none>
1985
1986 Space-separated list of HTTP header fields that will be included
1987 in the requests logged by httpd(8).
1988
1989 .. endblob httplogheaders
1990
1991 .. startblob httpmodules
1992
1993 ``httpmodules:`` <empty string>
1994
1995 Space-separated list of HTTP modules that will be enabled in
1996 httpd(8). This option has no effect on modules that are disabled
1997 at compile time due to missing dependencies (e.g. libical).
1998
1999 Note that "domainkey" depends on "ischedule" being enabled, and
2000 that both "freebusy" and "ischedule" depend on "caldav" being
2001 enabled.
2002 Allowed values: *admin*, *caldav*, *carddav*, *cgi*, *domainkey*, *freebusy*, *ischedule*, *jmap*, *prometheus*, *rss*, *tzdist*, *webdav*
2003
2004
2005 .. endblob httpmodules
2006
2007 .. startblob httpprettytelemetry
2008
2009 ``httpprettytelemetry:`` 0
2010
2011 If enabled, HTTP response payloads including server-generated
2012 markup languages (HTML, XML) will utilize line breaks and
2013 indentation to promote better human-readability in telemetry logs.
2014 Note that enabling this option will increase the amount of data
2015 sent across the wire.
2016
2017 .. endblob httpprettytelemetry
2018
2019 .. startblob httppts_uri
2020
2021 ``httppts_uri:`` <none>
2022
2023 The URL endpoint to use when for querying group membership, in URI Template
2024 (level 1) format [:rfc:`6570`]. The URL MUST contain a variable called "groupId"
2025
2026 .. endblob httppts_uri
2027
2028 .. startblob httptimeout
2029
2030 ``httptimeout:`` 5m
2031
2032 Set the length of the HTTP server's inactivity autologout timer.
2033 The minimum value is 0, which will disable persistent connections.
2034
2035 For backwards compatibility, if no unit is specified, minutes
2036 is assumed.
2037
2038 .. endblob httptimeout
2039
2040 .. startblob http_h2_altsvc
2041
2042 ``http_h2_altsvc:`` <none>
2043
2044 If set, HTTP/2 (over TLS) will be advertised as being available on the
2045 specified [host]:port.
2046
2047 .. endblob http_h2_altsvc
2048
2049 .. startblob http_jwt_key_dir
2050
2051 ``http_jwt_key_dir:`` <none>
2052
2053 The absolute path to a directory containing one or more key files
2054 to authenticate JSON Web Tokens (:rfc:`7519`) for HTTP connections.
2055 Keys for the following JWS algorithms are supported: "HS256",
2056 "HS384", "HS512", "RS256", "RS384", "RS512".
2057
2058 A key file consists of one or more keys encoded in PEM format.
2059 RSA keys must be embedded between the lines
2060 "-----BEGIN PUBLIC KEY-----" and "-----END PUBLIC KEY-----"
2061 HMAC digest keys must be embedded between the lines
2062 "-----BEGIN HMAC KEY-----" and "-----END HMAC KEY-----",
2063 encoded in base64.
2064 Any lines before or after a PEM key definition are ignored,
2065 empty lines are ignored anywhere in the file.
2066
2067 The JSON Web Token must be the value of the HTTP "Authorization" header,
2068 using the "Bearer" authentication scheme. The JWS Header must include the
2069 "alg" and "typ" parameter. A header with any other parameter is rejected.
2070 The JWS Payload must include the "sub" claim with the Cyrus user
2071 identifier as value. It may include the "iat" claim (see *http_jwt_max_age*).
2072 A payload with any other claim is rejected.
2073
2074
2075 .. endblob http_jwt_key_dir
2076
2077 .. startblob http_jwt_max_age
2078
2079 ``http_jwt_max_age:`` 0s
2080
2081 Defines the timespan in which a JSON Web Token is valid
2082 (see *http_jwt_key*). The value must be zero or positive.
2083
2084 If non-zero, the timespan starts at the point in time specified in the
2085 "iat" claim of the JWS Payload and ends after the duration of this
2086 option value has passed. Tokens without an "iat" claim,
2087 or with an issue date in the future, are rejected. There is no leeway
2088 for clock skew. Starting from Cyrus version 3.8, the "iat" claim
2089 only is validated if no "exp" claim is present.
2090
2091 The zero value disables validation of the "iat" JWS claim.
2092
2093 Starting from Cyrus 3.8, the "nbf" and "exp" claims always are validated.
2094
2095
2096 .. endblob http_jwt_max_age
2097
2098 .. startblob icalendar_max_size
2099
2100 ``icalendar_max_size:`` 0
2101
2102 Maximum allowed iCalendar size. CalDAV and JMAP will reject storage of
2103 resources whose iCalendar representation is larger than this.
2104
2105 If set to 0 (the default), a large internally-defined limit will be applied.
2106
2107 If no unit is specified, bytes is assumed.
2108
2109 .. endblob icalendar_max_size
2110
2111 .. startblob idlesocket
2112
2113 ``idlesocket:`` {configdirectory}/socket/idle
2114
2115 Unix domain socket that idled listens on.
2116
2117
2118 .. endblob idlesocket
2119
2120 .. startblob ignorereference
2121
2122 ``ignorereference:`` 0
2123
2124 For backwards compatibility with Cyrus 1.5.10 and earlier -- ignore
2125 the reference argument in LIST or LSUB commands.
2126
2127 .. endblob ignorereference
2128
2129 .. startblob imapidlepoll
2130
2131 ``imapidlepoll:`` 60s
2132
2133 The interval for polling for mailbox changes and ALERTs while running
2134 the IDLE command. This option is used when idled is not enabled or
2135 cannot be contacted. The minimum value is 1 second. A value of 0
2136 will disable IDLE.
2137
2138 For backward compatibility, if no unit is specified, seconds is
2139 assumed.
2140
2141 .. endblob imapidlepoll
2142
2143 .. startblob imapidresponse
2144
2145 ``imapidresponse:`` 1
2146
2147 If enabled, the server responds to an ID command with a parameter
2148 list containing: version, vendor, support-url, os, os-version,
2149 command, arguments, environment. Otherwise the server returns NIL.
2150
2151 .. endblob imapidresponse
2152
2153 .. startblob imapmagicplus
2154
2155 ``imapmagicplus:`` 0
2156
2157 Only list a restricted set of mailboxes via IMAP by using
2158 userid+namespace syntax as the authentication/authorization id.
2159 Using userid+ (with an empty namespace) will list only subscribed
2160 mailboxes.
2161
2162 .. endblob imapmagicplus
2163
2164 .. startblob imap_inprogress_interval
2165
2166 ``imap_inprogress_interval:`` 10s
2167
2168 The interval after which the server will send an "INPROGRESS"
2169 response code to the client during a long-running imap command
2170 (e.g. search, copy).
2171 The default is 10 seconds.
2172 The minimum value is 0, which will disable "INPROGRESS" response codes.
2173
2174 .. endblob imap_inprogress_interval
2175
2176 .. startblob imipnotifier
2177
2178 ``imipnotifier:`` <none>
2179
2180 Notifyd(8) method to use for "IMIP" notifications which are based on
2181 the :rfc:`6047`. If not set, "IMIP" notifications are disabled.
2182
2183 .. endblob imipnotifier
2184
2185 .. startblob implicit_owner_rights
2186
2187 ``implicit_owner_rights:`` lkxan
2188
2189 The implicit Access Control List (ACL) for the owner of a mailbox.
2190
2191
2192 .. endblob implicit_owner_rights
2193
2194 .. startblob @include
2195
2196 ``@include:`` <none>
2197
2198 Directive which includes the specified file as part of the
2199 configuration. If the path to the file is not absolute, CYRUS_PATH
2200 is prepended.
2201
2202 .. endblob @include
2203
2204 .. startblob improved_mboxlist_sort
2205
2206 ``improved_mboxlist_sort:`` 0
2207
2208 Not used anymore.
2209
2210
2211 .. endblob improved_mboxlist_sort
2212
2213 .. startblob jmapaccess_url
2214
2215 ``jmapaccess_url:`` <none>
2216
2217 The JMAP Session URL to advertise to sucessfully authenticated IMAP clients,
2218 if the same credentials can be used to authenticate via JMAP
2219 (see draft-ietf-extra-jmapaccess).
2220
2221 .. endblob jmapaccess_url
2222
2223 .. startblob jmap_emailsearch_db_path
2224
2225 ``jmap_emailsearch_db_path:`` <none>
2226
2227 The absolute path to the JMAP email search cache file. If not
2228 specified, JMAP Email/query and Email/queryChanges will not
2229 cache email search results.
2230
2231 .. endblob jmap_emailsearch_db_path
2232
2233 .. startblob jmap_querycache_max_age
2234
2235 ``jmap_querycache_max_age:`` 0m
2236
2237 The duration after which unused cached JMAP query results
2238 must be evicted from process memory. If non-zero, then the
2239 full result of the last query (before windowing) is stored
2240 in-memory. Subsequent queries with the same expression and
2241 query state can then page through the cached result.
2242 A zero value disables query result caching.
2243
2244 If no unit is specified, minutes is assumed.
2245
2246 This feature currently only is enabled for Email/query.
2247
2248 .. endblob jmap_querycache_max_age
2249
2250 .. startblob jmap_preview_annot
2251
2252 ``jmap_preview_annot:`` <none>
2253
2254 The name of the per-message annotation, if any, to store message
2255 previews.
2256
2257 .. endblob jmap_preview_annot
2258
2259 .. startblob jmap_imagesize_annot
2260
2261 ``jmap_imagesize_annot:`` <none>
2262
2263 The name of the per-message annotation, if any, that stores a
2264 JSON object, mapping message part numbers of MIME image types
2265 to an array of their image dimensions. The array must have at
2266 least two entries, where the first entry denotes the width
2267 and the second entry the height of the image. Any additional
2268 values are ignored.
2269
2270 For example, if message part 1.2 contains an image of width 300
2271 and height 200, then the value of this annotation would be:
2272
2273 { "1.2" : [ 300, 200 ] }
2274
2275
2276 .. endblob jmap_imagesize_annot
2277
2278 .. startblob jmap_inlinedcids_annot
2279
2280 ``jmap_inlinedcids_annot:`` <none>
2281
2282 The name of the per-message annotation, if any, that stores a
2283 JSON object, mapping :rfc:`2392` Content-IDs referenced in HTML bodies
2284 to the respective HTML body part number.
2285
2286 For example, if message part 1.2 contains HTML and references an
2287 inlined image at "cid:foo", then the value of this annotation
2288 would be:
2289
2290 { "<foo>" : "1.2" }
2291
2292 Note that the Content-ID key must be URL-unescaped and enclosed in
2293 angular brackets, as defined in :rfc:`2392`.
2294
2295 .. endblob jmap_inlinedcids_annot
2296
2297 .. startblob jmap_preview_length
2298
2299 ``jmap_preview_length:`` 64B
2300
2301 The maximum length of dynamically generated message previews. Previews
2302 stored in jmap_preview_annot take precedence.
2303
2304 If no unit is specified, bytes is assumed.
2305
2306 .. endblob jmap_preview_length
2307
2308 .. startblob jmap_max_catenate_items
2309
2310 ``jmap_max_catenate_items:`` 100
2311
2312 The maximum number of items that can be catenated together by
2313 a JMAP Blob/upload action. Returned as the maxDataSources property
2314 value of the JMAP \"urn:ietf:params:jmap:blob\" capabilities object.
2315 Default value is 100.
2316
2317 .. endblob jmap_max_catenate_items
2318
2319 .. startblob jmap_max_size_upload
2320
2321 ``jmap_max_size_upload:`` 1G
2322
2323 The maximum size that the JMAP API accepts for blob uploads. Returned as
2324 the maxSizeUpload property value of the JMAP \"urn:ietf:params:jmap:core\"
2325 capabilities object.
2326
2327 For backward compatibility, if no unit is specified, kibibytes is assumed.
2328
2329
2330 .. endblob jmap_max_size_upload
2331
2332 .. startblob jmap_max_size_blob_set
2333
2334 ``jmap_max_size_blob_set:`` 4M
2335
2336 The maximum size that the JMAP API accepts for Blob/upload. Returned as the
2337 maxSizeBlobSet property value of the JMAP
2338 \"urn:ietf:params:jmap:blob\" capabilities object.
2339
2340 For backward compatibility, if no unit is specified, kibibytes is assumed.
2341
2342
2343 .. endblob jmap_max_size_blob_set
2344
2345 .. startblob jmap_max_calendareventnotifs
2346
2347 ``jmap_max_calendareventnotifs:`` 200
2348
2349 The maximum count of CalendarEventNotification objects to keep per account.
2350 Any notifications exceeding this count are expunged to make room for new
2351 ones. Zero or any negative number disables this limit.
2352
2353
2354 .. endblob jmap_max_calendareventnotifs
2355
2356 .. startblob jmap_max_concurrent_upload
2357
2358 ``jmap_max_concurrent_upload:`` 5
2359
2360 The value to return for the maxConcurrentUpload property of
2361 the JMAP \"urn:ietf:params:jmap:core\" capabilities object. The Cyrus JMAP
2362 implementation does not enforce this rate-limit.
2363
2364 .. endblob jmap_max_concurrent_upload
2365
2366 .. startblob jmap_max_size_request
2367
2368 ``jmap_max_size_request:`` 10M
2369
2370 The maximum size that the JMAP API accepts for requests at the API endpoint.
2371 Returned as the maxSizeRequest property value of the JMAP
2372 \"urn:ietf:params:jmap:core\" capabilities object.
2373
2374 For backward compatibility, if no unit is specified, kibibytes is assumed.
2375
2376
2377 .. endblob jmap_max_size_request
2378
2379 .. startblob jmap_max_concurrent_requests
2380
2381 ``jmap_max_concurrent_requests:`` 5
2382
2383 The value to return for the maxConcurrentRequests property of
2384 the JMAP \"urn:ietf:params:jmap:core\" capabilities object. The Cyrus JMAP
2385 implementation does not enforce this rate-limit.
2386
2387 .. endblob jmap_max_concurrent_requests
2388
2389 .. startblob jmap_max_calls_in_request
2390
2391 ``jmap_max_calls_in_request:`` 50
2392
2393 The maximum number of calls per JMAP request object.
2394 Returned as the maxCallsInRequest property value of the
2395 JMAP \"urn:ietf:params:jmap:core\" capabilities object.
2396
2397 .. endblob jmap_max_calls_in_request
2398
2399 .. startblob jmap_max_delayed_send
2400
2401 ``jmap_max_delayed_send:`` 512d
2402
2403 The value to return for the maxDelayedSend property of
2404 the JMAP \"urn:ietf:params:jmap:emailsubmission\" capabilities object.
2405 The Cyrus JMAP implementation does not enforce this limit.
2406
2407 For backward compatibility, if no unit is specified, seconds is
2408 assumed.
2409
2410 .. endblob jmap_max_delayed_send
2411
2412 .. startblob jmap_max_objects_in_get
2413
2414 ``jmap_max_objects_in_get:`` 4096
2415
2416 The maximum number of ids that a JMAP client may request in
2417 a single \"/get\" type method call. The actual number
2418 of returned objects in the response may exceed this number
2419 if the JMAP object type supports unbounded \"/get\" calls.
2420 Returned as the maxObjectsInGet property value of the
2421 JMAP \"urn:ietf:params:jmap:core\" capabilities object.
2422
2423 .. endblob jmap_max_objects_in_get
2424
2425 .. startblob jmap_max_objects_in_set
2426
2427 ``jmap_max_objects_in_set:`` 4096
2428
2429 The maximum number of objects a JMAP client may send to create,
2430 update or destroy in a single /set type method call.
2431 Returned as the maxObjectsInSet property value of the
2432 JMAP \"urn:ietf:params:jmap:core\" capabilities object.
2433
2434 .. endblob jmap_max_objects_in_set
2435
2436 .. startblob jmap_mail_max_size_attachments_per_email
2437
2438 ``jmap_mail_max_size_attachments_per_email:`` 10M
2439
2440 The value to return for the maxSizeAttachmentsPerEmail property of the JMAP
2441 \"urn:ietf:params:jmap:mail\" capabilities object. The Cyrus JMAP
2442 implementation does not enforce this size limit.
2443
2444 For backward compatibility, if no unit is specified, kibibytes is assumed.
2445
2446
2447 .. endblob jmap_mail_max_size_attachments_per_email
2448
2449 .. startblob jmap_nonstandard_extensions
2450
2451 ``jmap_nonstandard_extensions:`` 0
2452
2453 If enabled, support non-standard JMAP extensions. If not enabled,
2454 only IETF standard JMAP functionality is supported.
2455
2456 .. endblob jmap_nonstandard_extensions
2457
2458 .. startblob jmap_pushpoll
2459
2460 ``jmap_pushpoll:`` 60s
2461
2462 The interval for polling for changes on an EventSource connection or
2463 when push has been ennabled on a WebSocket channel.
2464 The minimum value is 1 second. A value of 0 will disable push.
2465
2466 If no unit is specified, seconds is assumed.
2467
2468 .. endblob jmap_pushpoll
2469
2470 .. startblob jmap_set_has_attachment
2471
2472 ``jmap_set_has_attachment:`` 1
2473
2474 If enabled, the $hasAttachment flag is determined and set for new messages
2475 created with the JMAP Email/set or Email/import methods. This option should
2476 typically be enabled, but installations using Cyrus-external message
2477 annatotors to determine the $hasAttachment flag might want to disable it.
2478
2479 .. endblob jmap_set_has_attachment
2480
2481 .. startblob jmap_vacation
2482
2483 ``jmap_vacation:`` 1
2484
2485 If enabled, support the JMAP vacation extension.
2486
2487
2488 .. endblob jmap_vacation
2489
2490 .. startblob jmapuploadfolder
2491
2492 ``jmapuploadfolder:`` #jmap
2493
2494 The name of the folder for JMAP uploads.
2495
2496
2497 .. endblob jmapuploadfolder
2498
2499 .. startblob jmapsubmission_deleteonsend
2500
2501 ``jmapsubmission_deleteonsend:`` 1
2502
2503 If enabled (the default) then delete the EmailSubmission as soon as the email
2504 \* has been sent.
2505
2506 .. endblob jmapsubmission_deleteonsend
2507
2508 .. startblob jmapsubmissionfolder
2509
2510 ``jmapsubmissionfolder:`` #jmapsubmission
2511
2512 The name of the folder for JMAP Submissions.
2513
2514
2515 .. endblob jmapsubmissionfolder
2516
2517 .. startblob jmappushsubscriptionfolder
2518
2519 ``jmappushsubscriptionfolder:`` #jmappushsubscription
2520
2521 The name of the folder for JMAP Push Subscriptions.
2522
2523
2524 .. endblob jmappushsubscriptionfolder
2525
2526 .. startblob jmapnotificationfolder
2527
2528 ``jmapnotificationfolder:`` #jmapnotification
2529
2530 The name of the folder for JMAP notifications.
2531
2532
2533 .. endblob jmapnotificationfolder
2534
2535 .. startblob iolog
2536
2537 ``iolog:`` 0
2538
2539 Should cyrus output I/O log entries.
2540
2541
2542 .. endblob iolog
2543
2544 .. startblob ldap_authz
2545
2546 ``ldap_authz:`` <none>
2547
2548 SASL authorization ID for the LDAP server.
2549
2550
2551 .. endblob ldap_authz
2552
2553 .. startblob ldap_base
2554
2555 ``ldap_base:`` <empty string>
2556
2557 Contains the LDAP base dn for the LDAP ptloader module.
2558
2559
2560 .. endblob ldap_base
2561
2562 .. startblob ldap_bind_dn
2563
2564 ``ldap_bind_dn:`` <none>
2565
2566 Bind DN for the connection to the LDAP server (simple bind).
2567 Do not use for anonymous simple binds.
2568
2569 .. endblob ldap_bind_dn
2570
2571 .. startblob ldap_deref
2572
2573 ``ldap_deref:`` never
2574
2575 Specify how aliases dereferencing is handled during search.
2576
2577 Allowed values: *search*, *find*, *always*, *never*
2578
2579
2580 .. endblob ldap_deref
2581
2582 .. startblob ldap_domain_base_dn
2583
2584 ``ldap_domain_base_dn:`` <empty string>
2585
2586 Base DN to search for domain name spaces.
2587
2588
2589 .. endblob ldap_domain_base_dn
2590
2591 .. startblob ldap_domain_filter
2592
2593 ``ldap_domain_filter:`` (&(objectclass=domainrelatedobject)(associateddomain=%s))
2594
2595 Filter to use searching for domains.
2596
2597
2598 .. endblob ldap_domain_filter
2599
2600 .. startblob ldap_domain_name_attribute
2601
2602 ``ldap_domain_name_attribute:`` associateddomain
2603
2604 The attribute name for domains.
2605
2606
2607 .. endblob ldap_domain_name_attribute
2608
2609 .. startblob ldap_domain_scope
2610
2611 ``ldap_domain_scope:`` sub
2612
2613 Search scope
2614
2615 Allowed values: *sub*, *one*, *base*
2616
2617
2618 .. endblob ldap_domain_scope
2619
2620 .. startblob ldap_domain_result_attribute
2621
2622 ``ldap_domain_result_attribute:`` inetdomainbasedn
2623
2624 Result attribute
2625
2626
2627 .. endblob ldap_domain_result_attribute
2628
2629 .. startblob ldap_filter
2630
2631 ``ldap_filter:`` (uid=%u)
2632
2633 Specify a filter that searches user identifiers. The following tokens can be
2634 used in the filter string:
2635
2636 %% = %
2637 %u = user
2638 %U = user portion of %u (%U = test when %u = [email protected])
2639 %d = domain portion of %u if available (%d = domain.tld when %u =
2640 [email protected]), otherwise same as %R
2641 %R = domain portion of %u starting with @ (%R = @domain.tld
2642 when %u = [email protected])
2643 %D = user dn. (use when ldap_member_method: filter)
2644 %1-9 = domain tokens (%1 = tld, %2 = domain when %d = domain.tld)
2645
2646 ldap_filter is not used when ldap_sasl is enabled.
2647
2648 .. endblob ldap_filter
2649
2650 .. startblob ldap_group_base
2651
2652 ``ldap_group_base:`` <empty string>
2653
2654 LDAP base dn for ldap_group_filter.
2655
2656
2657 .. endblob ldap_group_base
2658
2659 .. startblob ldap_groupmember_attribute
2660
2661 ``ldap_groupmember_attribute:`` member
2662
2663 Specify a field within groups with a list of members.
2664
2665
2666 .. endblob ldap_groupmember_attribute
2667
2668 .. startblob ldap_group_filter
2669
2670 ``ldap_group_filter:`` (cn=%u)
2671
2672 Specify a filter that searches for group identifiers.
2673 See ldap_filter for more options.
2674
2675 .. endblob ldap_group_filter
2676
2677 .. startblob ldap_group_scope
2678
2679 ``ldap_group_scope:`` sub
2680
2681 Specify search scope for ldap_group_filter.
2682
2683 Allowed values: *sub*, *one*, *base*
2684
2685
2686 .. endblob ldap_group_scope
2687
2688 .. startblob ldap_id
2689
2690 ``ldap_id:`` <none>
2691
2692 SASL authentication ID for the LDAP server
2693
2694
2695 .. endblob ldap_id
2696
2697 .. startblob ldap_mech
2698
2699 ``ldap_mech:`` <none>
2700
2701 SASL mechanism for LDAP authentication
2702
2703
2704 .. endblob ldap_mech
2705
2706 .. startblob ldap_user_attribute
2707
2708 ``ldap_user_attribute:`` <none>
2709
2710 Specify LDAP attribute to use as canonical user id.
2711
2712
2713 .. endblob ldap_user_attribute
2714
2715 .. startblob ldap_member_attribute
2716
2717 ``ldap_member_attribute:`` <none>
2718
2719 See ldap_member_method.
2720
2721
2722 .. endblob ldap_member_attribute
2723
2724 .. startblob ldap_member_base
2725
2726 ``ldap_member_base:`` <empty string>
2727
2728 LDAP base dn for ldap_member_filter.
2729
2730
2731 .. endblob ldap_member_base
2732
2733 .. startblob ldap_member_filter
2734
2735 ``ldap_member_filter:`` (member=%D)
2736
2737 Specify a filter for "ldap_member_method: filter".
2738 See ldap_filter for more options.
2739
2740 .. endblob ldap_member_filter
2741
2742 .. startblob ldap_member_method
2743
2744 ``ldap_member_method:`` attribute
2745
2746 Specify a group method. The "attribute" method retrieves groups from
2747 a multi-valued attribute specified in ldap_member_attribute.
2748
2749 The "filter" method uses a filter, specified by ldap_member_filter, to find
2750 groups; ldap_member_attribute is a single-value attribute group name.
2751 Allowed values: *attribute*, *filter*
2752
2753
2754 .. endblob ldap_member_method
2755
2756 .. startblob ldap_member_scope
2757
2758 ``ldap_member_scope:`` sub
2759
2760 Specify search scope for ldap_member_filter.
2761
2762 Allowed values: *sub*, *one*, *base*
2763
2764
2765 .. endblob ldap_member_scope
2766
2767 .. startblob ldap_password
2768
2769 ``ldap_password:`` <none>
2770
2771 Password for the connection to the LDAP server (SASL and simple bind).
2772 Do not use for anonymous simple binds.
2773
2774 .. endblob ldap_password
2775
2776 .. startblob ldap_realm
2777
2778 ``ldap_realm:`` <none>
2779
2780 SASL realm for LDAP authentication
2781
2782
2783 .. endblob ldap_realm
2784
2785 .. startblob ldap_referrals
2786
2787 ``ldap_referrals:`` 0
2788
2789 Specify whether or not the client should follow referrals.
2790
2791
2792 .. endblob ldap_referrals
2793
2794 .. startblob ldap_restart
2795
2796 ``ldap_restart:`` 1
2797
2798 Specify whether or not LDAP I/O operations are automatically restarted
2799 if they abort prematurely.
2800
2801 .. endblob ldap_restart
2802
2803 .. startblob ldap_sasl
2804
2805 ``ldap_sasl:`` 1
2806
2807 Use SASL for LDAP binds in the LDAP PTS module.
2808
2809
2810 .. endblob ldap_sasl
2811
2812 .. startblob ldap_sasl_authc
2813
2814 ``ldap_sasl_authc:`` <none>
2815
2816 Deprecated. Use ldap_id
2817
2818
2819 .. endblob ldap_sasl_authc
2820
2821 .. startblob ldap_sasl_authz
2822
2823 ``ldap_sasl_authz:`` <none>
2824
2825 Deprecated. Use ldap_authz
2826
2827
2828 .. endblob ldap_sasl_authz
2829
2830 .. startblob ldap_sasl_mech
2831
2832 ``ldap_sasl_mech:`` <none>
2833
2834 Deprecated. Use ldap_mech
2835
2836
2837 .. endblob ldap_sasl_mech
2838
2839 .. startblob ldap_sasl_password
2840
2841 ``ldap_sasl_password:`` <none>
2842
2843 Deprecated. User ldap_password
2844
2845
2846 .. endblob ldap_sasl_password
2847
2848 .. startblob ldap_sasl_realm
2849
2850 ``ldap_sasl_realm:`` <none>
2851
2852 Deprecated. Use ldap_realm
2853
2854
2855 .. endblob ldap_sasl_realm
2856
2857 .. startblob ldap_scope
2858
2859 ``ldap_scope:`` sub
2860
2861 Specify search scope.
2862
2863 Allowed values: *sub*, *one*, *base*
2864
2865
2866 .. endblob ldap_scope
2867
2868 .. startblob ldap_servers
2869
2870 ``ldap_servers:`` ldap://localhost/
2871
2872 Deprecated. Use ldap_uri
2873
2874
2875 .. endblob ldap_servers
2876
2877 .. startblob ldap_size_limit
2878
2879 ``ldap_size_limit:`` 1
2880
2881 Specify a number of entries for a search request to return.
2882
2883
2884 .. endblob ldap_size_limit
2885
2886 .. startblob ldap_start_tls
2887
2888 ``ldap_start_tls:`` 0
2889
2890 Use transport layer security for ldap:// using STARTTLS. Do not use
2891 ldaps:// in 'ldap_uri' with this option enabled.
2892
2893 .. endblob ldap_start_tls
2894
2895 .. startblob ldap_time_limit
2896
2897 ``ldap_time_limit:`` 5s
2898
2899 How long to wait for a search request to complete.
2900
2901 For backward compatibility, if no unit is specified, seconds is
2902 assumed.
2903
2904 .. endblob ldap_time_limit
2905
2906 .. startblob ldap_timeout
2907
2908 ``ldap_timeout:`` 5s
2909
2910 How long a search can take before timing out.
2911
2912 For backward compatibility, if no unit is specified, seconds is
2913 assumed.
2914
2915 .. endblob ldap_timeout
2916
2917 .. startblob ldap_ca_dir
2918
2919 ``ldap_ca_dir:`` <none>
2920
2921 Path to a directory with CA (Certificate Authority) certificates.
2922
2923
2924 .. endblob ldap_ca_dir
2925
2926 .. startblob ldap_ca_file
2927
2928 ``ldap_ca_file:`` <none>
2929
2930 Path to a file containing CA (Certificate Authority) certificate(s).
2931
2932
2933 .. endblob ldap_ca_file
2934
2935 .. startblob ldap_ciphers
2936
2937 ``ldap_ciphers:`` <none>
2938
2939 List of SSL/TLS ciphers to allow. The format of the string is
2940 described in ciphers(1).
2941
2942 .. endblob ldap_ciphers
2943
2944 .. startblob ldap_client_cert
2945
2946 ``ldap_client_cert:`` <none>
2947
2948 File containing the client certificate.
2949
2950
2951 .. endblob ldap_client_cert
2952
2953 .. startblob ldap_client_key
2954
2955 ``ldap_client_key:`` <none>
2956
2957 File containing the private client key.
2958
2959
2960 .. endblob ldap_client_key
2961
2962 .. startblob ldap_verify_peer
2963
2964 ``ldap_verify_peer:`` 0
2965
2966 Require and verify server certificate. If this option is yes,
2967 you must specify ldap_ca_file or ldap_ca_dir.
2968
2969 .. endblob ldap_verify_peer
2970
2971 .. startblob ldap_tls_cacert_dir
2972
2973 ``ldap_tls_cacert_dir:`` <none>
2974
2975 Deprecated in favor of *ldap_ca_dir*.
2976
2977
2978 .. endblob ldap_tls_cacert_dir
2979
2980 .. startblob ldap_tls_cacert_file
2981
2982 ``ldap_tls_cacert_file:`` <none>
2983
2984 Deprecated in favor of *ldap_ca_file*.
2985
2986
2987 .. endblob ldap_tls_cacert_file
2988
2989 .. startblob ldap_tls_cert
2990
2991 ``ldap_tls_cert:`` <none>
2992
2993 Deprecated in favor of *ldap_client_cert*.
2994
2995
2996 .. endblob ldap_tls_cert
2997
2998 .. startblob ldap_tls_key
2999
3000 ``ldap_tls_key:`` <none>
3001
3002 Deprecated in favor of *ldap_client_key*.
3003
3004
3005 .. endblob ldap_tls_key
3006
3007 .. startblob ldap_tls_check_peer
3008
3009 ``ldap_tls_check_peer:`` 0
3010
3011 Deprecated in favor of *ldap_verify_peer*.
3012
3013
3014 .. endblob ldap_tls_check_peer
3015
3016 .. startblob ldap_tls_ciphers
3017
3018 ``ldap_tls_ciphers:`` <none>
3019
3020 Deprecated in favor of *ldap_ciphers*.
3021
3022
3023 .. endblob ldap_tls_ciphers
3024
3025 .. startblob ldap_uri
3026
3027 ``ldap_uri:`` <none>
3028
3029 Contains a list of the URLs of all the LDAP servers when using the
3030 LDAP PTS module.
3031
3032 .. endblob ldap_uri
3033
3034 .. startblob ldap_version
3035
3036 ``ldap_version:`` 3
3037
3038 Specify the LDAP protocol version. If ldap_start_tls and/or
3039 ldap_use_sasl are enabled, ldap_version will be automatically
3040 set to 3.
3041
3042 .. endblob ldap_version
3043
3044 .. startblob literalminus
3045
3046 ``literalminus:`` 0
3047
3048 if enabled, CAPABILITIES will reply with LITERAL- rather than
3049 LITERAL+ (:rfc:`7888`). Doesn't actually size-restrict uploads though.
3050
3051 .. endblob literalminus
3052
3053 .. startblob lmtp_downcase_rcpt
3054
3055 ``lmtp_downcase_rcpt:`` 1
3056
3057 If enabled, lmtpd will convert the recipient addresses to lowercase
3058 (up to a '+' character, if present).
3059
3060 .. endblob lmtp_downcase_rcpt
3061
3062 .. startblob lmtp_exclude_specialuse
3063
3064 ``lmtp_exclude_specialuse:`` \\Snoozed
3065
3066 Don't allow delivery to folders with given special-use attributes.
3067
3068 Note that "snoozing" of emails can currently only be done via the
3069 JMAP protocol, so delivery directly to the \Snoozed mailbox is
3070 prohibited by default as it will not be moved back into INBOX
3071 automatically.
3072
3073 .. endblob lmtp_exclude_specialuse
3074
3075 .. startblob lmtp_fuzzy_mailbox_match
3076
3077 ``lmtp_fuzzy_mailbox_match:`` 0
3078
3079 If enabled, and the mailbox specified in the detail part of the
3080 recipient (everything after the '+') does not exist, lmtpd will try
3081 to find the closest match (ignoring case, ignoring whitespace,
3082 falling back to parent) to the specified mailbox name.
3083
3084 .. endblob lmtp_fuzzy_mailbox_match
3085
3086 .. startblob lmtp_over_quota_perm_failure
3087
3088 ``lmtp_over_quota_perm_failure:`` 0
3089
3090 If enabled, lmtpd returns a permanent failure code when a user's
3091 mailbox is over quota. By default, the failure is temporary,
3092 causing the MTA to queue the message and retry later.
3093
3094 .. endblob lmtp_over_quota_perm_failure
3095
3096 .. startblob lmtp_preparse
3097
3098 ``lmtp_preparse:`` 0
3099
3100 If enabled, lmtpd will map in the email and parse the xapian data
3101 for jmapsearch. The advantage is that the parsing is done without
3102 holding any locks. The disadvantage is that the parsing is done
3103 even if it winds up not being needed.
3104
3105 .. endblob lmtp_preparse
3106
3107 .. startblob lmtp_strict_quota
3108
3109 ``lmtp_strict_quota:`` 0
3110
3111 If enabled, lmtpd returns a failure code when the incoming message
3112 will cause the user's mailbox to exceed its quota. By default, the
3113 failure won't occur until the mailbox is already over quota.
3114
3115 .. endblob lmtp_strict_quota
3116
3117 .. startblob lmtp_strict_rfc2821
3118
3119 ``lmtp_strict_rfc2821:`` 1
3120
3121 By default, lmtpd will be strict (per :rfc:`2821`) with regards to which
3122 envelope addresses are allowed. If this option is set to false, 8bit
3123 characters in the local-part of envelope addresses are changed to 'X'
3124 instead. This is useful to avoid generating backscatter with
3125 certain MTAs like Postfix or Exim which accept such messages.
3126
3127 .. endblob lmtp_strict_rfc2821
3128
3129 .. startblob lmtpsocket
3130
3131 ``lmtpsocket:`` {configdirectory}/socket/lmtp
3132
3133 Unix domain socket that lmtpd listens on, used by deliver(8). This should
3134 match the path specified in cyrus.conf(5).
3135
3136 .. endblob lmtpsocket
3137
3138 .. startblob lmtptxn_timeout
3139
3140 ``lmtptxn_timeout:`` 5m
3141
3142 Timeout used during a lmtp transaction to a remote backend (e.g. in a
3143 murder environment). Can be used to prevent hung lmtpds on proxy hosts
3144 when a backend server becomes unresponsive during a lmtp transaction.
3145 Change to zero for infinite.
3146
3147 For backward compatibility, if no unit is specified, seconds is
3148 assumed.
3149
3150 .. endblob lmtptxn_timeout
3151
3152 .. startblob lock_debugtime
3153
3154 ``lock_debugtime:`` <none>
3155
3156 A floating point number of seconds. If set, time how long we wait for
3157 any lock, and syslog the filename and time if it's longer than this
3158 value. The default of NULL means not to time locks. This is
3159 implemented for fcntl(2) locks and has no effect on flock(2) locks.
3160
3161 .. endblob lock_debugtime
3162
3163 .. startblob loginrealms
3164
3165 ``loginrealms:`` <empty string>
3166
3167 The list of remote realms whose users may authenticate using cross-realm
3168 authentication identifiers. Separate each realm name by a space. (A
3169 cross-realm identity is considered any identity returned by SASL
3170 with an "@" in it.).
3171
3172 .. endblob loginrealms
3173
3174 .. startblob loginuseacl
3175
3176 ``loginuseacl:`` 0
3177
3178 If enabled, any authentication identity which has **a** rights on a
3179 user's INBOX may log in as that user.
3180
3181 .. endblob loginuseacl
3182
3183 .. startblob logtimestamps
3184
3185 ``logtimestamps:`` 0
3186
3187 Include notations in the protocol telemetry logs indicating the number of
3188 seconds since the last command or response.
3189
3190 .. endblob logtimestamps
3191
3192 .. startblob mailbox_default_options
3193
3194 ``mailbox_default_options:`` 0
3195
3196 Default "options" field for the mailbox on create. You'll want to know
3197 what you're doing before setting this, but it can apply some default
3198 annotations like duplicate suppression.
3199
3200 .. endblob mailbox_default_options
3201
3202 .. startblob mailbox_initial_flags
3203
3204 ``mailbox_initial_flags:`` <none>
3205
3206 space-separated list of permanent flags which will be pre-set in every
3207 newly created mailbox. If you know you will require particular
3208 flag names then this avoids a possible race condition against a client
3209 that fills the entire 128 available slots. Default is NULL, which is
3210 no flags. Example: $Label1 $Label2 $Label3 NotSpam Spam
3211
3212 .. endblob mailbox_initial_flags
3213
3214 .. startblob mailbox_legacy_dirs
3215
3216 ``mailbox_legacy_dirs:`` 0
3217
3218 If enabled, new mailboxes without parents will be created with legacy paths.
3219 sub mailboxes of users will still inherit the parent legacy setting.
3220
3221 .. endblob mailbox_legacy_dirs
3222
3223 .. startblob mailbox_maxmessages_addressbook
3224
3225 ``mailbox_maxmessages_addressbook:`` 0
3226
3227 Limit the number of messages that may exist in a single mailbox of
3228 "addressbook" type. Default (0) means no limit. This limit applies
3229 after quotas are checked, so if you have both quota limits and this
3230 set, then you will be denied if you are either over quota or over
3231 this per-mailbox count.
3232
3233 .. endblob mailbox_maxmessages_addressbook
3234
3235 .. startblob mailbox_maxmessages_calendar
3236
3237 ``mailbox_maxmessages_calendar:`` 0
3238
3239 Limit the number of messages that may exist in a single mailbox of
3240 "calendar" type. Default (0) means no limit. This limit applies
3241 after quotas are checked, so if you have both quota limits and this
3242 set, then you will be denied if you are either over quota or over
3243 this per-mailbox count.
3244
3245 .. endblob mailbox_maxmessages_calendar
3246
3247 .. startblob mailbox_maxmessages_email
3248
3249 ``mailbox_maxmessages_email:`` 0
3250
3251 Limit the number of messages that may exist in a single mailbox of
3252 "email" (normal) type. Default (0) means no limit. This limit applies
3253 after quotas are checked, so if you have both quota limits and this
3254 set, then you will be denied if you are either over quota or over
3255 this per-mailbox count.
3256
3257 .. endblob mailbox_maxmessages_email
3258
3259 .. startblob mailnotifier
3260
3261 ``mailnotifier:`` <none>
3262
3263 Notifyd(8) method to use for "MAIL" notifications. If not set, "MAIL"
3264 notifications are disabled.
3265
3266 .. endblob mailnotifier
3267
3268 .. startblob master_bind_errors_fatal
3269
3270 ``master_bind_errors_fatal:`` 0
3271
3272 If enabled, failure to bind a port during startup is treated as a fatal
3273 error, causing master to shut down immediately. The default is to keep
3274 running, with the affected service disabled until the next SIGHUP causes
3275 it to retry.
3276
3277 Note that this only applies during startup. New services that fail to
3278 come up in response to a reconfig+SIGHUP will just be logged and disabled
3279 like the default behaviour, without causing master to exit.
3280
3281 .. endblob master_bind_errors_fatal
3282
3283 .. startblob master_pid_file
3284
3285 ``master_pid_file:`` {configdirectory}/master.pid
3286
3287 The path to a file that master(8) will write its PID to when running
3288 as a daemon.
3289
3290 .. endblob master_pid_file
3291
3292 .. startblob master_ready_file
3293
3294 ``master_ready_file:`` {configdirectory}/master.ready
3295
3296 The path to a file that master(8) will update to indicate that it is
3297 ready to accept client connections. This file will be created if it does
3298 not already exist, or truncated if it does.
3299
3300 .. endblob master_ready_file
3301
3302 .. startblob maxheaderlines
3303
3304 ``maxheaderlines:`` 1000
3305
3306 Maximum number of lines of header that will be processed into cache
3307 records. Default 1000. If set to zero, it is unlimited.
3308 If a message hits the limit, an error will be logged and the rest of
3309 the lines in the header will be skipped. This is to avoid malformed
3310 messages causing giant cache records.
3311
3312 .. endblob maxheaderlines
3313
3314 .. startblob maxlogins_per_host
3315
3316 ``maxlogins_per_host:`` 0
3317
3318 Maximum number of logged in sessions allowed per service per host,
3319 zero means no limit.
3320
3321 .. endblob maxlogins_per_host
3322
3323 .. startblob maxlogins_per_user
3324
3325 ``maxlogins_per_user:`` 0
3326
3327 Maximum number of logged in sessions allowed per service per user,
3328 zero means no limit.
3329
3330 .. endblob maxlogins_per_user
3331
3332 .. startblob maxargssize
3333
3334 ``maxargssize:`` 0
3335
3336 Maximum total size of arguments to an IMAP command that will be
3337 accepted by Cyrus.
3338 Commands with arguments that exceed this limit will be rejected.
3339
3340 If set to 0 (the default), a large internally-defined limit will be applied.
3341
3342 If no unit is specified, bytes is assumed.
3343
3344 .. endblob maxargssize
3345
3346 .. startblob maxmessagesize
3347
3348 ``maxmessagesize:`` 0
3349
3350 Maximum size of messages that will be accepted by Cyrus. This affects LMTP
3351 deliveries, IMAP appends, DAV uploads, etc. Messages larger than this will
3352 be rejected.
3353
3354 If set to 0 (the default), a large internally-defined limit will be applied.
3355
3356 If no unit is specified, bytes is assumed.
3357
3358 .. endblob maxmessagesize
3359
3360 .. startblob maxliteral
3361
3362 ``maxliteral:`` 128K
3363
3364 Maximum size of a single literal allowed by the IMAP parser.
3365
3366 If set to 0, a large internally-defined limit will be applied.
3367
3368 If no unit is specified, bytes is assumed.
3369
3370 Literals used for message [part] data in APPEND are only limited by
3371 the 'maxmessagesize' option.
3372
3373 If the 'literalminus' option is enabled, non-synchonizing literals
3374 will be limited to the lesser of 4K and either 'maxliteral' or
3375 'maxmessagesize', depending on the use-case.
3376
3377 .. endblob maxliteral
3378
3379 .. startblob maxquoted
3380
3381 ``maxquoted:`` 128K
3382
3383 Maximum size of a single quoted string allowed by the IMAP parser.
3384
3385 If set to 0, a large internally-defined limit will be applied.
3386
3387 If no unit is specified, bytes is assumed.
3388
3389 .. endblob maxquoted
3390
3391 .. startblob maxword
3392
3393 ``maxword:`` 128K
3394
3395 Maximum size of a single word allowed by the IMAP parser.
3396
3397 If set to 0, a large internally-defined limit will be applied.
3398
3399 If no unit is specified, bytes is assumed.
3400
3401 .. endblob maxword
3402
3403 .. startblob mboxkey_db
3404
3405 ``mboxkey_db:`` twoskip
3406
3407 The cyrusdb backend to use for mailbox keys.
3408
3409 Allowed values: *skiplist*, *twoskip*, *zeroskip*
3410
3411
3412 .. endblob mboxkey_db
3413
3414 .. startblob mboxlist_db
3415
3416 ``mboxlist_db:`` twoskip
3417
3418 The cyrusdb backend to use for the mailbox list.
3419
3420 Allowed values: *flat*, *skiplist*, *sql*, *twoskip*, *zeroskip*
3421
3422
3423 .. endblob mboxlist_db
3424
3425 .. startblob mboxlist_db_path
3426
3427 ``mboxlist_db_path:`` <none>
3428
3429 The absolute path to the mailboxes db file. If not specified
3430 will be configdirectory/mailboxes.db
3431
3432 .. endblob mboxlist_db_path
3433
3434 .. startblob mboxname_lockpath
3435
3436 ``mboxname_lockpath:`` <none>
3437
3438 Path to mailbox name lock files (default $conf/lock)
3439
3440
3441 .. endblob mboxname_lockpath
3442
3443 .. startblob metapartition_files
3444
3445 ``metapartition_files:`` <empty string>
3446
3447 Space-separated list of metadata files to be stored on a
3448 *metapartition* rather than in the mailbox directory on a spool
3449 partition.
3450 Allowed values: *header*, *index*, *cache*, *expunge*, *squat*, *annotations*, *lock*, *dav*, *archivecache*
3451
3452
3453 .. endblob metapartition_files
3454
3455 .. startblob metapartition-name
3456
3457 ``metapartition-name:`` <none>
3458
3459 The pathname of the metadata partition *name*, corresponding to
3460 spool partition **partition-name**. For any mailbox residing in
3461 a directory on **partition-name**, the metadata files listed in
3462 *metapartition_files* will be stored in a corresponding directory on
3463 **metapartition-name**. Note that not every
3464 **partition-name** option is required to have a corresponding
3465 **metapartition-name** option, so that you can selectively choose
3466 which spool partitions will have separate metadata partitions.
3467
3468 .. endblob metapartition-name
3469
3470 .. startblob mupdate_authname
3471
3472 ``mupdate_authname:`` <none>
3473
3474 The SASL username (Authentication Name) to use when authenticating to the
3475 mupdate server (if needed).
3476
3477 .. endblob mupdate_authname
3478
3479 .. startblob mupdate_config
3480
3481 ``mupdate_config:`` standard
3482
3483 The configuration of the mupdate servers in the Cyrus Murder.
3484 The "standard" config is one in which there are discreet frontend
3485 (proxy) and backend servers. The "unified" config is one in which
3486 a server can be both a frontend and backend. The "replicated"
3487 config is one in which multiple backend servers all share the same
3488 mailspool, but each have their own "replicated" copy of
3489 mailboxes.db.
3490 Allowed values: *standard*, *unified*, *replicated*
3491
3492
3493 .. endblob mupdate_config
3494
3495 .. startblob munge8bit
3496
3497 ``munge8bit:`` 1
3498
3499 If enabled, lmtpd munges messages with 8-bit characters in the
3500 headers. The 8-bit characters are changed to \`X'. If
3501 **reject8bit** is enabled, setting **munge8bit** has no effect.
3502 (A proper solution to non-ASCII characters in headers is offered by
3503 :rfc:`2047` and its predecessors.)
3504
3505 .. endblob munge8bit
3506
3507 .. startblob mupdate_connections_max
3508
3509 ``mupdate_connections_max:`` 128
3510
3511 The max number of connections that a mupdate process will allow, this
3512 is related to the number of file descriptors in the mupdate process.
3513 Beyond this number connections will be immediately issued a BYE response.
3514
3515 .. endblob mupdate_connections_max
3516
3517 .. startblob mupdate_password
3518
3519 ``mupdate_password:`` <none>
3520
3521 The SASL password (if needed) to use when authenticating to the
3522 mupdate server.
3523
3524 .. endblob mupdate_password
3525
3526 .. startblob mupdate_port
3527
3528 ``mupdate_port:`` 3905
3529
3530 The port of the mupdate server for the Cyrus Murder.
3531
3532
3533 .. endblob mupdate_port
3534
3535 .. startblob mupdate_realm
3536
3537 ``mupdate_realm:`` <none>
3538
3539 The SASL realm (if needed) to use when authenticating to the mupdate
3540 server.
3541
3542 .. endblob mupdate_realm
3543
3544 .. startblob mupdate_retry_delay
3545
3546 ``mupdate_retry_delay:`` 20
3547
3548 The base time to wait between connection retries to the mupdate server.
3549
3550
3551 .. endblob mupdate_retry_delay
3552
3553 .. startblob mupdate_server
3554
3555 ``mupdate_server:`` <none>
3556
3557 The mupdate server for the Cyrus Murder.
3558
3559
3560 .. endblob mupdate_server
3561
3562 .. startblob mupdate_username
3563
3564 ``mupdate_username:`` <empty string>
3565
3566 The SASL username (Authorization Name) to use when authenticating to
3567 the mupdate server.
3568
3569 .. endblob mupdate_username
3570
3571 .. startblob mupdate_workers_max
3572
3573 ``mupdate_workers_max:`` 50
3574
3575 The maximum number of mupdate worker threads (overall).
3576
3577
3578 .. endblob mupdate_workers_max
3579
3580 .. startblob mupdate_workers_maxspare
3581
3582 ``mupdate_workers_maxspare:`` 10
3583
3584 The maximum number of idle mupdate worker threads.
3585
3586
3587 .. endblob mupdate_workers_maxspare
3588
3589 .. startblob mupdate_workers_minspare
3590
3591 ``mupdate_workers_minspare:`` 2
3592
3593 The minimum number of idle mupdate worker threads.
3594
3595
3596 .. endblob mupdate_workers_minspare
3597
3598 .. startblob mupdate_workers_start
3599
3600 ``mupdate_workers_start:`` 5
3601
3602 The number of mupdate worker threads to start.
3603
3604
3605 .. endblob mupdate_workers_start
3606
3607 .. startblob netscapeurl
3608
3609 ``netscapeurl:`` <none>
3610
3611 If enabled at compile time, this specifies a URL to reply when
3612 Netscape asks the server where the mail administration HTTP server
3613 is. Administrators should set this to a local resource.
3614
3615 .. endblob netscapeurl
3616
3617 .. startblob newsaddheaders
3618
3619 ``newsaddheaders:`` to
3620
3621 Space-separated list of headers to be added to incoming usenet
3622 articles. Added *To:* headers will contain email
3623 delivery addresses corresponding to each newsgroup in the
3624 *Newsgroups:* header. Added *Reply-To:* headers will
3625 contain email delivery addresses corresponding to each newsgroup in
3626 the *Followup-To:* or *Newsgroups:* header. If the
3627 specified header(s) already exist in an article, the email
3628 delivery addresses will be appended to the original header body(s).
3629
3630
3631 This option applies if and only if the **newspostuser** option is
3632 set.
3633 Allowed values: *to*, *replyto*
3634
3635
3636 .. endblob newsaddheaders
3637
3638 .. startblob newsgroups
3639
3640 ``newsgroups:`` \*
3641
3642 A wildmat pattern specifying which mailbox hierarchies should be
3643 treated as newsgroups. Only mailboxes matching the wildmat will
3644 accept and/or serve articles via NNTP. If not set, a default
3645 wildmat of "\*" (ALL shared mailboxes) will be used. If the
3646 *newsprefix* option is also set, the default wildmat will be
3647 translated to "<newsprefix>.\*"
3648
3649 .. endblob newsgroups
3650
3651 .. startblob newsmaster
3652
3653 ``newsmaster:`` news
3654
3655 Userid that is used for checking access controls when executing
3656 Usenet control messages. For instance, to allow articles to be
3657 automatically deleted by cancel messages, give the "news" user
3658 the 'd' right on the desired mailboxes. To allow newsgroups to be
3659 automatically created, deleted and renamed by the corresponding
3660 control messages, give the "news" user the 'c' right on the desired
3661 mailbox hierarchies.
3662
3663 .. endblob newsmaster
3664
3665 .. startblob newspeer
3666
3667 ``newspeer:`` <none>
3668
3669 A list of whitespace-separated news server specifications to which
3670 articles should be fed. Each server specification is a string of
3671 the form [user[:pass]@]host[:port][/wildmat] where 'host' is the fully
3672 qualified hostname of the server, 'port' is the port on which the
3673 server is listening, 'user' and 'pass' are the authentication
3674 credentials and 'wildmat' is a pattern that specifies which groups
3675 should be fed. If no 'port' is specified, port 119 is used. If
3676 no 'wildmat' is specified, all groups are fed. If 'user' is specified
3677 (even if empty), then the NNTP POST command will be used to feed
3678 the article to the server, otherwise the IHAVE command will be
3679 used.
3680
3681
3682 A '@' may be used in place of '!' in the wildmat to prevent feeding
3683 articles cross-posted to the given group, otherwise cross-posted
3684 articles are fed if any part of the wildmat matches. For example,
3685 the string "peer.example.com:\*,!control.\*,@local.\*" would feed all
3686 groups except control messages and local groups to
3687 peer.example.com. In the case of cross-posting to local groups,
3688 these articles would not be fed.
3689
3690 .. endblob newspeer
3691
3692 .. startblob newspostuser
3693
3694 ``newspostuser:`` <none>
3695
3696 Userid used to deliver usenet articles to newsgroup folders
3697 (usually via lmtp2nntp). For example, if set to "post", email sent
3698 to "post+comp.mail.imap" would be delivered to the "comp.mail.imap"
3699 folder.
3700
3701
3702 When set, the Cyrus NNTP server will add the header(s) specified in
3703 the **newsaddheaders** option to each incoming usenet article.
3704 The added header(s) will contain email delivery addresses
3705 corresponding to each relevant newsgroup. If not set, no headers
3706 are added to usenet articles.
3707
3708 .. endblob newspostuser
3709
3710 .. startblob newsprefix
3711
3712 ``newsprefix:`` <none>
3713
3714 Prefix to be prepended to newsgroup names to make the corresponding
3715 IMAP mailbox names.
3716
3717 .. endblob newsprefix
3718
3719 .. startblob newsrc_db_path
3720
3721 ``newsrc_db_path:`` <none>
3722
3723 The absolute path to the newsrc db file. If not specified,
3724 will be configdirectory/fetchnews.db
3725
3726 .. endblob newsrc_db_path
3727
3728 .. startblob nntptimeout
3729
3730 ``nntptimeout:`` 3m
3731
3732 Set the length of the NNTP server's inactivity autologout timer.
3733 The minimum value is 3 minutes, also the default.
3734
3735 For backward compatibility, if no unit is specified, minutes is
3736 assumed.
3737
3738 .. endblob nntptimeout
3739
3740 .. startblob notesmailbox
3741
3742 ``notesmailbox:`` <none>
3743
3744 The top level mailbox in each user's account which is used to store
3745 \* Apple-style Notes. Default is blank (disabled).
3746
3747 .. endblob notesmailbox
3748
3749 .. startblob notifysocket
3750
3751 ``notifysocket:`` {configdirectory}/socket/notify
3752
3753 Unix domain socket that the mail notification daemon listens on.
3754
3755
3756 .. endblob notifysocket
3757
3758 .. startblob notify_external
3759
3760 ``notify_external:`` <none>
3761
3762 Path to the external program that notifyd(8) will call to send mail
3763 notifications.
3764
3765 The external program will be called with the following
3766 command line options:
3767
3768 .. option:: -c class
3769
3770 .. option:: -p priority
3771
3772 .. option:: -u user
3773
3774 .. option:: -m mailbox
3775
3776 And the notification message will be available on *stdin*.
3777
3778
3779 .. endblob notify_external
3780
3781 .. startblob partition-name
3782
3783 ``partition-name:`` <none>
3784
3785 The pathname of the partition *name*. At least one partition
3786 pathname MUST be specified. If the **defaultpartition** option is
3787 used, then its pathname MUST be specified. For example, if the
3788 value of the **defaultpartion** option is **part1**, then the
3789 **partition-part1** field is required.
3790
3791 .. endblob partition-name
3792
3793 .. startblob partition_select_mode
3794
3795 ``partition_select_mode:`` freespace-most
3796
3797 Partition selection mode.
3798
3799 *random*
3800 (pseudo-)random selection
3801
3802 *freespace-most*
3803 partition with the most free space (KiB)
3804
3805 *freespace-percent-most*
3806 partition with the most free space (%)
3807
3808 *freespace-percent-weighted*
3809 each partition is weighted according to its free space (%); the more free space
3810 the partition has, the more chances it has to be selected
3811
3812 *freespace-percent-weighted-delta*
3813 each partition is weighted according to its difference of free space (%)
3814 compared to the most used partition; the more the partition is lagging behind
3815 the most used partition, the more chances it has to be selected
3816
3817 Note that actually even the most used partition has a few chances to be
3818 selected, and those chances increase when other partitions get closer
3819
3820 Allowed values: *random*, *freespace-most*, *freespace-percent-most*, *freespace-percent-weighted*, *freespace-percent-weighted-delta*
3821
3822
3823 .. endblob partition_select_mode
3824
3825 .. startblob partition_select_exclude
3826
3827 ``partition_select_exclude:`` <none>
3828
3829 List of partitions to exclude from selection mode.
3830
3831
3832 .. endblob partition_select_exclude
3833
3834 .. startblob partition_select_usage_reinit
3835
3836 ``partition_select_usage_reinit:`` 0
3837
3838 For a given session, number of **operations** (e.g. partition selection)
3839 for which partitions usage data are cached.
3840
3841 .. endblob partition_select_usage_reinit
3842
3843 .. startblob partition_select_soft_usage_limit
3844
3845 ``partition_select_soft_usage_limit:`` 0
3846
3847 Limit of partition usage (%): if a partition is over that limit, it is
3848 automatically excluded from selection mode.
3849
3850 If all partitions are over that limit, this feature is not used anymore.
3851
3852
3853 .. endblob partition_select_soft_usage_limit
3854
3855 .. startblob plaintextloginpause
3856
3857 ``plaintextloginpause:`` <none>
3858
3859 Time to pause after a successful plaintext login. For systems that
3860 support strong authentication, this permits users to perceive a cost
3861 of using plaintext passwords. (This does not affect the use of PLAIN
3862 in SASL authentications.)
3863
3864 For backward compatibility, if no unit is specified, seconds is
3865 assumed.
3866
3867 .. endblob plaintextloginpause
3868
3869 .. startblob plaintextloginalert
3870
3871 ``plaintextloginalert:`` <none>
3872
3873 Message to send to client after a successful plaintext login.
3874
3875
3876 .. endblob plaintextloginalert
3877
3878 .. startblob popexpiretime
3879
3880 ``popexpiretime:`` -1
3881
3882 The duration advertised as being the minimum a message may be
3883 left on the POP server before it is deleted (via the CAPA command,
3884 defined in the POP3 Extension Mechanism, which some clients may
3885 support). This duration has a granularity of whole days, with partial
3886 days truncated (so e.g. "45m" is effectively "0d"). "NEVER", the
3887 default, may be specified with a negative number.
3888
3889 The Cyrus POP3 server never deletes mail, no matter what the value of
3890 this parameter is. However, if a site implements a less liberal policy,
3891 it needs to change this parameter accordingly.
3892
3893 For backward compatibility, if no unit is specified, days is
3894 assumed.
3895
3896 .. endblob popexpiretime
3897
3898 .. startblob popminpoll
3899
3900 ``popminpoll:`` <none>
3901
3902 Set the minimum amount of time the server forces users to wait
3903 between successive POP logins.
3904
3905 For backward compatibility, if no unit is specified, minutes is
3906 assumed.
3907
3908 .. endblob popminpoll
3909
3910 .. startblob popsubfolders
3911
3912 ``popsubfolders:`` 0
3913
3914 Allow access to subfolders of INBOX via POP3 by using
3915 userid+subfolder syntax as the authentication/authorization id.
3916
3917 .. endblob popsubfolders
3918
3919 .. startblob poppollpadding
3920
3921 ``poppollpadding:`` 1
3922
3923 Create a softer minimum poll restriction. Allows *poppollpadding*
3924 connections before the minpoll restriction is triggered. Additionally,
3925 one padding entry is recovered every *popminpoll* minutes.
3926 This allows for the occasional polling rate faster than popminpoll,
3927 (i.e., for clients that require a send/receive to send mail) but still
3928 enforces the rate long-term. Default is 1 (disabled).
3929
3930
3931 The easiest way to think of it is a queue of past connections, with one
3932 slot being filled for every connection, and one slot being cleared
3933 every *popminpoll* minutes. When the queue is full, the user
3934 will not be able to check mail again until a slot is cleared. If the
3935 user waits a sufficient amount of time, they will get back many or all
3936 of the slots.
3937
3938 .. endblob poppollpadding
3939
3940 .. startblob poptimeout
3941
3942 ``poptimeout:`` 10m
3943
3944 Set the length of the POP server's inactivity autologout timer.
3945 The minimum value is 10 minutes, the default.
3946
3947 For backward compatibility, if no unit is specified, minutes is
3948 assumed.
3949
3950 .. endblob poptimeout
3951
3952 .. startblob popuseacl
3953
3954 ``popuseacl:`` 0
3955
3956 Enforce IMAP ACLs in the pop server. Due to the nature of the POP3
3957 protocol, the only rights which are used by the pop server are 'r',
3958 't', and 's' for the owner of the mailbox. The 'r' right allows the
3959 user to open the mailbox and list/retrieve messages. The 't' right
3960 allows the user to delete messages. The 's' right allows messages
3961 retrieved by the user to have the \\Seen flag set (only if
3962 *popuseimapflags* is also enabled).
3963
3964 .. endblob popuseacl
3965
3966 .. startblob popuseimapflags
3967
3968 ``popuseimapflags:`` 0
3969
3970 If enabled, the pop server will set and obey IMAP flags. Messages
3971 having the \\Deleted flag are ignored as if they do not exist.
3972 Messages that are retrieved by the client will have the \\Seen flag
3973 set. All messages will have the \\Recent flag unset.
3974
3975 .. endblob popuseimapflags
3976
3977 .. startblob postmaster
3978
3979 ``postmaster:`` postmaster
3980
3981 Username that is used as the 'From' address in rejection MDNs produced
3982 by sieve.
3983
3984 .. endblob postmaster
3985
3986 .. startblob postuser
3987
3988 ``postuser:`` <empty string>
3989
3990 Userid used to deliver messages to shared folders. For example, if
3991 set to "bb", email sent to "bb+shared.blah" would be delivered to
3992 the "shared.blah" folder. By default, an email address of
3993 "+shared.blah" would be used.
3994
3995 .. endblob postuser
3996
3997 .. startblob proc_path
3998
3999 ``proc_path:`` <none>
4000
4001 Path to proc directory. Default is NULL - must be an absolute path
4002 if specified. If not specified, the path $configdirectory/proc/ will be
4003 used.
4004
4005 .. endblob proc_path
4006
4007 .. startblob prometheus_enabled
4008
4009 ``prometheus_enabled:`` 0
4010
4011 Whether tracking of metrics for Prometheus is enabled.
4012
4013
4014 .. endblob prometheus_enabled
4015
4016 .. startblob prometheus_need_auth
4017
4018 ``prometheus_need_auth:`` admin
4019
4020 Authentication level required to fetch Prometheus metrics.
4021
4022 Allowed values: *none*, *user*, *admin*
4023
4024
4025 .. endblob prometheus_need_auth
4026
4027 .. startblob prometheus_update_freq
4028
4029 ``prometheus_update_freq:`` 10s
4030
4031 Deprecated in favour of *prometheus_service_update_freq*,
4032 *prometheus_master_update_freq*, and
4033 *prometheus_usage_update_freq*.
4034
4035 .. endblob prometheus_update_freq
4036
4037 .. startblob prometheus_service_update_freq
4038
4039 ``prometheus_service_update_freq:`` 10s
4040
4041 Frequency in at which promstatsd should re-collate its service
4042 statistics report. The minimum value is 1 second.
4043
4044 If no unit is specified, seconds is assumed.
4045
4046 .. endblob prometheus_service_update_freq
4047
4048 .. startblob prometheus_master_update_freq
4049
4050 ``prometheus_master_update_freq:`` <none>
4051
4052 Frequency in at which master should re-collate its statistics report.
4053 If not set, *prometheus_service_update_freq* is used.
4054
4055 If no unit is specified, seconds is assumed.
4056
4057 .. endblob prometheus_master_update_freq
4058
4059 .. startblob prometheus_usage_update_freq
4060
4061 ``prometheus_usage_update_freq:`` <none>
4062
4063 Frequency in at which promstatsd should re-collate its usage
4064 statistics report. Note that this report is relatively expensive to
4065 produce. If not set, usage statistics are not reported.
4066
4067 Best to make this a multiple of *prometheus_service_update_freq*.
4068
4069 If no unit is specified, seconds is assumed.
4070
4071 .. endblob prometheus_usage_update_freq
4072
4073 .. startblob prometheus_stats_dir
4074
4075 ``prometheus_stats_dir:`` <none>
4076
4077 Directory to use for gathering prometheus statistics. If specified,
4078 must be an absolute path. If not specified, the default path
4079 $configdirectory/stats/ will be used. It may be advantageous to locate this
4080 directory on ephemeral storage.
4081
4082 .. endblob prometheus_stats_dir
4083
4084 .. startblob proxy_authname
4085
4086 ``proxy_authname:`` proxy
4087
4088 The authentication name to use when authenticating to a backend server
4089 in the Cyrus Murder.
4090
4091 .. endblob proxy_authname
4092
4093 .. startblob proxy_compress
4094
4095 ``proxy_compress:`` 0
4096
4097 Try to enable protocol-specific compression when performing a client
4098 connection to a backend server in the Cyrus Murder.
4099
4100 Note that this should only be necessary over slow network
4101 connections. Also note that currently only IMAP and MUPDATE support
4102 compression.
4103
4104 .. endblob proxy_compress
4105
4106 .. startblob proxy_password
4107
4108 ``proxy_password:`` <none>
4109
4110 The default password to use when authenticating to a backend server
4111 in the Cyrus Murder. May be overridden on a host-specific basis using
4112 the hostname_password option.
4113
4114 .. endblob proxy_password
4115
4116 .. startblob proxy_realm
4117
4118 ``proxy_realm:`` <none>
4119
4120 The authentication realm to use when authenticating to a backend server
4121 in the Cyrus Murder
4122
4123 .. endblob proxy_realm
4124
4125 .. startblob proxyd_allow_status_referral
4126
4127 ``proxyd_allow_status_referral:`` 0
4128
4129 Set to true to allow proxyd to issue referrals to clients that support it
4130 when answering the STATUS command. This is disabled by default since
4131 some clients issue many STATUS commands in a row, and do not cache the
4132 connections that these referrals would cause, thus resulting in a higher
4133 authentication load on the respective backend server.
4134
4135 .. endblob proxyd_allow_status_referral
4136
4137 .. startblob proxyd_disable_mailbox_referrals
4138
4139 ``proxyd_disable_mailbox_referrals:`` 0
4140
4141 Set to true to disable the use of mailbox-referrals on the
4142 proxy servers.
4143
4144 .. endblob proxyd_disable_mailbox_referrals
4145
4146 .. startblob proxyservers
4147
4148 ``proxyservers:`` <none>
4149
4150 A list of users and groups that are allowed to proxy for other
4151 users, separated by spaces. Any user listed in this will be
4152 allowed to login for any other user: use with caution.
4153 In a standard murder this option should ONLY be set on backends.
4154 DO NOT SET on frontends or things won't work properly.
4155
4156 .. endblob proxyservers
4157
4158 .. startblob pts_module
4159
4160 ``pts_module:`` afskrb
4161
4162 The PTS module to use.
4163
4164 Allowed values: *afskrb*, *ldap*, *http*
4165
4166
4167 .. endblob pts_module
4168
4169 .. startblob ptloader_sock
4170
4171 ``ptloader_sock:`` <none>
4172
4173 Unix domain socket that ptloader listens on.
4174 (defaults to configdirectory/ptclient/ptsock).
4175
4176 .. endblob ptloader_sock
4177
4178 .. startblob ptscache_db
4179
4180 ``ptscache_db:`` twoskip
4181
4182 The cyrusdb backend to use for the pts cache.
4183
4184 Allowed values: *skiplist*, *twoskip*, *zeroskip*
4185
4186
4187 .. endblob ptscache_db
4188
4189 .. startblob ptscache_db_path
4190
4191 ``ptscache_db_path:`` <none>
4192
4193 The absolute path to the ptscache db file. If not specified,
4194 will be configdirectory/ptscache.db
4195
4196 .. endblob ptscache_db_path
4197
4198 .. startblob ptscache_timeout
4199
4200 ``ptscache_timeout:`` 3h
4201
4202 The timeout for the PTS cache database when using the auth_krb_pts
4203 authorization method (default: 3 hours).
4204
4205 For backward compatibility, if no unit is specified, seconds is
4206 assumed.
4207
4208 .. endblob ptscache_timeout
4209
4210 .. startblob ptskrb5_convert524
4211
4212 ``ptskrb5_convert524:`` 1
4213
4214 When using the AFSKRB ptloader module with Kerberos 5 canonicalization,
4215 do the final 524 conversion to get a n AFS style name (using '.' instead
4216 of '/', and using short names.
4217
4218 .. endblob ptskrb5_convert524
4219
4220 .. startblob ptskrb5_strip_default_realm
4221
4222 ``ptskrb5_strip_default_realm:`` 1
4223
4224 When using the AFSKRB ptloader module with Kerberos 5 canonicalization,
4225 strip the default realm from the userid (this does not affect the stripping
4226 of realms specified by the afspts_localrealms option).
4227
4228 .. endblob ptskrb5_strip_default_realm
4229
4230 .. startblob qosmarking
4231
4232 ``qosmarking:`` cs0
4233
4234 This specifies the Class Selector or Differentiated Services Code Point
4235 designation on IP headers (in the ToS field).
4236 Allowed values: *cs0*, *cs1*, *cs2*, *cs3*, *cs4*, *cs5*, *cs6*, *cs7*, *af11*, *af12*, *af13*, *af21*, *af22*, *af23*, *af31*, *af32*, *af33*, *af41*, *af42*, *af43*, *ef*
4237
4238
4239 .. endblob qosmarking
4240
4241 .. startblob quota_db
4242
4243 ``quota_db:`` quotalegacy
4244
4245 The cyrusdb backend to use for quotas.
4246
4247 Allowed values: *flat*, *skiplist*, *sql*, *quotalegacy*, *twoskip*, *zeroskip*
4248
4249
4250 .. endblob quota_db
4251
4252 .. startblob quota_db_path
4253
4254 ``quota_db_path:`` <none>
4255
4256 The absolute path for the quota database (if you choose a single-file
4257 quota DB type - or the base path if you choose quotalegacy). If
4258 not specified will be configdirectory/quotas.db or configdirectory/quota/
4259
4260 .. endblob quota_db_path
4261
4262 .. startblob quota_use_conversations
4263
4264 ``quota_use_conversations:`` 0
4265
4266 If conversations it enabled and quotaroot is a user folder, use the
4267 conversations quota counts, which count multiple copies of exactly the
4268 same message (by GUID) as only one.
4269
4270 .. endblob quota_use_conversations
4271
4272 .. startblob quotawarn
4273
4274 ``quotawarn:`` 90
4275
4276 Deprecated in favour of *quotawarnpercent*.
4277
4278
4279 .. endblob quotawarn
4280
4281 .. startblob quotawarnpercent
4282
4283 ``quotawarnpercent:`` 90
4284
4285 The percent of quota utilization over which the server generates
4286 warnings.
4287
4288 .. endblob quotawarnpercent
4289
4290 .. startblob quotawarnkb
4291
4292 ``quotawarnkb:`` <none>
4293
4294 Deprecated in favour of *quotawarnsize*.
4295
4296
4297 .. endblob quotawarnkb
4298
4299 .. startblob quotawarnsize
4300
4301 ``quotawarnsize:`` 0
4302
4303 The maximum amount of free space at which to give a quota warning
4304 (if this value is 0, or if the quota is smaller than this
4305 amount, then warnings are always given).
4306
4307 Note that quota has kibibyte granularity. Values specified here will
4308 be truncated to the nearest whole kibibyte.
4309
4310 For backward compatibility, if no unit is specified, kibibytes is
4311 assumed.
4312
4313 .. endblob quotawarnsize
4314
4315 .. startblob quotawarnmsg
4316
4317 ``quotawarnmsg:`` 0
4318
4319 The maximum amount of messages at which to give a quota warning
4320 (if this value is 0, or if the quota is smaller than this
4321 amount, then warnings are always given).
4322
4323 .. endblob quotawarnmsg
4324
4325 .. startblob readonly
4326
4327 ``readonly:`` 0
4328
4329 If enabled, all IMAP, POP and JMAP connections are read-only,
4330 \* no writes allowed.
4331
4332 .. endblob readonly
4333
4334 .. startblob replicaonly
4335
4336 ``replicaonly:`` 0
4337
4338 If enabled, marks the server as only being a replica. This will
4339 \* stop calalarmd from doing anything, and also deny any non-silent
4340 \* writes (nothing is allowed to increase modseq or uidvalidity).
4341
4342
4343 .. endblob replicaonly
4344
4345 .. startblob reject8bit
4346
4347 ``reject8bit:`` 0
4348
4349 If enabled, lmtpd rejects messages with 8-bit characters in the
4350 headers.
4351
4352 .. endblob reject8bit
4353
4354 .. startblob restore_authname
4355
4356 ``restore_authname:`` <none>
4357
4358 The authentication used by the restore tool when authenticating
4359 to an IMAP/sync server.
4360
4361 .. endblob restore_authname
4362
4363 .. startblob restore_password
4364
4365 ``restore_password:`` <none>
4366
4367 The password used by the restore tool when authenticating to an
4368 IMAP/sync server.
4369
4370 .. endblob restore_password
4371
4372 .. startblob restore_realm
4373
4374 ``restore_realm:`` <none>
4375
4376 The authentication realm used by the restore tool when
4377 authenticating to an IMAP/sync server.
4378
4379 .. endblob restore_realm
4380
4381 .. startblob reverseacls
4382
4383 ``reverseacls:`` 0
4384
4385 At startup time, ctl_cyrusdb -r will check this value and it
4386 will either add or remove reverse ACL pointers from mailboxes.db
4387
4388 .. endblob reverseacls
4389
4390 .. startblob reverseuniqueids
4391
4392 ``reverseuniqueids:`` 1
4393
4394 Deprecated. No longer used.
4395
4396
4397 .. endblob reverseuniqueids
4398
4399 .. startblob rfc2046_strict
4400
4401 ``rfc2046_strict:`` 0
4402
4403 If enabled, imapd will be strict (per :rfc:`2046`) when matching MIME
4404 boundary strings. This means that boundaries containing other
4405 boundaries as substrings will be treated as identical. Since
4406 enabling this option will break some messages created by Eudora 5.1
4407 (and earlier), it is recommended that it be left disabled unless
4408 there is good reason to do otherwise.
4409
4410 .. endblob rfc2046_strict
4411
4412 .. startblob rfc2047_utf8
4413
4414 ``rfc2047_utf8:`` 0
4415
4416 If enabled, imapd will parse any non-encoded character sequence in
4417 MIME header values as UTF8. This is useful for installations that
4418 either advertise the UTF8SMTP (:rfc:`5335`) extension or receive mails
4419 with improperly escaped UTF-8 byte sequences. It is recommended that
4420 this option is left disabled unless there is good reason to do
4421 otherwise.
4422
4423 .. endblob rfc2047_utf8
4424
4425 .. startblob rfc3028_strict
4426
4427 ``rfc3028_strict:`` 1
4428
4429 If enabled, Sieve will be strict (per :rfc:`3028`) with regards to
4430 which headers are allowed to be used in address and envelope tests.
4431 This means that only those headers which are defined to contain addresses
4432 will be allowed in address tests and only "to" and "from" will be
4433 allowed in envelope tests. When disabled, ANY grammatically correct header
4434 will be allowed.
4435
4436 .. endblob rfc3028_strict
4437
4438 .. startblob rss_feedlist_template
4439
4440 ``rss_feedlist_template:`` <none>
4441
4442 File containing HTML that will be used as a template for displaying
4443 the list of available RSS feeds. A single instance of the variable
4444 %RSS_FEEDLIST% should appear in the file, which will be replaced by
4445 a nested unordered list of feeds. The toplevel unordered list will
4446 be tagged with an id of "feed" (<ul id='feed'>) which can be used
4447 by stylesheet(s) in your template. The dynamically created list of
4448 feeds based on the HTML template will be accessible at the "/rss"
4449 URL on the server.
4450
4451 .. endblob rss_feedlist_template
4452
4453 .. startblob rss_feeds
4454
4455 ``rss_feeds:`` \*
4456
4457 A wildmat pattern specifying which mailbox hierarchies should be
4458 treated as RSS feeds. Only mailboxes matching the wildmat will
4459 have their messages available via RSS. If not set, a default
4460 wildmat of "\*" (ALL mailboxes) will be used.
4461
4462 .. endblob rss_feeds
4463
4464 .. startblob rss_maxage
4465
4466 ``rss_maxage:`` <none>
4467
4468 Maximum age of items to display in an RSS channel. If non-zero,
4469 httpd will only display items received within this time period.
4470 If set to 0, all available items will be displayed (the default).
4471
4472 For backward compatibility, if no unit is specified, days is
4473 assumed.
4474
4475 .. endblob rss_maxage
4476
4477 .. startblob rss_maxitems
4478
4479 ``rss_maxitems:`` 0
4480
4481 Maximum number of items to display in an RSS channel. If non-zero,
4482 httpd will display no more than the *rss_maxitems* most recent
4483 items. If set to 0, all available items will be displayed (the
4484 default).
4485
4486 .. endblob rss_maxitems
4487
4488 .. startblob rss_maxsynopsis
4489
4490 ``rss_maxsynopsis:`` 0
4491
4492 Maximum RSS item synopsis length. If non-zero, httpd will display
4493 no more than the first *rss_maxsynopsis* characters of an
4494 item's synopsis. If set to 0, the entire synopsis will be
4495 displayed (the default).
4496
4497 .. endblob rss_maxsynopsis
4498
4499 .. startblob rss_realm
4500
4501 ``rss_realm:`` <none>
4502
4503 The realm to present for HTTP authentication of RSS feeds. If not
4504 set (the default), the value of the "servername" option will be
4505 used.
4506
4507 .. endblob rss_realm
4508
4509 .. startblob sasl_auto_transition
4510
4511 ``sasl_auto_transition:`` 0
4512
4513 If enabled, the SASL library will automatically create authentication
4514 secrets when given a plaintext password. See the SASL documentation.
4515
4516 .. endblob sasl_auto_transition
4517
4518 .. startblob sasl_maximum_layer
4519
4520 ``sasl_maximum_layer:`` 256
4521
4522 Maximum SSF (security strength factor) that the server will allow a
4523 client to negotiate.
4524
4525 .. endblob sasl_maximum_layer
4526
4527 .. startblob sasl_minimum_layer
4528
4529 ``sasl_minimum_layer:`` 0
4530
4531 The minimum SSF that the server will allow a client to negotiate.
4532 A value of 1 requires integrity protection; any higher value
4533 requires some amount of encryption.
4534
4535 .. endblob sasl_minimum_layer
4536
4537 .. startblob sasl_option
4538
4539 ``sasl_option:`` 0
4540
4541 Any SASL option can be set by preceding it with **sasl_**. This
4542 file overrides the SASL configuration file.
4543
4544 .. endblob sasl_option
4545
4546 .. startblob sasl_pwcheck_method
4547
4548 ``sasl_pwcheck_method:`` <none>
4549
4550 The mechanism used by the server to verify plaintext passwords.
4551 Possible values include "auxprop", "saslauthd", and "pwcheck".
4552
4553 .. endblob sasl_pwcheck_method
4554
4555 .. startblob search_batchsize
4556
4557 ``search_batchsize:`` 20
4558
4559 The number of messages to be indexed in one batch (default 20).
4560 Note that long batches may delay user commands or mail delivery.
4561
4562 .. endblob search_batchsize
4563
4564 .. startblob search_attachment_extractor_url
4565
4566 ``search_attachment_extractor_url:`` <none>
4567
4568 A HTTP or HTTPS URL to extract search text from rich text attachments
4569 and other media during search indexing. The server at this URL must
4570 implement the following protocol:
4571
4572 1. For each attachment of an email, Cyrus sends a GET request to the
4573 URL <extractor-url>/<cyrus-id>, where <extractor-url> is the
4574 configured URL and <cyrus-id> is a Cyrus-chosen path segment that
4575 uniquely identifies this attachment.
4576
4577 2. If the extractor already has a cached plain text extract of the
4578 attachment identified by <cyrus-id> then it may return HTTP status
4579 code 200 (OK) and the plain text extract with a Content-Type
4580 "text/plain" header. Otherwise it must return HTTP status 404 (Not Found).
4581
4582 3. If Cyrus receives the HTTP status code 404 (Not Found), then it sends
4583 a PUT request to the same URL as previously. The PUT request body
4584 contains the decoded, binary body of the attachment. The Content-Type
4585 request header has the same value as declared in the MIME part
4586 headers, including any type parameters.
4587
4588 4. The extractor must return the plain text extract with either HTTP status
4589 200 (OK) or 201 (Created) and a Content-Type "text/plain" header.
4590 If no text can be extracted, then the extractor may return any return code
4591 in the range 4xx, or 200 and an empty response body.
4592
4593 Any other HTTP status code is treated as an error. For performance
4594 reasons, the Cyrus indexer attempts to keep-alive the TCP connection
4595 to the extractor.
4596 Xapian only.
4597
4598
4599 .. endblob search_attachment_extractor_url
4600
4601 .. startblob search_attachment_extractor_request_timeout
4602
4603 ``search_attachment_extractor_request_timeout:`` 5m
4604
4605 Defines the duration after which to cancel non-responding
4606 requests to the search attachment extractor service.
4607
4608 If no unit is specified, seconds is assumed.
4609
4610 .. endblob search_attachment_extractor_request_timeout
4611
4612 .. startblob search_attachment_extractor_idle_timeout
4613
4614 ``search_attachment_extractor_idle_timeout:`` 5m
4615
4616 Defines the duration after which to close unused connections to
4617 the search attachment extractor service. If the idle timeout is
4618 less than search_attachment_extractor_request_timeout, then it
4619 is ignored and request timeout used instead.
4620
4621 If no unit is specified, seconds is assumed.
4622
4623 .. endblob search_attachment_extractor_idle_timeout
4624
4625 .. startblob search_index_language
4626
4627 ``search_index_language:`` 0
4628
4629
4630 If enabled, then messages bodies are stemmed by detected language
4631 in addition to the default English stemmer.
4632 Xapian only.
4633
4634
4635 .. endblob search_index_language
4636
4637 .. startblob search_index_parts
4638
4639 ``search_index_parts:`` 0
4640
4641
4642 Deprecated. No longer used.
4643
4644
4645 .. endblob search_index_parts
4646
4647 .. startblob search_index_skip_domains
4648
4649 ``search_index_skip_domains:`` <none>
4650
4651
4652 A space separated list of domains - if set, any users in the listed domains
4653 will be skipped when indexing.
4654
4655
4656 .. endblob search_index_skip_domains
4657
4658 .. startblob search_index_skip_users
4659
4660 ``search_index_skip_users:`` <none>
4661
4662
4663 A space separated list of usernames - if set, any users in the list
4664 will be skipped when indexing.
4665
4666
4667 .. endblob search_index_skip_users
4668
4669 .. startblob search_query_language
4670
4671 ``search_query_language:`` 0
4672
4673
4674 Deprecated. No longer used.
4675
4676
4677 .. endblob search_query_language
4678
4679 .. startblob search_normalisation_max
4680
4681 ``search_normalisation_max:`` 1000
4682
4683 A resource bound for the combinatorial explosion of search expression
4684 tree complexity caused by normalising expressions with many OR nodes.
4685 These can use more CPU time to optimise than they save IO time in scanning
4686 folders.
4687
4688 .. endblob search_normalisation_max
4689
4690 .. startblob search_engine
4691
4692 ``search_engine:`` none
4693
4694 The indexing engine used to speed up searching.
4695
4696 Allowed values: *none*, *squat*, *xapian*
4697
4698
4699 .. endblob search_engine
4700
4701 .. startblob search_fuzzy_always
4702
4703 ``search_fuzzy_always:`` 0
4704
4705 Whether to enable :rfc:`6203` FUZZY search for all IMAP SEARCH. If turned
4706 on, search attributes will be searched using FUZZY search by default.
4707 If turned off, clients have to explicitly use the FUZZY search key to
4708 enable fuzzy search for regular SEARCH commands.
4709
4710 .. endblob search_fuzzy_always
4711
4712 .. startblob search_index_headers
4713
4714 ``search_index_headers:`` 1
4715
4716 Whether to index headers other than From, To, Cc, Bcc, and Subject.
4717 Experiment shows that some headers such as Received and DKIM-Signature
4718 can contribute up to 2/3rds of the index size but almost nothing to
4719 the utility of searching. Note that if header indexing is disabled,
4720 headers can still be searched, the searches will just be slower.
4721
4722
4723 .. endblob search_index_headers
4724
4725 .. startblob search_indexed_db
4726
4727 ``search_indexed_db:`` twoskip
4728
4729 The cyrusdb backend to use for the search latest indexed uid state. Xapian only.
4730
4731 Allowed values: *flat*, *skiplist*, *twoskip*, *zeroskip*
4732
4733
4734 .. endblob search_indexed_db
4735
4736 .. startblob search_maxtime
4737
4738 ``search_maxtime:`` <none>
4739
4740 The maximum number of seconds to run a search for before aborting. Default
4741 of no value means search "forever" until other timeouts.
4742
4743 .. endblob search_maxtime
4744
4745 .. startblob search_maxsize
4746
4747 ``search_maxsize:`` 4M
4748
4749 The maximum size to index for each message part. Message contents that
4750 occur after this byte offset will not be indexed nor used to generate
4751 search snippets. Xapian-only.
4752
4753 For backward compatibility, if no unit is specified, kibibytes is
4754 assumed.
4755
4756 .. endblob search_maxsize
4757
4758 .. startblob search_queryscan
4759
4760 ``search_queryscan:`` 5000
4761
4762 The minimum number of records require to do a direct scan of all G keys
4763 \* rather than indexed lookups. A value of 0 means always do indexed lookups.
4764
4765
4766 .. endblob search_queryscan
4767
4768 .. startblob search_skipdiacrit
4769
4770 ``search_skipdiacrit:`` 1
4771
4772 When searching, should diacriticals be stripped from the search
4773 terms. The default is "true", a search for "hav" will match
4774 "Håvard". This is not :rfc:`5051` compliant, but is backwards
4775 compatible, and may be preferred by some sites.
4776
4777 .. endblob search_skipdiacrit
4778
4779 .. startblob search_skiphtml
4780
4781 ``search_skiphtml:`` 0
4782
4783 If enabled, HTML parts of messages are skipped, i.e. not indexed and
4784 not searchable. Otherwise, they're indexed.
4785
4786 .. endblob search_skiphtml
4787
4788 .. startblob search_whitespace
4789
4790 ``search_whitespace:`` merge
4791
4792 When searching, how whitespace should be handled. Options are:
4793 "skip" (default in 2.3 and earlier series) - where a search for
4794 "equi" would match "the quick brown fox". "merge" - the default,
4795 where "he qu" would match "the quick brownfox", and "keep",
4796 where whitespace must match exactly. The default of "merge" is
4797 recommended for most cases - it's a good compromise which
4798 keeps words separate.
4799 Allowed values: *skip*, *merge*, *keep*
4800
4801
4802 .. endblob search_whitespace
4803
4804 .. startblob search_snippet_length
4805
4806 ``search_snippet_length:`` 255
4807
4808 The maximum byte length of a snippet generated by the XSNIPPETS
4809 command. Only supported by the Xapian search backend, which
4810 attempts to always fill search_snippet_length bytes in the
4811 generated snippet.
4812
4813 .. endblob search_snippet_length
4814
4815 .. startblob search_stopword_path
4816
4817 ``search_stopword_path:`` <none>
4818
4819 The absolute base path to the search stopword lists. If not specified,
4820 no stopwords will be taken into account during search indexing. Currently,
4821 the only supported and default stop word file is english.txt.
4822
4823 .. endblob search_stopword_path
4824
4825 .. startblob searchpartition-name
4826
4827 ``searchpartition-name:`` <none>
4828
4829 The pathname where to store the xapian search indexes of *searchtier*
4830 for mailboxes of partition *name*. This must be configured for the
4831 *defaultsearchtier* and any additional search tier (see squatter for
4832 details).
4833
4834 For example: if *defaultpartition* is defined as part1 and
4835 *defaultsearchtier* as tier1 then the configuration must contain
4836 an entry *tier1searchpartition-part1* that defines the path where to
4837 store this tier1's search index for the part1 partition.
4838
4839 This option MUST be specified for xapian search.
4840
4841 .. endblob searchpartition-name
4842
4843 .. startblob seenstate_db
4844
4845 ``seenstate_db:`` twoskip
4846
4847 The cyrusdb backend to use for the seen state.
4848
4849 Allowed values: *flat*, *skiplist*, *twoskip*, *zeroskip*
4850
4851
4852 .. endblob seenstate_db
4853
4854 .. startblob sendmail
4855
4856 ``sendmail:`` /usr/lib/sendmail
4857
4858 The pathname of the sendmail executable. Sieve invokes sendmail
4859 for sending rejections, redirects and vacation responses.
4860
4861 .. endblob sendmail
4862
4863 .. startblob sendmail_auth_id
4864
4865 ``sendmail_auth_id:`` CYRUS_SENDMAIL_AUTH_ID
4866
4867 The name of an environment variable to set when invoking sendmail.
4868 The value of this environment variable will contain the user id
4869 of the currently authenticated user. If no user is authenticated
4870 the environment variable is not set.
4871
4872 .. endblob sendmail_auth_id
4873
4874 .. startblob serverlist
4875
4876 ``serverlist:`` <none>
4877
4878 Whitespace separated list of backend server names. Used for
4879 finding server with the most available free space for proxying
4880 CREATE.
4881
4882 .. endblob serverlist
4883
4884 .. startblob serverlist_select_mode
4885
4886 ``serverlist_select_mode:`` freespace-most
4887
4888 Server selection mode.
4889
4890 *random*
4891 (pseudo-)random selection
4892
4893 *freespace-most*
4894 backend with the most (total) free space (KiB)
4895
4896 *freespace-percent-most*
4897 backend whose partition has the most free space (%)
4898
4899 *freespace-percent-weighted*
4900 same as for partition selection, comparing the free space (%) of the least used
4901 partition of each backend
4902
4903 *freespace-percent-weighted-delta*
4904 same as for partition selection, comparing the free space (%) of the least used
4905 partition of each backend.
4906
4907
4908 Allowed values: *random*, *freespace-most*, *freespace-percent-most*, *freespace-percent-weighted*, *freespace-percent-weighted-delta*
4909
4910
4911 .. endblob serverlist_select_mode
4912
4913 .. startblob serverlist_select_usage_reinit
4914
4915 ``serverlist_select_usage_reinit:`` 0
4916
4917 For a given session, number of **operations** (e.g. backend selection)
4918 for which backend usage data are cached.
4919
4920 .. endblob serverlist_select_usage_reinit
4921
4922 .. startblob serverlist_select_soft_usage_limit
4923
4924 ``serverlist_select_soft_usage_limit:`` 0
4925
4926 Limit of backend usage (%): if a backend is over that limit, it is
4927 automatically excluded from selection mode.
4928
4929 If all backends are over that limit, this feature is not used anymore.
4930
4931
4932 .. endblob serverlist_select_soft_usage_limit
4933
4934 .. startblob servername
4935
4936 ``servername:`` <none>
4937
4938 This is the hostname visible in the greeting messages of the POP,
4939 IMAP and LMTP daemons. If it is unset, then the result returned
4940 from gethostname(2) is used. This is also the value used by murder
4941 clusters to identify the host name. It should be resolvable by
4942 DNS to the correct host, and unique within an active cluster. If
4943 you are using low level replication (e.g. drbd) then it should be
4944 the same on each copy and the DNS name should also be moved to
4945 the new master on failover.
4946
4947 .. endblob servername
4948
4949 .. startblob serverinfo
4950
4951 ``serverinfo:`` on
4952
4953 The server information to display in the greeting and capability
4954 responses. Information is displayed as follows:
4955
4956 "off" = no server information in the greeting or capabilities
4957
4958 "min" = *servername* in the greeting; no server information in the capabilities
4959
4960 "on" = *servername* and product version in the greeting;
4961 product version in the capabilities
4962
4963
4964 Allowed values: *off*, *min*, *on*
4965
4966
4967 .. endblob serverinfo
4968
4969 .. startblob sharedprefix
4970
4971 ``sharedprefix:`` Shared Folders
4972
4973 If using the alternate IMAP namespace, the prefix for the shared
4974 namespace. The hierarchy delimiter will be automatically appended.
4975
4976
4977 .. endblob sharedprefix
4978
4979 .. startblob sieve_allowreferrals
4980
4981 ``sieve_allowreferrals:`` 1
4982
4983 If enabled, timsieved will issue referrals to clients when the
4984 user's scripts reside on a remote server (in a Murder).
4985 Otherwise, timsieved will proxy traffic to the remote server.
4986
4987 .. endblob sieve_allowreferrals
4988
4989 .. startblob sieve_duplicate_max_expiration
4990
4991 ``sieve_duplicate_max_expiration:`` 90d
4992
4993 Maximum expiration time for duplicate message tracking records.
4994
4995 For backward compatibility, if no unit is specified, seconds is
4996 assumed.
4997
4998 .. endblob sieve_duplicate_max_expiration
4999
5000 .. startblob sieve_extensions
5001
5002 ``sieve_extensions:`` fileinto reject vacation vacation-seconds notify include envelope environment body relational regex subaddress copy date index imap4flags mailbox mboxmetadata servermetadata variables editheader extlists duplicate ihave fcc special-use redirect-dsn redirect-deliverby mailboxid vnd.cyrus.log vnd.cyrus.jmapquery processcalendar snooze vnd.cyrus.implicit_keep_target
5003
5004 Space-separated list of Sieve extensions allowed to be used in
5005 sieve scripts, enforced at submission by timsieved(8). Any
5006 previously installed script will be unaffected by this option and
5007 will continue to execute regardless of the extensions used. This
5008 option has no effect on options that are disabled at compile time
5009 (e.g., "regex").
5010 Allowed values: *fileinto*, *reject*, *vacation*, *vacation-seconds*, *notify*, *include*, *envelope*, *environment*, *body*, *relational*, *regex*, *subaddress*, *copy*, *date*, *index*, *imap4flags=imapflags*, *mailbox*, *mboxmetadata*, *servermetadata*, *variables*, *editheader*, *extlists*, *duplicate*, *ihave*, *fcc*, *special-use*, *redirect-dsn*, *redirect-deliverby*, *mailboxid*, *vnd.cyrus.log=x-cyrus-log*, *vnd.cyrus.jmapquery=x-cyrus-jmapquery*, *processcalendar=vnd.cyrus.imip*, *snooze=vnd.cyrus.snooze=x-cyrus-snooze*, *vnd.cyrus.implicit_keep_target*
5011
5012
5013 .. endblob sieve_extensions
5014
5015 .. startblob sieve_folder
5016
5017 ``sieve_folder:`` #sieve
5018
5019 The name of the folder for storing Sieve scripts.
5020
5021
5022 .. endblob sieve_folder
5023
5024 .. startblob sieve_maxscriptsize
5025
5026 ``sieve_maxscriptsize:`` 32K
5027
5028 Maximum size any sieve script can be, enforced at submission by
5029 timsieved(8) and JMAP.
5030
5031 For backward compatibility, if no unit is specified, kibibytes is
5032 assumed.
5033
5034 .. endblob sieve_maxscriptsize
5035
5036 .. startblob sieve_maxscripts
5037
5038 ``sieve_maxscripts:`` 5
5039
5040 Maximum number of sieve scripts any user may have, enforced at
5041 submission by timsieved(8).
5042
5043 .. endblob sieve_maxscripts
5044
5045 .. startblob sieve_utf8fileinto
5046
5047 ``sieve_utf8fileinto:`` 0
5048
5049 If enabled, the sieve engine expects folder names for the
5050 *fileinto* action in scripts to use UTF8 encoding. Otherwise,
5051 modified UTF7 encoding should be used.
5052
5053 .. endblob sieve_utf8fileinto
5054
5055 .. startblob sieve_sasl_send_unsolicited_capability
5056
5057 ``sieve_sasl_send_unsolicited_capability:`` 1
5058
5059 Deprecated: this option does nothing.
5060
5061
5062 .. endblob sieve_sasl_send_unsolicited_capability
5063
5064 .. startblob sieve_use_lmtp_reject
5065
5066 ``sieve_use_lmtp_reject:`` 1
5067
5068 Enabled by default. If reject can be done via LMTP, then return a 550
5069 rather than generating the bounce message in Cyrus.
5070
5071 .. endblob sieve_use_lmtp_reject
5072
5073 .. startblob sieve_vacation_min_response
5074
5075 ``sieve_vacation_min_response:`` 3d
5076
5077 Minimum time interval between consecutive vacation responses, per :rfc:`6131`.
5078 The default is 3 days.
5079
5080 For backward compatibility, if no unit is specified, seconds is
5081 assumed.
5082
5083 .. endblob sieve_vacation_min_response
5084
5085 .. startblob sieve_vacation_max_response
5086
5087 ``sieve_vacation_max_response:`` 90d
5088
5089 Maximum time interval between consecutive vacation responses, per :rfc:`6131`.
5090 The default is 90 days. The minimum is 7 days.
5091
5092 For backward compatibility, if no unit is specified, seconds is
5093 assumed.
5094
5095 .. endblob sieve_vacation_max_response
5096
5097 .. startblob sievedir
5098
5099 ``sievedir:`` /usr/sieve
5100
5101 If sieveusehomedir is false, this directory is searched for Sieve
5102 scripts.
5103
5104 .. endblob sievedir
5105
5106 .. startblob sievenotifier
5107
5108 ``sievenotifier:`` <none>
5109
5110 Notifyd(8) method to use for "SIEVE" notifications. If not set, "SIEVE"
5111 notifications are disabled.
5112
5113 This method is only used when no method is specified in the script.
5114
5115 .. endblob sievenotifier
5116
5117 .. startblob sieveusehomedir
5118
5119 ``sieveusehomedir:`` 0
5120
5121 If enabled, lmtpd will look for Sieve scripts in user's home
5122 directories: ~user/.sieve.
5123
5124 .. endblob sieveusehomedir
5125
5126 .. startblob anysievefolder
5127
5128 ``anysievefolder:`` 0
5129
5130 It must be "yes" in order to permit the autocreation of any INBOX subfolder
5131 requested by a sieve filter, through the "fileinto" action.
5132
5133 .. endblob anysievefolder
5134
5135 .. startblob singleinstancestore
5136
5137 ``singleinstancestore:`` 1
5138
5139 If enabled, imapd, lmtpd and nntpd attempt to only write one copy
5140 of a message per partition and create hard links, resulting in a
5141 potentially large disk savings.
5142
5143 .. endblob singleinstancestore
5144
5145 .. startblob skiplist_always_checkpoint
5146
5147 ``skiplist_always_checkpoint:`` 1
5148
5149 If enabled, this option forces the skiplist cyrusdb backend to
5150 always checkpoint when doing a recovery. This causes slightly
5151 more IO, but on the other hand leads to more efficient databases,
5152 and the entire file is already "hot".
5153
5154 .. endblob skiplist_always_checkpoint
5155
5156 .. startblob skiplist_unsafe
5157
5158 ``skiplist_unsafe:`` 0
5159
5160 If enabled, this option forces the skiplist cyrusdb backend to
5161 not sync writes to the disk. Enabling this option is NOT RECOMMENDED.
5162
5163 .. endblob skiplist_unsafe
5164
5165 .. startblob smtp_backend
5166
5167 ``smtp_backend:`` sendmail
5168
5169 The SMTP backend to use for sending email.
5170
5171 The \"host\" backend sends message submissions via
5172 a TCP socket to the SMTP host defined in the config
5173 option smtp_host.
5174
5175 The \"sendmail\" backend forks the Cyrus process into
5176 the executable defined in the config option sendmail.
5177 The executable must accept \"-bs\" as command line
5178 argument, read from stdin and must implement the minimum
5179 SMTP protocol as defined in section 4.5.1 of :rfc:`5321`.
5180
5181 If the SMTP EHLO command reports AUTH (:rfc:`4954`) as a
5182 supported extension, then the MAIL FROM command includes
5183 the AUTH parameter, with its value set to the name of any
5184 authenticated user which triggered the email. The AUTH
5185 parameter is omitted if the user is unknown to the calling
5186 process.
5187
5188 If the directory
5189 *configdirectory*/log/smtpclient.\ *smtp_backend*
5190 exists, then telemetry logs for outgoing SMTP sessions will
5191 be created in this directory.
5192
5193 Allowed values: *host*, *sendmail*
5194
5195
5196 .. endblob smtp_backend
5197
5198 .. startblob smtp_host
5199
5200 ``smtp_host:`` localhost:587
5201
5202 The SMTP host to use for sending mail (also see the
5203 smtp_backend option). The value of this option must
5204 the name or IP address of a TCP host, followed optionally
5205 by a colon and the port or service to use. The default
5206 port is 587. TLS may be activated by appending \"/tls\"
5207 to the value. Authentication is enabled if smtp_auth_authname
5208 is set. Authentication can be explicitly disabled by appending
5209 \"/noauth\" to the host address.
5210
5211 .. endblob smtp_host
5212
5213 .. startblob smtp_auth_authname
5214
5215 ``smtp_auth_authname:`` <none>
5216
5217 The authentication name to use when authenticating to the SMTP
5218 server defined in smtp_host.
5219
5220 .. endblob smtp_auth_authname
5221
5222 .. startblob smtp_auth_password
5223
5224 ``smtp_auth_password:`` <none>
5225
5226 The password to use when authenticating to the SMTP server defined
5227 in smtp_host.
5228
5229 .. endblob smtp_auth_password
5230
5231 .. startblob smtp_auth_realm
5232
5233 ``smtp_auth_realm:`` <none>
5234
5235 The authentication SASL realm to use when authenticating to a SMTP
5236 server.
5237
5238 .. endblob smtp_auth_realm
5239
5240 .. startblob soft_noauth
5241
5242 ``soft_noauth:`` 1
5243
5244 If enabled, lmtpd returns temporary failures if the client does not
5245 successfully authenticate. Otherwise lmtpd returns permanent failures
5246 (causing the mail to bounce immediately).
5247
5248 .. endblob soft_noauth
5249
5250 .. startblob sortcache_db
5251
5252 ``sortcache_db:`` twoskip
5253
5254 The cyrusdb backend to use for caching sort results (currently only
5255 used for xconvmultisort).
5256 Allowed values: *skiplist*, *twoskip*, *zeroskip*
5257
5258
5259 .. endblob sortcache_db
5260
5261 .. startblob specialuse_extra
5262
5263 ``specialuse_extra:`` <none>
5264
5265 Whitespace separated list of extra special-use attributes
5266 that can be set on a mailbox. :rfc:`6154` currently lists
5267 what special-use attributes can be set. This allows
5268 extending that list in the future or adding your own
5269 if needed.
5270
5271 .. endblob specialuse_extra
5272
5273 .. startblob specialuse_nochildren
5274
5275 ``specialuse_nochildren:`` \\Scheduled \\Snooze
5276
5277 Whitespace separated list of special-use attributes that may not contain
5278 child folders. If set, mailboxes with any of these attributes may not
5279 have child folders created, and these attributes cannot be added to
5280 mailboxes that already have children.
5281
5282 .. endblob specialuse_nochildren
5283
5284 .. startblob specialuse_protect
5285
5286 ``specialuse_protect:`` \\Archive \\Drafts \\Important \\Junk \\Sent \\Scheduled \\Snooze \\Trash
5287
5288 Whitespace separated list of special-use attributes
5289 to protect the mailboxes for. If set, don't allow
5290 mailboxes with these special use attributes to be deleted
5291 or renamed to have a different parent. Default is the built-in list
5292
5293 .. endblob specialuse_protect
5294
5295 .. startblob specialusealways
5296
5297 ``specialusealways:`` 1
5298
5299 If enabled, this option causes unextended LIST and LSUB output to
5300 include the "special-use" flags.
5301
5302 .. endblob specialusealways
5303
5304 .. startblob sql_database
5305
5306 ``sql_database:`` <none>
5307
5308 Name of the database which contains the cyrusdb table(s).
5309
5310
5311 .. endblob sql_database
5312
5313 .. startblob sql_engine
5314
5315 ``sql_engine:`` <none>
5316
5317 Name of the SQL engine to use.
5318
5319 Allowed values: *mysql*, *pgsql*, *sqlite*
5320
5321
5322 .. endblob sql_engine
5323
5324 .. startblob sql_hostnames
5325
5326 ``sql_hostnames:`` <empty string>
5327
5328 Comma separated list of SQL servers (in host[:port] format).
5329
5330
5331 .. endblob sql_hostnames
5332
5333 .. startblob sql_passwd
5334
5335 ``sql_passwd:`` <none>
5336
5337 Password to use for authentication to the SQL server.
5338
5339
5340 .. endblob sql_passwd
5341
5342 .. startblob sql_user
5343
5344 ``sql_user:`` <none>
5345
5346 Username to use for authentication to the SQL server.
5347
5348
5349 .. endblob sql_user
5350
5351 .. startblob sql_usessl
5352
5353 ``sql_usessl:`` 0
5354
5355 If enabled, a secure connection will be made to the SQL server.
5356
5357
5358 .. endblob sql_usessl
5359
5360 .. startblob srs_alwaysrewrite
5361
5362 ``srs_alwaysrewrite:`` 0
5363
5364 If true, perform SRS rewriting for ALL forwarding, even when not required.
5365
5366
5367 .. endblob srs_alwaysrewrite
5368
5369 .. startblob srs_domain
5370
5371 ``srs_domain:`` <none>
5372
5373 The domain to use in rewritten addresses. This must point only to machines
5374 which know the encoding secret used by this system. When present, SRS is
5375 enabled.
5376
5377 .. endblob srs_domain
5378
5379 .. startblob srs_hashlength
5380
5381 ``srs_hashlength:`` 0
5382
5383 The hash length to generate in a rewritten address.
5384
5385
5386 .. endblob srs_hashlength
5387
5388 .. startblob srs_secrets
5389
5390 ``srs_secrets:`` <none>
5391
5392 A list of secrets with which to generate addresses.
5393
5394
5395 .. endblob srs_secrets
5396
5397 .. startblob srs_separator
5398
5399 ``srs_separator:`` <none>
5400
5401 The separator to appear immediately after SRS[01] in rewritten addresses.
5402
5403
5404 .. endblob srs_separator
5405
5406 .. startblob srvtab
5407
5408 ``srvtab:`` <empty string>
5409
5410 Deprecated: This option does nothing.
5411
5412
5413 .. endblob srvtab
5414
5415 .. startblob submitservers
5416
5417 ``submitservers:`` <none>
5418
5419 A list of users and groups that are allowed to resolve "urlauth=submit+"
5420 IMAP URLs, separated by spaces. Any user listed in this will be
5421 allowed to fetch the contents of any valid "urlauth=submit+" IMAP URL:
5422 use with caution.
5423
5424 .. endblob submitservers
5425
5426 .. startblob subscription_db
5427
5428 ``subscription_db:`` flat
5429
5430 The cyrusdb backend to use for the subscriptions list.
5431
5432 Allowed values: *flat*, *skiplist*, *twoskip*, *zeroskip*
5433
5434
5435 .. endblob subscription_db
5436
5437 .. startblob suppress_capabilities
5438
5439 ``suppress_capabilities:`` <none>
5440
5441 Suppress the named capabilities from any capability response. Use the
5442 exact case as it appears in the response, e.g.
5443 "suppress_capabilities: ESEARCH QRESYNC WITHIN XLIST LIST-EXTENDED"
5444 if you have a murder with 2.3.x backends and don't want clients being
5445 confused by new capabilities that some backends don't support.
5446
5447 .. endblob suppress_capabilities
5448
5449 .. startblob statuscache
5450
5451 ``statuscache:`` 0
5452
5453 Enable/disable the imap status cache.
5454
5455
5456 .. endblob statuscache
5457
5458 .. startblob statuscache_db
5459
5460 ``statuscache_db:`` twoskip
5461
5462 The cyrusdb backend to use for the imap status cache.
5463
5464 Allowed values: *skiplist*, *sql*, *twoskip*, *zeroskip*
5465
5466
5467 .. endblob statuscache_db
5468
5469 .. startblob statuscache_db_path
5470
5471 ``statuscache_db_path:`` <none>
5472
5473 The absolute path to the statuscache db file. If not specified,
5474 will be configdirectory/statuscache.db
5475
5476 .. endblob statuscache_db_path
5477
5478 .. startblob sync_authname
5479
5480 ``sync_authname:`` <none>
5481
5482 The authentication name to use when authenticating to a sync server.
5483 Prefix with a channel name to only apply for that channel.
5484
5485 .. endblob sync_authname
5486
5487 .. startblob sync_batchsize
5488
5489 ``sync_batchsize:`` 8192
5490
5491 the number of messages to upload in a single mailbox replication.
5492 Default is 8192. If there are more than this many messages appended
5493 to the mailbox, generate a synthetic partial state and send that.
5494
5495 .. endblob sync_batchsize
5496
5497 .. startblob sync_cache_db
5498
5499 ``sync_cache_db:`` twoskip
5500
5501 The cyrusdb backend to use for the replication cache.
5502
5503 Allowed values: *skiplist*, *sql*, *twoskip*, *zeroskip*
5504
5505
5506 .. endblob sync_cache_db
5507
5508 .. startblob sync_cache_db_path
5509
5510 ``sync_cache_db_path:`` <none>
5511
5512 The path for the replication cache. Prefix with a
5513 channel name to apply for that channel. NOTE, it's
5514 quite important to have a different one per backend!
5515
5516 .. endblob sync_cache_db_path
5517
5518 .. startblob sync_host
5519
5520 ``sync_host:`` <none>
5521
5522 Name of the host (replica running sync_server(8)) to which
5523 replication actions will be sent by sync_client(8).
5524 Prefix with a channel name to only apply for that channel.
5525
5526 .. endblob sync_host
5527
5528 .. startblob sync_log
5529
5530 ``sync_log:`` 0
5531
5532 Enable replication action logging by lmtpd(8), imapd(8), pop3d(8),
5533 and nntpd(8). The log {configdirectory}/sync/log is used by
5534 sync_client(8) for "rolling" replication.
5535
5536 .. endblob sync_log
5537
5538 .. startblob sync_log_chain
5539
5540 ``sync_log_chain:`` 0
5541
5542 Enable replication action logging by sync_server as well, allowing
5543 chaining of replicas. Use this on 'B' for A => B => C replication layout.
5544
5545 .. endblob sync_log_chain
5546
5547 .. startblob sync_log_channels
5548
5549 ``sync_log_channels:`` <none>
5550
5551 If specified, log all events to multiple log files in directories
5552 specified by each "channel". Each channel can then be processed
5553 separately, such as by multiple sync_client(8)s in a mesh replication
5554 scheme, or by squatter(8) for rolling search index updates.
5555
5556 You can use "" (the two-character string U+22 U+22) to mean the
5557 default sync channel.
5558
5559 .. endblob sync_log_channels
5560
5561 .. startblob sync_log_unsuppressable_channels
5562
5563 ``sync_log_unsuppressable_channels:`` squatter
5564
5565 If specified, the named channels are exempt from the effect of setting
5566 sync_log_chain:off, i.e. they are always logged to by the sync_server
5567 process. This is only really useful to allow rolling search indexing
5568 on a replica.
5569
5570 .. endblob sync_log_unsuppressable_channels
5571
5572 .. startblob sync_password
5573
5574 ``sync_password:`` <none>
5575
5576 The default password to use when authenticating to a sync server.
5577 Prefix with a channel name to only apply for that channel.
5578
5579 .. endblob sync_password
5580
5581 .. startblob sync_port
5582
5583 ``sync_port:`` <none>
5584
5585 Name of the service (or port number) of the replication service on
5586 replica host. Prefix with a channel name to only apply for that
5587 channel. If not specified, and if sync_try_imap is set to "yes"
5588 (the default), then the replication client will first try "imap"
5589 (port 143) to check if imapd supports replication. Otherwise it
5590 will default to "csync" (usually port 2005).
5591
5592 .. endblob sync_port
5593
5594 .. startblob sync_realm
5595
5596 ``sync_realm:`` <none>
5597
5598 The authentication realm to use when authenticating to a sync server.
5599 Prefix with a channel name to only apply for that channel.
5600
5601 .. endblob sync_realm
5602
5603 .. startblob sync_reconnect_maxwait
5604
5605 ``sync_reconnect_maxwait:`` 20m
5606
5607 When sync_client cannot connect to the replica, it enters a retry
5608 loop with an exponential backoff between attempts. This option sets
5609 the upper limit on that exponential backoff: no matter how long the
5610 replica has been down so far, sync_client will never wait longer than
5611 sync_reconnect_maxwait between retries.
5612
5613 If this is zero or negative, the backoff duration will be allowed
5614 to increase indefinitely (not recommended).
5615
5616 If no unit is specified, seconds is assumed.
5617
5618 .. endblob sync_reconnect_maxwait
5619
5620 .. startblob sync_repeat_interval
5621
5622 ``sync_repeat_interval:`` 1s
5623
5624 Minimum interval between replication runs in rolling replication
5625 mode. If a replication run takes longer than this time, we repeat
5626 immediately. Prefix with a channel name to only apply for that
5627 channel.
5628
5629 For backward compatibility, if no unit is specified, seconds is
5630 assumed.
5631
5632 .. endblob sync_repeat_interval
5633
5634 .. startblob sync_rightnow_channel
5635
5636 ``sync_rightnow_channel:`` <none>
5637
5638 if set, run sync_client to this channel immediately. As with channels,
5639 set this value to '""' to sync the default channel!
5640
5641 .. endblob sync_rightnow_channel
5642
5643 .. startblob sync_shutdown_file
5644
5645 ``sync_shutdown_file:`` <none>
5646
5647 Simple latch used to tell sync_client(8) that it should shut down at the
5648 next opportunity. Safer than sending signals to running processes.
5649 Prefix with a channel name to only apply for that channel.
5650
5651 .. endblob sync_shutdown_file
5652
5653 .. startblob sync_timeout
5654
5655 ``sync_timeout:`` 30m
5656
5657 How long to wait for a response before returning a timeout failure
5658 when talking to a replication peer (client or server). The minimum
5659 duration is 3 seconds, the default is 30 minutes.
5660
5661 For backward compatibility, if no unit is specified, seconds is
5662 assumed.
5663
5664 .. endblob sync_timeout
5665
5666 .. startblob sync_try_imap
5667
5668 ``sync_try_imap:`` 1
5669
5670 Whether sync_client should try to perform an IMAP connection
5671 before falling back to csync. If this is set to "no",
5672 sync_client will only use csync. Prefix with a channel name to
5673 apply only for that channel.
5674
5675 .. endblob sync_try_imap
5676
5677 .. startblob syslog_prefix
5678
5679 ``syslog_prefix:`` <none>
5680
5681 String to be prepended to the process name in syslog entries. Can
5682 be further overridden by setting the $CYRUS_SYSLOG_PREFIX environment
5683 variable.
5684
5685 Using the $CYRUS_SYSLOG_PREFIX environment variable has the additional
5686 advantage that it can be set before the **imapd.conf** is read, so
5687 errors while reading the config file can be syslogged with the correct
5688 prefix.
5689
5690 .. endblob syslog_prefix
5691
5692 .. startblob syslog_facility
5693
5694 ``syslog_facility:`` <none>
5695
5696 Configure a syslog facility. The default is whatever is compiled
5697 in. Allowed values are: DAEMON, MAIL, NEWS, USER, and LOCAL0
5698 through to LOCAL7
5699
5700 .. endblob syslog_facility
5701
5702 .. startblob tcp_keepalive
5703
5704 ``tcp_keepalive:`` 0
5705
5706 Enable keepalive on TCP connections.
5707
5708
5709 .. endblob tcp_keepalive
5710
5711 .. startblob tcp_keepalive_cnt
5712
5713 ``tcp_keepalive_cnt:`` 0
5714
5715 Number of TCP keepalive probes to send before declaring the
5716 connection dead (0 == system default).
5717
5718 .. endblob tcp_keepalive_cnt
5719
5720 .. startblob tcp_keepalive_idle
5721
5722 ``tcp_keepalive_idle:`` 0
5723
5724 How long a connection must be idle before keepalive probes are sent
5725 (0 == system default).
5726
5727 For backward compatibility, if no unit is specified, seconds is
5728 assumed.
5729
5730 .. endblob tcp_keepalive_idle
5731
5732 .. startblob tcp_keepalive_intvl
5733
5734 ``tcp_keepalive_intvl:`` 0
5735
5736 Time between keepalive probes (0 == system default).
5737
5738 For backward compatibility, if no unit is specified, seconds is
5739 assumed.
5740
5741 .. endblob tcp_keepalive_intvl
5742
5743 .. startblob temp_path
5744
5745 ``temp_path:`` /tmp
5746
5747 The pathname to store temporary files in. It is recommended to
5748 use an in-memory filesystem such as tmpfs for this path.
5749
5750 .. endblob temp_path
5751
5752 .. startblob telemetry_bysessionid
5753
5754 ``telemetry_bysessionid:`` 0
5755
5756 If true, log by sessionid instead of PID for telemetry.
5757
5758
5759 .. endblob telemetry_bysessionid
5760
5761 .. startblob timeout
5762
5763 ``timeout:`` 32m
5764
5765 The length of the IMAP server's inactivity autologout timer.
5766 The minimum value is 30 minutes. The default is 32 minutes,
5767 to allow a bit of leeway for clients that try to NOOP every
5768 30 minutes.
5769
5770 For backward compatibility, if no unit is specified, minutes
5771 is assumed.
5772
5773 .. endblob timeout
5774
5775 .. startblob imapidletimeout
5776
5777 ``imapidletimeout:`` <none>
5778
5779 Timeout for idling clients (:rfc:`2177`). If not set (the default),
5780 the value of "timeout" will be used instead.
5781
5782 For backward compatibility, if no unit is specified, minutes
5783 is assumed.
5784
5785 .. endblob imapidletimeout
5786
5787 .. startblob tls_ca_file
5788
5789 ``tls_ca_file:`` <none>
5790
5791 Deprecated in favor of *tls_client_ca_file*.
5792
5793
5794 .. endblob tls_ca_file
5795
5796 .. startblob tls_ca_path
5797
5798 ``tls_ca_path:`` <none>
5799
5800 Deprecated in favor of *tls_client_ca_dir*.
5801
5802
5803 .. endblob tls_ca_path
5804
5805 .. startblob tlscache_db
5806
5807 ``tlscache_db:`` twoskip
5808
5809 Deprecated in favor of *tls_sessions_db*.
5810
5811
5812 .. endblob tlscache_db
5813
5814 .. startblob tlscache_db_path
5815
5816 ``tlscache_db_path:`` <none>
5817
5818 Deprecated in favor of *tls_sessions_db_path*.
5819
5820
5821 .. endblob tlscache_db_path
5822
5823 .. startblob tls_cert_file
5824
5825 ``tls_cert_file:`` <none>
5826
5827 Deprecated in favor of *tls_server_cert*.
5828
5829
5830 .. endblob tls_cert_file
5831
5832 .. startblob tls_cipher_list
5833
5834 ``tls_cipher_list:`` DEFAULT
5835
5836 Deprecated in favor of *tls_ciphers*.
5837
5838
5839 .. endblob tls_cipher_list
5840
5841 .. startblob tls_ciphers
5842
5843 ``tls_ciphers:`` DEFAULT
5844
5845 The list of SSL/TLS ciphers to allow. The format of the string
5846 (and definition of "DEFAULT") is described in **ciphers(1)**.
5847
5848 See also Mozilla's server-side TLS recommendations:
5849
5850 https://wiki.mozilla.org/Security/Server_Side_TLS .
5851
5852 .. endblob tls_ciphers
5853
5854 .. startblob tls_crl_file
5855
5856 ``tls_crl_file:`` <none>
5857
5858 Path to a file containing the Certificate Revocation List.
5859
5860
5861 .. endblob tls_crl_file
5862
5863 .. startblob tls_client_ca_dir
5864
5865 ``tls_client_ca_dir:`` <none>
5866
5867 Path to a directory containing the CA certificates used to verify
5868 client SSL certificates used for authentication.
5869
5870 .. endblob tls_client_ca_dir
5871
5872 .. startblob tls_client_ca_file
5873
5874 ``tls_client_ca_file:`` <none>
5875
5876 Path to a file containing the CA certificate(s) used to verify
5877 client SSL certificates used for authentication.
5878
5879 .. endblob tls_client_ca_file
5880
5881 .. startblob tls_client_cert
5882
5883 ``tls_client_cert:`` <none>
5884
5885 File containing the certificate presented to a server for authentication
5886 during STARTTLS. A value of "disabled" will disable this server's use
5887 of certificate-based authentication.
5888
5889 .. endblob tls_client_cert
5890
5891 .. startblob tls_client_certs
5892
5893 ``tls_client_certs:`` optional
5894
5895 Disable ("off"), allow ("optional", default) or require ("require") the
5896 use of SSL certificates by clients to authenticate themselves.
5897 Allowed values: *off*, *optional*, *require*
5898
5899
5900 .. endblob tls_client_certs
5901
5902 .. startblob tls_client_key
5903
5904 ``tls_client_key:`` <none>
5905
5906 File containing the private key belonging to the tls_client_cert
5907 certificate. A value of "disabled" will disable this server's use
5908 of certificate-based authentication.
5909
5910 .. endblob tls_client_key
5911
5912 .. startblob tls_eccurve
5913
5914 ``tls_eccurve:`` prime256v1
5915
5916 The elliptic curve used for ECDHE. Default is NIST Suite B prime256.
5917 See 'openssl ecparam -list_curves' for possible values.
5918
5919 .. endblob tls_eccurve
5920
5921 .. startblob tls_key_file
5922
5923 ``tls_key_file:`` <none>
5924
5925 Deprecated in favor of *tls_server_key*.
5926
5927
5928 .. endblob tls_key_file
5929
5930 .. startblob tls_required
5931
5932 ``tls_required:`` 0
5933
5934 If enabled, require a TLS/SSL encryption layer to be negotiated
5935 prior to ANY authentication mechanisms being advertised or allowed.
5936
5937 .. endblob tls_required
5938
5939 .. startblob tls_prefer_server_ciphers
5940
5941 ``tls_prefer_server_ciphers:`` 0
5942
5943 Prefer the ciphers on the server side instead of client side.
5944
5945
5946 .. endblob tls_prefer_server_ciphers
5947
5948 .. startblob tls_server_ca_dir
5949
5950 ``tls_server_ca_dir:`` <none>
5951
5952 Path to a directory with CA certificates used to verify certificates
5953 offered by the server, when cyrus acts as client. This directory must
5954 have filenames with the hashed value of the certificates (see
5955 openssl(1)).
5956
5957 .. endblob tls_server_ca_dir
5958
5959 .. startblob tls_server_ca_file
5960
5961 ``tls_server_ca_file:`` <none>
5962
5963 Path to a file containing CA certificates used to verify certificates
5964 offered by the server, when cyrus acts as client.
5965
5966 .. endblob tls_server_ca_file
5967
5968 .. startblob tls_server_cert
5969
5970 ``tls_server_cert:`` <none>
5971
5972 File containing the certificate, including the full chain, presented to clients.
5973 Two certificates can be set, e.g RSA and EC, if the filenames are separated with
5974 comma without spaces.
5975
5976 .. endblob tls_server_cert
5977
5978 .. startblob tls_server_dhparam
5979
5980 ``tls_server_dhparam:`` <none>
5981
5982 File containing the DH parameters belonging to the certificate in
5983 tls_server_cert. Used by OpenSSL before version 3.0.
5984
5985 .. endblob tls_server_dhparam
5986
5987 .. startblob tls_server_key
5988
5989 ``tls_server_key:`` <none>
5990
5991 File containing the private key belonging to the certificate in
5992 tls_server_cert. If not set, tls_server_cert must contain both private and
5993 public key. Two files with keys can be set, if two certificates are used, in
5994 which case the files must be separated with comma without spaces.
5995
5996 .. endblob tls_server_key
5997
5998 .. startblob tls_sessions_db
5999
6000 ``tls_sessions_db:`` twoskip
6001
6002 The cyrusdb backend to use for the TLS cache.
6003
6004 Allowed values: *skiplist*, *sql*, *twoskip*, *zeroskip*
6005
6006
6007 .. endblob tls_sessions_db
6008
6009 .. startblob tls_sessions_db_path
6010
6011 ``tls_sessions_db_path:`` <none>
6012
6013 The absolute path to the TLS sessions db file. If not specified,
6014 will be configdirectory/tls_sessions.db
6015
6016 .. endblob tls_sessions_db_path
6017
6018 .. startblob tls_session_timeout
6019
6020 ``tls_session_timeout:`` 24h
6021
6022 The length of time that a TLS session will be cached for later
6023 reuse. The maximum value is 24 hours, also the default. A
6024 value of 0 will disable session caching.
6025
6026 For backward compatibility, if no unit is specified, minutes is
6027 assumed.
6028
6029 .. endblob tls_session_timeout
6030
6031 .. startblob tls_versions
6032
6033 ``tls_versions:`` tls1_0 tls1_1 tls1_2 tls1_3
6034
6035 A list of SSL/TLS versions to not disable. Cyrus IMAP SSL/TLS starts
6036 with all protocols, and subtracts protocols not in this list. Newer
6037 versions of SSL/TLS will need to be added here to allow them to get
6038 disabled.
6039
6040 .. endblob tls_versions
6041
6042 .. startblob uidl_format
6043
6044 ``uidl_format:`` cyrus
6045
6046 Choose the format for UIDLs in pop3. Possible values are "uidonly",
6047 "cyrus", "dovecot" and "courier". "uidonly" forces the old default
6048 of UID, "cyrus" is UIDVALIDITY.UID. Dovecot is 8 digits of leading
6049 hex (lower case) each UID UIDVALIDITY. Courier is UIDVALIDITY-UID.
6050 Allowed values: *uidonly*, *cyrus*, *dovecot*, *courier*
6051
6052
6053 .. endblob uidl_format
6054
6055 .. startblob umask
6056
6057 ``umask:`` 077
6058
6059 The umask value used by various Cyrus IMAP programs.
6060
6061
6062 .. endblob umask
6063
6064 .. startblob userdeny_db
6065
6066 ``userdeny_db:`` flat
6067
6068 The cyrusdb backend to use for the user access list.
6069
6070 Allowed values: *flat*, *skiplist*, *sql*, *twoskip*, *zeroskip*
6071
6072
6073 .. endblob userdeny_db
6074
6075 .. startblob userdeny_db_path
6076
6077 ``userdeny_db_path:`` <none>
6078
6079 The absolute path to the userdeny db file. If not specified,
6080 will be configdirectory/user_deny.db
6081
6082 .. endblob userdeny_db_path
6083
6084 .. startblob username_tolower
6085
6086 ``username_tolower:`` 1
6087
6088 Convert usernames to all lowercase before login/authentication. This
6089 is useful with authentication backends which ignore case during
6090 username lookups (such as LDAP).
6091
6092 .. endblob username_tolower
6093
6094 .. startblob userprefix
6095
6096 ``userprefix:`` Other Users
6097
6098 If using the alternate IMAP namespace, the prefix for the other users
6099 namespace. The hierarchy delimiter will be automatically appended.
6100
6101 .. endblob userprefix
6102
6103 .. startblob unix_group_enable
6104
6105 ``unix_group_enable:`` 1
6106
6107 Should we look up groups when using auth_unix (disable this if you are
6108 not using groups in ACLs for your IMAP server, and you are using auth_unix
6109 with a backend (such as LDAP) that can make getgrent() calls very
6110 slow).
6111
6112 .. endblob unix_group_enable
6113
6114 .. startblob unixhierarchysep
6115
6116 ``unixhierarchysep:`` 1
6117
6118 Use the UNIX separator character '/' for delimiting levels of
6119 mailbox hierarchy. Turn off to use the netnews separator
6120 character '.'. Note that with the newnews separator, no dots may
6121 occur in mailbox names. The default switched in 3.0 from off to on.
6122
6123 .. endblob unixhierarchysep
6124
6125 .. startblob vcard_max_size
6126
6127 ``vcard_max_size:`` 0
6128
6129 Maximum allowed vCard size.
6130 If non-zero, CardDAV and JMAP will reject storage of contacts whose
6131 vCard representation is larger than *vcard_max_size*.
6132
6133 If set to 0 (the default), a large internally-defined limit will be applied.
6134
6135 If no unit is specified, bytes is assumed.
6136
6137 .. endblob vcard_max_size
6138
6139 .. startblob virtdomains
6140
6141 ``virtdomains:`` off
6142
6143 Configure virtual domain support.
6144
6145 off
6146 Cyrus does not know or care about domains. Only the local part of email
6147 addresses is ever considered. This is not recommended for any deployment,
6148 but is currently the default.
6149
6150 userid
6151 The user's domain is determined by splitting a fully qualified userid at the
6152 last '@' or '%' symbol. If the userid is unqualified, the *defaultdomain*
6153 will be used. This is the recommended configuration for all deployments.
6154 If you wish to provide calendaring services you must use this configuration.
6155
6156 on
6157 Fully qualified userids are respected, as per "userid". Unqualified userids
6158 will have their domain determined by doing a reverse lookup on the IP address
6159 of the incoming network interface, or if no record is found, the
6160 *defaultdomain* will be used.
6161
6162
6163
6164 Allowed values: *off*, *userid*, *on*
6165
6166
6167 .. endblob virtdomains
6168
6169 .. startblob virusscan_notification_subject
6170
6171 ``virusscan_notification_subject:`` Automatically deleted mail
6172
6173 The text used in the subject of email notifications created by
6174 **cyr_virusscan(8)** when deleting infected mail.
6175
6176 .. endblob virusscan_notification_subject
6177
6178 .. startblob virusscan_notification_template
6179
6180 ``virusscan_notification_template:`` <none>
6181
6182 The absolute path to a file containing a template to use to describe
6183 infected messages that have been deleted by **cyr_virusscan(8)**.
6184 See **cyr_virusscan(8)** for specification of the format of this file.
6185 If not specified, the builtin default template will be used.
6186
6187 .. endblob virusscan_notification_template
6188
6189 .. startblob websocket_timeout
6190
6191 ``websocket_timeout:`` 30m
6192
6193 Set the length of the HTTP server's inactivity autologout timer
6194 when a WebSocket channel has been established.
6195 The default is 30 minutes. The minimum value is 0, which will
6196 disable WebSockets.
6197
6198 If no unit is specified, minutes is assumed.
6199
6200 .. endblob websocket_timeout
6201
6202 .. startblob webdav_attachments_baseurl
6203
6204 ``webdav_attachments_baseurl:`` <none>
6205
6206 The base URL for WebDAV managed attachments, excluding the
6207 Cyrus-specific URL paths. Typically, this only includes the
6208 HTTP scheme and host name at which DAV clients may fetch
6209 managed attachments from, e.g. "https://dav.example.com".
6210 If not specified, the target host of the DAV HTTP request that uploaded
6211 the attachment will be used. For JMAP, the Link.blobId property of
6212 JSCalendar objects will be disabled.
6213
6214 .. endblob webdav_attachments_baseurl
6215
6216 .. startblob webdav_attachments_max_binary_attach_size
6217
6218 ``webdav_attachments_max_binary_attach_size:`` 1024K
6219
6220 The maximum byte length of an ATTACH property value when managed attachment
6221 URIs get rewritten to BINARY during iTIP processing. Any attachment that
6222 exceeds this byte size keeps its managed attachment URI as ATTACH value. A
6223 zero size limit causes attachments of any size be rewritten as BINARY.
6224
6225 .. endblob webdav_attachments_max_binary_attach_size
6226
6227 .. startblob xbackup_enabled
6228
6229 ``xbackup_enabled:`` 0
6230
6231 Deprecated. No longer used.
6232
6233
6234 .. endblob xbackup_enabled
6235
6236 .. startblob xlist-flag
6237
6238 ``xlist-flag:`` <none>
6239
6240 Set the special-use flag *flag* on the specified folder when it
6241 is autocreated (see the *autocreate_inbox_folders* option). For
6242 example, if **xlist-junk: Spam** is set, and the folder **Spam**
6243 is autocreated, the special-use flag **\\Junk** will be set on it.
6244
6245 (This option is so named for backward compatibility with old config
6246 files.)
6247
6248
6249 .. endblob xlist-flag
6250
6251 .. startblob lmtp_catchall_mailbox
6252
6253 ``lmtp_catchall_mailbox:`` <none>
6254
6255 Mail sent to mailboxes which do not exist, will be delivered to
6256 this user. NOTE: This must be an existing local user name with an
6257 INBOX, NOT an email address!
6258
6259 .. endblob lmtp_catchall_mailbox
6260
6261 .. startblob zoneinfo_db
6262
6263 ``zoneinfo_db:`` twoskip
6264
6265 The cyrusdb backend to use for zoneinfo. This database is used by the
6266 "tzdist" *httpmodules*, and is managed by **ctl_zoneinfo(8)**.
6267 Allowed values: *flat*, *skiplist*, *twoskip*, *zeroskip*
6268
6269
6270 .. endblob zoneinfo_db
6271
6272 .. startblob zoneinfo_db_path
6273
6274 ``zoneinfo_db_path:`` <none>
6275
6276 The absolute path to the zoneinfo db file. If not specified,
6277 will be configdirectory/zoneinfo.db
6278
6279 .. endblob zoneinfo_db_path
6280
6281 .. startblob zoneinfo_dir
6282
6283 ``zoneinfo_dir:`` <none>
6284
6285 The absolute path to the zoneinfo directory, containing timezone
6286 definitions as generated by the vzic tool. This overrides any compile-time
6287 value that was set with the **--with-zoneinfo-dir** configure option.
6288
6289 If not specified, and no compile-time value was set, then whatever
6290 definitions libical finds will be used.
6291
6292 If you are providing a Time Zone Data Distribution Service (i.e. you have
6293 "tzdist" listed in *httpmodules*), then this configuration option
6294 or a compile time value MUST be specified.
6295
6296 .. endblob zoneinfo_dir
6297
6298 .. startblob object_storage_enabled
6299
6300 ``object_storage_enabled:`` 0
6301
6302 Is Object storage enabled for this server. You also need to have
6303 archiving enabled and archivepartition for the mailbox.
6304 Only email files will be stored on object Storage archive partition will be
6305 used to store any other files.
6306
6307 .. endblob object_storage_enabled
6308
6309 .. startblob object_storage_dummy_spool
6310
6311 ``object_storage_dummy_spool:`` <none>
6312
6313 Dummy object storage spool; this is for test only.
6314 Spool where user directory (container) will be created to store all emails
6315 in a flat structure.
6316
6317 .. endblob object_storage_dummy_spool
6318
6319 .. startblob openio_namespace
6320
6321 ``openio_namespace:`` <none>
6322
6323 The OpenIO namespace used to store archived email messages. A namespace
6324 identifies the physical platform cyrus must contact. This directive is used
6325 by the OpenIO's SDK to locate its platform entry point.
6326
6327 .. endblob openio_namespace
6328
6329 .. startblob openio_account
6330
6331 ``openio_account:`` <none>
6332
6333 The OpenIO account used to account for stored emails. Accounts are unique
6334 in their namespace. They provides virtual partitions, with quotas and QoS
6335 features.
6336
6337 .. endblob openio_account
6338
6339 .. startblob openio_rawx_timeout
6340
6341 ``openio_rawx_timeout:`` 30s
6342
6343 The OpenIO timeout to query to the RAWX services (default 30 sec).
6344
6345
6346 .. endblob openio_rawx_timeout
6347
6348 .. startblob openio_proxy_timeout
6349
6350 ``openio_proxy_timeout:`` 5s
6351
6352 The OpenIO timeout to query to the PROXY services (default 5 sec).
6353
6354
6355 .. endblob openio_proxy_timeout
6356
6357 .. startblob openio_autocreate
6358
6359 ``openio_autocreate:`` 0
6360
6361 Allow the OpenIO SDK to autocreate containers. Mainly destined to be turned
6362 on development environments. In production, the container should have been
6363 provisioned with the mailboxes.
6364
6365 .. endblob openio_autocreate
6366
6367 .. startblob openio_verbosity
6368
6369 ``openio_verbosity:`` <none>
6370
6371 Sets the logging verbosity of the OpenIO's internal behavior. Admissible
6372 values are: "warning", "notice", "info", "debug", "trace", "quiet".
6373 The default verbosity is "warning". Set to "notice" for a few lines on a
6374 per-client basis. Set to "info" for a few lines on a per-request basis. Set
6375 to "debug" Set to "trace" to activate the underlying libcurl debug
6376 output. Enabling a verbosity higher to equal than "debug" requires
6377 the cyrus to be set in debug mode. The special "quiet" value disables all
6378 kinds of logging at the GLib level.
6379
6380 .. endblob openio_verbosity
6381
6382 .. startblob caringo_hostname
6383
6384 ``caringo_hostname:`` <none>
6385
6386 The Caringo hostname used to store archived email messages. A hostname
6387 identifies the physical platform cyrus must contact. This directive is used
6388 by the Caringo's SDK (CastorSDK: Caringo Simple Content Storage Protocol (SCSP)
6389 on HTTP 1.1 using a RESTful architecture.
6390
6391 .. endblob caringo_hostname
6392
6393 .. startblob caringo_port
6394
6395 ``caringo_port:`` 80
6396
6397 The port of the caringo server (caringo_hostname); default is 80.
6398
6399
6400 .. endblob caringo_port
6401
6402 .. startblob fastmailsharing
6403
6404 ``fastmailsharing:`` 0
6405
6406 If enabled, use FastMail style sharing (oldschool full server paths).
6407
6408
6409 .. endblob fastmailsharing
6410
6411
6412 SEE ALSO
6413 ========
6414
6415
6416 **imapd(8)**, **pop3d(8)**, **nntpd(8)**, **lmtpd(8)**,
6417 **httpd(8)**, **timsieved(8)**, **idled(8)**, **notifyd(8)**,
6418 **deliver(8)**, **master(8)**, **ciphers(1)**
6419