| 1 |
.. cyrusman:: ipurge(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
.. author: Jeroen van Meeuwen (Kolab Systems) |
| 5 |
|
| 6 |
.. _imap-reference-manpages-systemcommands-ipurge: |
| 7 |
|
| 8 |
========== |
| 9 |
**ipurge** |
| 10 |
========== |
| 11 |
|
| 12 |
Delete mail from IMAP mailbox or partition based on age or size |
| 13 |
|
| 14 |
Synopsis |
| 15 |
======== |
| 16 |
|
| 17 |
.. parsed-literal:: |
| 18 |
|
| 19 |
**ipurge** [ **-f** ] [ **-C** *config-file* ] [ **-x** ] [ **-M** ] [ **-X** ] [ **-i** ] [ **-s** ] [ **-o** ] [ **-n** ] [ **-v** ] |
| 20 |
[ **-d** *days* | **-b** *bytes* | **-k** *Kbytes* | **-m** *Mbytes* ] |
| 21 |
[ *mailbox-pattern*... ] |
| 22 |
|
| 23 |
Description |
| 24 |
=========== |
| 25 |
|
| 26 |
*ipurge* deletes messages from the mailbox(es) specified by |
| 27 |
*Imailbox-pattern* that are older or larger than specified by the |
| 28 |
**-d**, **-b**, **-k** or **-m** options. If no *mailbox-pattern* is |
| 29 |
given, *ipurge* works on all mailboxes. If the **-x** option is given, |
| 30 |
the message age and size MUST match exactly those specified by **-d**, |
| 31 |
**-b**, **-k** or **-m**. The are no default values, and at least one |
| 32 |
of **-d**, **-b**, **-k** or **-m** MUST be specified. |
| 33 |
|
| 34 |
*Ipurge* by default only deletes mail below shared folders, which means |
| 35 |
that mails in mailbox(es) below INBOX.* and user.* stay untouched. Use |
| 36 |
the option **-f** to also delete mail in mailbox(es) below these |
| 37 |
folders. Use the **-M** option to not recurse into the mailboxes. |
| 38 |
|
| 39 |
*ipurge* |default-conf-text| |
| 40 |
|
| 41 |
Options |
| 42 |
======= |
| 43 |
|
| 44 |
.. program:: ipurge |
| 45 |
|
| 46 |
.. option:: -C config-file |
| 47 |
|
| 48 |
|cli-dash-c-text| |
| 49 |
|
| 50 |
.. option:: -f, --include-user-mailboxes |
| 51 |
|
| 52 |
Force ipurge to examine mailboxes below INBOX.* and user.*. |
| 53 |
|
| 54 |
.. option:: -d days, --days=days |
| 55 |
|
| 56 |
Age of message in *days*. |
| 57 |
|
| 58 |
.. option:: -b bytes, --bytes=bytes |
| 59 |
|
| 60 |
Size of message in *bytes*. |
| 61 |
|
| 62 |
.. option:: -k Kbytes, --kbytes=Kbytes |
| 63 |
|
| 64 |
Size of message in *Kbytes* (2^10 bytes). |
| 65 |
|
| 66 |
.. option:: -m Mbytes, --mbytes=Mbytes |
| 67 |
|
| 68 |
Size of message in *Mbytes* (2^20 bytes). |
| 69 |
|
| 70 |
.. option:: -x, --exact-match |
| 71 |
|
| 72 |
Perform an exact match on age or size (instead of older or larger). |
| 73 |
|
| 74 |
.. option:: -X, --delivery-time |
| 75 |
|
| 76 |
Use delivery time instead of Date: header for date matches. |
| 77 |
|
| 78 |
.. option:: -i, --invert-match |
| 79 |
|
| 80 |
Invert match logic: -x means not equal, date is for newer, size is |
| 81 |
for smaller. |
| 82 |
|
| 83 |
.. option:: -s, --skip-flagged |
| 84 |
|
| 85 |
Skip over messages that have the \\Flagged flag set. |
| 86 |
|
| 87 |
.. option:: -o, --only-deleted |
| 88 |
|
| 89 |
Only purge messages that have the \\Deleted flag set. |
| 90 |
|
| 91 |
.. option:: -n, --dry-run |
| 92 |
|
| 93 |
Only print messages that would be deleted (dry run). |
| 94 |
|
| 95 |
.. option:: -v, --verbose |
| 96 |
|
| 97 |
Enable verbose output/logging. |
| 98 |
|
| 99 |
Examples |
| 100 |
======== |
| 101 |
|
| 102 |
[NB: Examples needed] |
| 103 |
|
| 104 |
Files |
| 105 |
===== |
| 106 |
|
| 107 |
/etc/imapd.conf |
| 108 |
|
| 109 |
See Also |
| 110 |
======== |
| 111 |
:cyrusman:`imapd.conf(5)` |