1CYR_EXPIRE(8) System Manager's Manual CYR_EXPIRE(8)
2 *
6
8 cyr_expire - expire messages and duplicate delivery database entries
9
11 cyr_expire [ -C config-file ] [ -D delete-days ] -E expire-duration [
12 -X 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 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 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 -D delete-duration
38 Remove previously deleted mailboxes older than delete-duration
39 (when using the "delayed" delete mode). The value can be a
40 floating point number, and may have a suffix to specify the unit
41 of time. If no suffix, the value is number of days. Valid suf‐
42 fixes are d (days), h (hours), m (minutes) and s (seconds).
43 -E expire-duration
45 Prune the duplicate database of entries older than expire-dura‐
46 tion. This value is only used for entries which do not have a
47 corresponding /vendor/cmu/cyrus-imapd/expire mailbox annotation.
48 Format is the same as delete-duration.
49 -X expunge-duration
51 Expunge previously deleted messages older than expunge-duration
52 (when using the "delayed" expunge mode). Format is the same as
53 delete-duration.
54 -x Do not expunge messages even if using delayed expunge mode
56 (reduces the IO hit considerably, allowing you to run cyr_expire
57 frequently to clean up the duplicate database without overload‐
58 ing your server)
59 -p mailbox-prefix
61 Only find mailboxes starting with this prefix. e.g.
62 "user.justgotspammedlots"
63 -v Enable verbose output.
65 -a Skip the annotation lookup, so all /vendor/cmu/cyrus-
67 imapd/expire annotations are ignored entirely. It behaves as if
68 they were not set, so only expire-days is considered for all
69 mailboxes.
70
72 /etc/imapd.conf
73
75 imapd.conf(5), cyrus-master(8)
76CMU Project Cyrus CYR_EXPIRE(8)