1IPURGE(8)                         Cyrus IMAP                         IPURGE(8)
2
3
4

NAME

6       ipurge - Cyrus IMAP documentation
7
8       Delete mail from IMAP mailbox or partition based on age or size
9

SYNOPSIS

11       ipurge [ -f ] [ -C config-file ] [ -x ] [ -M ] [ -X ] [ -i ] [ -s ] [ -o ] [ -n ] [ -v ]
12               [ -d days | -b bytes | -k Kbytes | -m Mbytes ]
13               [ mailbox-pattern... ]
14

DESCRIPTION

16       ipurge deletes messages from the mailbox(es) specified by Imailbox-pat‐
17       tern that are older or larger than specified by the -d, -b,  -k  or  -m
18       options.   If  no  mailbox-pattern  is given, ipurge works on all mail‐
19       boxes.  If the -x option is given, the message age and size MUST  match
20       exactly  those  specified by -d, -b, -k or -m.  The are no default val‐
21       ues, and at least one of -d, -b, -k or -m MUST be specified.
22
23       Ipurge by default only deletes mail below shared folders,  which  means
24       that  mails in mailbox(es) below INBOX.* and user.* stay untouched. Use
25       the option -f to also delete mail in mailbox(es) below  these  folders.
26       Use the -M option to not recurse into the mailboxes.
27
28       ipurge  reads  its  configuration options out of the imapd.conf(5) file
29       unless specified otherwise by -C.
30

OPTIONS

32       -C config-file
33              Use the specified configuration file config-file rather than the
34              default imapd.conf(5).
35
36       -f     Force ipurge to examine mailboxes below INBOX.* and user.*.
37
38       -d days
39              Age of message in days.
40
41       -b bytes
42              Size of message in bytes.
43
44       -k Kbytes
45              Size of message in Kbytes (2^10 bytes).
46
47       -m Mbytes
48              Size of message in Mbytes (2^20 bytes).
49
50       -x     Perform  an  exact  match  on  age  or size (instead of older or
51              larger).
52
53       -X     Use delivery time instead of Date: header for date matches.
54
55       -i     Invert match logic: -x means not equal, date is for newer,  size
56              is for smaller.
57
58       -s     Skip over messages that have the \Flagged flag set.
59
60       -o     Only purge messages that have the \Deleted flag set.
61
62       -n     Only print messages that would be deleted (dry run).
63
64       -v     Enable verbose output/logging.
65

EXAMPLES

67       [NB: Examples needed]
68

FILES

70       /etc/imapd.conf
71

SEE ALSO

73       imapd.conf(5)
74

AUTHOR

76       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
77       tems)
78

80       1993-2018, The Cyrus Team
81
82
83
84
853.2.6                           March 09, 2021                       IPURGE(8)
Impressum