source: trunk/athena/bin/mitmailutils/mitmaildel.1 @ 23705

Revision 23705, 2.3 KB checked in by broder, 16 years ago (diff)
Initial revision of mitmailutils as the mitmail* packages merged.
Line 
1.\"
2.\" $Id: mitmaildel.1,v 1.1 2004-01-21 23:15:10 rbasch Exp $
3.\"
4.TH MITMAILDEL 1
5.SH NAME
6mitmaildel, mitmailundel \- delete or undelete messages in an IMAP folder
7.SH SYNOPSIS
8.B mitmaildel | mitmailundel
9[
10.B \--by-uid
11] [
12.B \--debug
13] [
14.B \--expunge
15] [
16.B \--help
17] [
18.B \--host
19.I name
20] [
21.B \--mailbox
22.I name
23] [
24.B \--silent
25]
26.I message-ID
27[ ... ]
28.SH DESCRIPTION
29The
30.I mitmaildel
31program
32marks the specified messages for deletion from a folder on an IMAP
33server.  If the
34.B \--expunge
35option is given, all deleted messages are permanently removed from the
36mailbox; otherwise, messages marked for deletion remain in the mailbox.
37
38The
39.I mitmailundel
40command unmarks the specified messages for deletion.
41.SH OPTIONS
42.I mitmaildel
43and
44.I mitmailundel
45understand the following options:
46.TP
47.B \--by-uid
48specify that the given message ID arguments are unique identifiers, not
49sequence numbers.
50.TP
51.B \--debug
52turn on debugging.
53.TP
54.B \--epxunge
55expunge the maibox after marking (or unmarking) the specified messages,
56permanently removing all deleted messages.  This option should be used
57with caution, as the message sequence numbers change upon an expunge;
58when performing multiple invocations of \fImitmaildel\fR, it is best to
59expunge the mailbox only once, with \fImitmailexp(1)\fR, after marking
60messages as desired.
61.TP
62.B \--help
63display usage information and exit.
64.TP
65.B \--host \fIname\fR
66query the given host, instead of the default post office server.
67.TP
68.B \--mailbox \fIname\fR
69mark messages in the IMAP folder \fIname\fR.  If this option is
70not specified, messages in the INBOX folder are marked.
71.TP
72.B \--silent
73do not display an acknowledgement.  If this option is not specified,
74an acknowledgement for each specified message that is marked is
75displayed on standard output.
76.SH ARGUMENTS
77.I mitmaildel
78and
79.I mitmailundel
80require one or more message ID arguments to be given.  The ID is
81either the message's sequence number, or, if the
82.I \--by-uid
83option is given, its unique identifier.
84.I mitmailscan(1)
85can be used to obtain the message ID.
86
87The message ID argument can be \fB*\fR, to indicate the last message
88in the mailbox.  An argument of the form
89.IB ID1 : ID2
90can be used to specify a range of IDs.
91.SH "SEE ALSO"
92mitmailscan(1), mitmailexp(1), mitmailshow(1),
93imtest(1), RFC\-2060 (Internet Message Access Protocol - Version 4rev1)
Note: See TracBrowser for help on using the repository browser.