1CYR_EXPIRE(8) System Manager's Manual CYR_EXPIRE(8)
2
3
4
5 *
6
8 cyr_expire - expire messages and duplicate delivery database entries
9
11 cyr_expire [ -C config-file ] [ -D delete-days ] -E expire-days [ -X
12 expunge-days ] [ -p mailbox-prefix ] [ -v ]
13
15 Cyr_expire is used to expire messages and duplicate delivery database
16 entries. Cyr_expire also cleanses mailboxes of partially expunged mes‐
17 sages (when using the "delayed" expunge mode). The expiration of mes‐
18 sages is controlled by the /vendor/cmu/cyrus-imapd/expire mailbox anno‐
19 tation which specifies the age (in days) of messages in the given mail‐
20 box that should be deleted. Any duplicate delivery database entries
21 which correspond to the mailbox are also deleted at the same frequency.
22
23 The value of the /vendor/cmu/cyrus-imapd/expire annotation is inherited
24 by all children of the given mailbox, so an entire mailbox tree can be
25 expired by seting a single annotation on the root of that tree. If a
26 mailbox does not have a /vendor/cmu/cyrus-imapd/expire annotation set
27 on it (or does not inherit one), then no messages are expired from the
28 mailbox.
29
30 Cyr_expire reads its configuration options out of the imapd.conf(5)
31 file unless specified otherwise by -C.
32
34 -C config-file
35 Read configuration options from config-file.
36
37 -D delete-days
38 Remove previously deleted mailboxes older than delete-days (when
39 using the "delayed" delete mode).
40
41 -E expire-days
42 Prune the duplicate database of entries older than expire-days.
43 This value is only used for entries which do not have a corre‐
44 sponding /vendor/cmu/cyrus-imapd/expire mailbox annotation.
45
46 -X expunge-days
47 Expunge previously deleted messages older than expunge-days
48 (when using the "delayed" expunge mode).
49
50 -x Do not expunge messages even if using delayed expunge mode
51 (reduces the IO hit considerably, allowing you to run cyr_expire
52 frequently to clean up the duplicate database without overload‐
53 ing your server)
54
55 -p mailbox-prefix
56 Only find mailboxes starting with this prefix. e.g.
57 "user.justgotspammedlots"
58
59 -v Enable verbose output.
60
61 -a Skip the annotation lookup, so all /vendor/cmu/cyrus-
62 imapd/expire annotations are ignored entirely. It behaves as if
63 they were not set, so only expire-days is considered for all
64 mailboxes.
65
67 /etc/imapd.conf
68
70 imapd.conf(5), cyrus-master(8)
71
72
73
74CMU Project Cyrus CYR_EXPIRE(8)