2
* ========================================================================
3
* Copyright 1988-2006 University of Washington
5
* Licensed under the Apache License, Version 2.0 (the "License");
6
* you may not use this file except in compliance with the License.
7
* You may obtain a copy of the License at
9
* http://www.apache.org/licenses/LICENSE-2.0
12
* ========================================================================
14
.TH mailutil 1 "December 6, 2006"
16
mailutil - mail utility program
19
.B mailutil check [-d] [-v]
22
.B mailutil create [-d] [-v] mailbox
24
.B mailutil delete [-d] [-v] mailbox
26
.B mailutil rename [-d] [-v] src dst
28
.B mailutil copy [-d] [-v] [-rw] [-kw] src dst
30
.B mailutil move [-d] [-v] [-rw] [-kw] src dst
32
.B mailutil append [-d] [-v] [-rw] [-kw] src dst
34
.B mailutil appenddelete [-d] [-v] [-rw] [-kw] src dst
36
.B mailutil prune [-d] [-v]
39
.B mailutil transfer [-d] [-v] [-m mode] [-rw] [-kw] src dst
42
replaces the old chkmail, imapcopy, imapmove, imapxfer, mbxcopy,
43
mbxcreat, and mbxcvt programs.
46
determines whether new mail exists in the given mailbox (the default
47
is INBOX). The number of new messages is defined as the number of
48
messages that have "Recent" status set. If the mailbox contains no
51
will indicate that no new mail is present;
52
otherwise, it will report the number of new messages. In either case,
53
it will also indicate the canonical form of the name of the mailbox.
58
with the given name. The mailbox name must not already exist. A mailbox
59
can be created in a particular format by prefixing the name with
61
followed by the format name and a
63
character. For example, the command
65
mailutil create #driver.mbx/junkmail
67
will create a new mailbox named "junkmail" in mbx format.
75
renames an existing mailbox to a new name (which must not already exist).
76
This only works if the old and new names are in the same mail store. A
77
more general means to rename a mailbox is to do a
79
of the old name to the new name, followed by a
84
creates a new mailbox and copies messages from the old mailbox to the
87
a mailbox format can be specified with the new mailbox. For example, the
90
mailutil copy INBOX #driver.mbx/INBOX
92
will copy messages from your existing INBOX to an mbx-format INBOX.
97
but in addition will also remove (delete and expunge) the messages from the
98
old mailbox after copying them to the new mailbox.
102
.B mailutil appenddelete
107
respectively except that they do not create the destination mailbox.
110
prunes the mailbox of messages which match certain criteria, which are
111
in the form of IMAP2 (RFC 1176) SEARCH arguments. For example, the
114
mailutil prune INBOX "before 1-jan-2004"
116
will delete and expunge all messages written before January 1, 2004.
119
copies an entire hierarchy of mailboxes from the named source to the
120
named destination. Mailboxes are created on the destination as
121
needed. Any error in copying messages will cause the transfer to stop.
123
Normally, any error in creation will cause the transfer to stop.
128
is specified, a merging transfer is performed. The
130
argument the type of merge.
133
indicates that the user should be asked for an alternative name to create.
134
If creating the new name fails, the user will be asked again.
137
indicates that it's alright to copy the messages into an existing mailbox
138
with that name. If the mailbox does not exist, the user will be prompted
139
for an alternative name.
141
.B -m[erge] suffix=XXXX
142
where XXXX is any string, indicates that an alternative name should be
143
built by appending the given suffix to the name. It that alternative name
144
can't be created, then the user will be prompted for an alternative name.
146
The source hierarchy consists of all mailboxes which start
147
with the given source name. With the exception of a remote system
148
specification (within "{}" braces), the source name is used as the
149
name of the destination. The destination hierarchy is a prefix
150
applied to any new names being created. For example,
152
mailutil transfer foo bar
154
will copy all mailboxes with names beginning with "foo" to names
155
beginning with "bar" (hence "foobar" will be copied to "barfoobar").
158
mailutil transfer "{imap.foo.com}" "{imap.bar.com}old/"
160
will copy all mailboxes from the imap.foo.com IMAP server to
161
equivalent names starting with "old/" on the imap.bar.com IMAP server.
167
flag prints full debugging telemetry including protocol operations.
173
flag prints verbose (non-error) telemetry.
179
flag causes the source mailbox to be open in readwrite mode rather than
180
readonly mode. Normally, mailutil tries to use readonly mode to avoid
181
altering any flags in the source mailbox, but some mailbox types, e.g.
182
POP3, can't be open in readonly mode.
188
flag causes the keywords of the source mailbox to be created in the
189
destination mailbox. Normally, mailutil does not create keywords in
190
the destination mailbox so only those keywords that are already defined
191
in the destination mailbox will be preserved. Note that some IMAP servers
192
may automatically create keywords, so this flag may not be necessary.
194
The arguments are standard c-client mailbox names. A
195
variety of mailbox name formats and types of mailboxes are supported
196
by c-client; examples of the most common forms of names are:
202
primary incoming mail folder on the local system
203
.IP archive/tx-project
204
mail folder named "tx-project" in "archive" subdirectory of local
205
filesystem home directory
206
.IP {imapserver.foo.com}INBOX
207
primary incoming mail folder on IMAP server system
209
.IP {imapserver.foo.com}archive/tx-project
210
mail folder named "tx-project" in "archive" subdirectory on IMAP
211
server system "imapserver.foo.com"
212
.IP #news.comp.mail.misc
213
newsgroup "comp.mail.misc" on local filesystem
214
.IP {newserver.foo.com/nntp}comp.mail.misc
215
newsgroup "comp.mail.misc" on NNTP server system "newserver.foo.com"
216
.IP {popserver.foo.com/pop3}
217
mail folder on POP3 server system "popserver.foo.com"
219
See your system manager for more information about the types of
220
mailboxes which are available on your system.
224
argument with quotation marks if you run
228
or another shell for which braces have special meaning.
231
.I #driver.format/mailbox
232
argument with quotation marks if you run
234
from a shell in which "#" is the comment character.
236
Mark Crispin, MRC@CAC.Washington.EDU
added
removed
imap/src/mailutil/mailutil.1
