Debian Codegraph @

doc/html/_sources/imap/reference/faqs/o-annotations.rst.txt

raw
1 .. _faqs-o-annotations:
2
3 What annotations are available?
4 -------------------------------
5
6 Cyrus annotations are based on :rfc:`5464`.
7
8 * **/admin** - Sets the administrator email address for the server. (See
9 :cyrusman:`cyradm(8)`)
10
11 * **/check** - Boolean value "true" or "false" that indicates whether this
12 mailbox should be checked at regular intervals by the client. The interval
13 in minutes is specified by the ``/checkperiod`` entry. (Draft RFC)
14
15 * **/checkperiod** - Numeric value indicating a period of minutes that the
16 client uses to determine the interval of regular 'new mail' checks for the
17 corresponding mailbox. (Draft RFC)
18
19 * **/comment** - Sets a comment or description associated with the mailbox.
20 (cyradm(8))
21
22 * **/motd** - Sets a "message of the day". The message gets displayed
23 as an ALERT after authentication.
24
25 * **/sort** - Defines the default sort criteria [I-D.ietf-imapext-sort] to use
26 when first displaying the mailbox contents to the user, or NIL if sorting is
27 not required. (Draft RFC)
28
29 * **/thread** - Defines the default thread criteria [I-D.ietf-imapext-sort] to
30 use when first displaying the mailbox contents to the user, or NIL if
31 threading is not required. If both sort and thread are not NIL, then
32 threading should take precedence over sorting. (Draft RFC)
33
34 * **/vendor/cmu/cyrus-imapd/condstore** - Enables the IMAP CONDSTORE extension
35 (modification sequences) on the mailbox. (See :cyrusman:`cyradm(8)`)
36
37 * **vendor/cmu/cyrus-imapd/duplicatedeliver** - Flag signalling that we're
38 allowing duplicate delivery of messages to the mailbox, overriding
39 system-wide duplicate suppression.
40 (:ref:`imap-developer-guidance-mailbox-format`)
41
42 * **/vendor/cmu/cyrus-imapd/expire** - Sets the number of days after which
43 messages will be expired from the mailbox. (cyradm(8))
44
45 * **/vendor/cmu/cyrus-imapd/archive** - Sets the number of days after which
46 messages will be archived from the mailbox. (cyradm(8))
47
48 * **/vendor/cmu/cyrus-imapd/delete** - Sets the number of days after which
49 messages will be deleted from the mailbox. (cyradm(8))
50
51 * **/vendor/cmu/cyrus-imapd/freespace** - Undocumented.
52
53 * **/vendor/cmu/cyrus-imapd/lastpop** - (time_t) of the last pop3 login to
54 this INBOX, used to enforce the "poptimeout" imapd.conf option.
55 (:ref:`imap-developer-guidance-mailbox-format`)
56
57 * **vendor/cmu/cyrus-imapd/lastupdate** - (time_t) of the last time a message
58 was appended
59 (:ref:`imap-developer-guidance-mailbox-format`)
60
61 * **/vendor/cmu/cyrus-imapd/news2mail** - Sets an email address to which
62 messages injected into the server via NNTP will be sent. (cyradm(8))
63
64 * **/vendor/cmu/cyrus-imapd/partition** - Undocumented.
65
66 * **/vendor/cmu/cyrus-imapd/pop3newuidl** - Flag signalling that we're using
67 "uidvalidity.uid" instead of just "uid" for the output of the POP3 UIDL
68 command.
69 (:ref:`imap-developer-guidance-mailbox-format`)
70
71 * **/vendor/cmu/cyrus-imapd/serve** - Undocumented.
72
73 * **/vendor/cmu/cyrus-imapd/sharedseen** - Enables the use of a shared \Seen
74 flag on messages rather than a per-user \Seen flag. The ’s’ right in the
75 mailbox ACL still controls whether a user can set the shared \Seen flag.
76 (See :cyrusman:`cyradm(8)`)
77
78 * **/vendor/cmu/cyrus-imapd/shutdown** - Sets a shutdown message. The message
79 gets displayed as an ALERT and all users are disconnected from the server
80 (subsequent logins are disallowed). (cyradm(8))
81
82 * **/vendor/cmu/cyrus-imapd/sieve** - Indicates the name of the global sieve
83 script that should be run when a message is delivered to the shared mailbox
84 (not used for personal mailboxes). (cyradm(8))
85
86 * **/vendor/cmu/cyrus-imapd/size** - Undocumented.
87
88 * **/vendor/cmu/cyrus-imapd/squat** - Indicates that the mailbox should be
89 indexed. (See :cyrusman:`squatter(8)`)