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 ] [ -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
27       ipurge reads its configuration options out of  the  imapd.conf(5)  file
28       unless specified otherwise by -C.
29

OPTIONS

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

EXAMPLES

66       [NB: Examples needed]
67

FILES

69       /etc/imapd.conf
70

SEE ALSO

72       imapd.conf(5)
73

AUTHOR

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

79       1993-2017, The Cyrus Team
80
81
82
83
843.0.7                            May 18, 2018                        IPURGE(8)
Impressum