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

NAME

6       unexpunge - Cyrus IMAP documentation
7
8       Recover messages the user has (accidentally) deleted.
9

SYNOPSIS

11       unexpunge [ -C config-file ] -l mailbox [ uid... ]
12       unexpunge [ -C config-file ] -t time-interval [ -d ] [ -v ] [ -f flagname ] mailbox
13       unexpunge [ -C config-file ] -a [ -d ] [ -v ] [ -f flagname ] mailbox
14       unexpunge [ -C config-file ] -u [ -d ] [ -v ] [ -f flagname ] mailbox uid...
15

DESCRIPTION

17       The  unexpunge  program  is used to list or restore messages which have
18       been deleted from a mailbox, but still reside in the  Cyrus  IMAP  mail
19       spool.
20
21       This  utility  is  only  useful  when the server is configured with ex‐
22       punge_mode set to delayed in its configuration file.
23
24       unexpunge reads its configuration options out of the imapd.conf(5) file
25       unless specified otherwise by -C.
26

OPTIONS

28       -C config-file
29              Use the specified configuration file config-file rather than the
30              default imapd.conf(5).
31
32       -l     List the expunged messages in the specified  mailbox  which  are
33              available  for  restoration.  Optionally, only list the messages
34              in the mailbox matching the UIDs in the space-separated list  at
35              the end of the command invocation.
36
37       -t time-interval
38              Unexpunge messages which where expunged within the last time-in‐
39              terval seconds.  Use one of the trailing  modifiers  –  m  (min‐
40              utes), h (hours), d (days) or w (weeks) – to specify a different
41              time unit.
42
43       -a     Restore all of the expunged messages in the specified mailbox.
44
45       -u     Restore only messages matching the UIDs,  in  a  space-separated
46              list  at  the  end  of  the command invocation, in the specified
47              mailbox.
48
49       -d     Unset the \Deleted flag on any restored messages.
50
51       -f flagname
52              Set the user flag \flagname on the messages restored, making  it
53              easier for the user(s) to find the restored messages and operate
54              on them (in a batch).
55
56       -v     Enable verbose output/logging.
57

EXAMPLES

59       unexpunge -l user/john@example.org
60          List the messages that are expunged and could be restored for  mail‐
61          box user/john@example.org.
62
63       unexpunge -u user/john@example.org 278787 278788
64          Unexpunge two of these messages.
65
66       mbexamine user/john@example.org
67          Examine the mailbox for the two restored messages.
68
69       unexpunge -u -d user.johnsmith 46908
70          Unexpunge  a  select message based on its UID, clearing the \Deleted
71          flag.
72
73       unexpunge -a user.johnsmit.Trash
74          Unexpunge all messages in a user’s Trash,  but  leave  them  flagged
75          \Deleted.
76
77       unexpunge -a -f Flagged user.johnsmith.Trash
78          The  same,  but  setting user flag \Flagged to facilitate later bulk
79          operations.
80
81       unexpunge -t 24h -d -f Flagged user.johnsmith
82          Unexpunge messages matching only a given time period.
83
84       unexpunge -t 24h -d -f Flagged user/johnsmith
85          The same command, supporting the  unixhierarchysep:  yes  option  in
86          imapd.conf(5).
87

FILES

89       /etc/imapd.conf
90

SEE ALSO

92       imapd.conf(5)
93

AUTHOR

95       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
96       tems)
97

99       1993–2022, The Cyrus Team
100
101
102
103
1043.6.0                          December 12, 2022                  UNEXPUNGE(8)
Impressum