carta
cyrus-ipurge(8)

cyrus-ipurge8

Cyrus imap documentation delete mail from imap mailbox or partition based on age or size

Overview

ipurge deletes messages from the mailbox(es) specified by Imailbox-pattern that are older or larger than specified by the -d, -b, -k or -m options. If no mailbox-pattern is given, ipurge works on all mailboxes. If the -x option is given, the message age and size MUST match exactly those specified by -d, -b, -k or -m. The are no default values, and at least one of -d, -b, -k or -m MUST be specified.

Ipurge by default only deletes mail below shared folders, which means that mails in mailbox(es) below INBOX.* and user.* stay untouched. Use the option -f to also delete mail in mailbox(es) below these folders. Use the -M option to not recurse into the mailboxes.

ipurge reads its configuration options out of the imapd.conf(5) file unless specified otherwise by -C.

Options

-C config-file

Use the specified configuration file config-file rather than the default imapd.conf(5).

-f, --include-user-mailboxes

Force ipurge to examine mailboxes below INBOX.* and user.*.

-d days, --days=days

Age of message in days.

-b bytes, --bytes=bytes

Size of message in bytes.

-k Kbytes, --kbytes=Kbytes

Size of message in Kbytes (2^10 bytes).

-m Mbytes, --mbytes=Mbytes

Size of message in Mbytes (2^20 bytes).

-x, --exact-match

Perform an exact match on age or size (instead of older or larger).

-X, --delivery-time

Use delivery time instead of Date: header for date matches.

-i, --invert-match

Invert match logic: -x means not equal, date is for newer, size is for smaller.

-s, --skip-flagged

Skip over messages that have the \Flagged flag set.

-o, --only-deleted

Only purge messages that have the \Deleted flag set.

-n, --dry-run

Only print messages that would be deleted (dry run).

-v, --verbose

Enable verbose output/logging.

Examples

[NB: Examples needed]

Files

/etc/imapd.conf

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie) to Debian 7 (Wheezy)

--bytes since Debian 13 (Trixie); --days since Debian 13 (Trixie); --delivery-time since Debian 13 (Trixie); --dry-run since Debian 13 (Trixie); --exact-match since Debian 13 (Trixie); --include-user-mailboxes since Debian 13 (Trixie); --invert-match since Debian 13 (Trixie); --kbytes since Debian 13 (Trixie); --mbytes since Debian 13 (Trixie); --only-deleted since Debian 13 (Trixie); --skip-flagged since Debian 13 (Trixie); --verbose since Debian 13 (Trixie); -C since Debian 10 (Buster); -b since Debian 10 (Buster); -d since Debian 10 (Buster); -k since Debian 10 (Buster); -m since Debian 10 (Buster); -n since Debian 9 (Stretch); -v since Debian 10 (Buster).

Author

The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Systems)

From cyrus-common 3.10.2-1+deb13u2 in Debian 13 (Trixie). Parsed by carta from the page's man source.