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
33              List the expunged messages in the specified  mailbox  which  are
34              available  for  restoration.  Optionally, only list the messages
35              in the mailbox matching the UIDs in the space-separated list  at
36              the end of the command invocation.
37
38       -t time-interval, --within-time-interval=time-interval
39              Unexpunge  messages which were expunged within the last time-in‐
40              terval seconds.  Use one of the trailing modifiers  --  m  (min‐
41              utes),  h (hours), d (days) or w (weeks) -- to specify a differ‐
42              ent time unit.
43
44       -a, --all
45              Restore all of the expunged messages in the specified mailbox.
46
47       -u, --uids
48              Restore only messages matching the UIDs,  in  a  space-separated
49              list  at  the  end  of  the command invocation, in the specified
50              mailbox.
51
52       -d, --unset-deleted
53              Unset the \Deleted flag on any restored messages.
54
55       -f flagname, --set-flag=flagname
56              Set the user flag \flagname on the messages restored, making  it
57              easier for the user(s) to find the restored messages and operate
58              on them (in a batch).
59
60       -v, --verbose
61              Enable verbose output/logging.
62

EXAMPLES

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

FILES

94       /etc/imapd.conf
95

SEE ALSO

97       imapd.conf(5)
98

AUTHOR

100       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
101       tems)
102

104       1993–2023, The Cyrus Team
105
106
107
108
1093.8.1                            Sep 11, 2023                     UNEXPUNGE(8)
Impressum