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, --include-user-mailboxes
37              Force ipurge to examine mailboxes below INBOX.* and user.*.
38
39       -d days, --days=days
40              Age of message in days.
41
42       -b bytes, --bytes=bytes
43              Size of message in bytes.
44
45       -k Kbytes, --kbytes=Kbytes
46              Size of message in Kbytes (2^10 bytes).
47
48       -m Mbytes, --mbytes=Mbytes
49              Size of message in Mbytes (2^20 bytes).
50
51       -x, --exact-match
52              Perform  an  exact  match  on  age  or size (instead of older or
53              larger).
54
55       -X, --delivery-time
56              Use delivery time instead of Date: header for date matches.
57
58       -i, --invert-match
59              Invert match logic: -x means not equal, date is for newer,  size
60              is for smaller.
61
62       -s, --skip-flagged
63              Skip over messages that have the \Flagged flag set.
64
65       -o, --only-deleted
66              Only purge messages that have the \Deleted flag set.
67
68       -n, --dry-run
69              Only print messages that would be deleted (dry run).
70
71       -v, --verbose
72              Enable verbose output/logging.
73

EXAMPLES

75       [NB: Examples needed]
76

FILES

78       /etc/imapd.conf
79

SEE ALSO

81       imapd.conf(5)
82

AUTHOR

84       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
85       tems)
86

88       1993–2023, The Cyrus Team
89
90
91
92
933.8.1                            Sep 11, 2023                        IPURGE(8)
Impressum