1 <!doctype linuxdoc system>
5 <title>The Mutt E-Mail Client
6 <author>by Michael Elkins <htmlurl url="mailto:me@cs.hmc.edu" name="<me@cs.hmc.edu>">
7 <date>version @VERSION@
9 ``All mail clients suck. This one just sucks less.'' -me, circa 1995
16 <bf/Mutt-ng/ is a small but very powerful text-based MIME mail client. Mutt-ng is
17 highly configurable, and is well suited to the mail power user with advanced
18 features like key bindings, keyboard macros, mail threading, regular
19 expression searches and a powerful pattern matching language for selecting
22 <p>This documentation additionaly contains documentation to <bf/Mutt-NG/, a
23 fork from Mutt with the goal to fix all the little annoyances of Mutt, to
24 integrate all the Mutt patches that are floating around in the web, and to
25 add other new features. Features specific to Mutt-ng will be discussed in
26 an extra section. Don't be confused when most of the documentation talk about
27 Mutt and not Mutt-ng, Mutt-ng contains all Mutt-ng features, plus many more.
30 <sect1>Mutt-ng Home Page
32 <htmlurl url="http://www.muttng.org/"
33 name="http://www.muttng.org">
39 <item><htmlurl url="https://lists.berlios.de/mailman/listinfo/mutt-ng-users"
40 name="mutt-ng-users@lists.berlios.de"> -- This is where the mutt-ng user support happens.
41 <item><htmlurl url="https://lists.berlios.de/mailman/listinfo/mutt-ng-devel" name="mutt-ng-devel@lists.berlios.de"> -- The development mailing list for mutt-ng
44 <sect1>Software Distribution Sites
46 So far, there are no official releases of Mutt-ng, but you can download
47 daily snapshots from <htmlurl url="http://mutt-ng.berlios.de/snapshots/" name="http://mutt-ng.berlios.de/snapshots/">
50 <item><htmlurl url="ftp://ftp.mutt.org/mutt/"
51 name="ftp://ftp.mutt.org/mutt/">
54 For a list of mirror sites, please refer to <htmlurl
55 url="http://www.mutt.org/download.html"
56 name="http://www.mutt.org/download.html">.
62 Visit channel <em/#muttng/ on <htmlurl
63 url="http://www.freenode.net/" name="irc.freenode.net
64 (www.freenode.net)"> to chat with other people interested in Mutt-ng.
69 If you want to read fresh news about the latest development in Mutt-ng, and get informed
70 about stuff like interesting, Mutt-ng-related articles and packages for your favorite
71 distribution, you can read and/or subscribe to our
72 <htmlurl url="http://mutt-ng.supersized.org/" name="Mutt-ng development weblog">.
76 Mutt is Copyright (C) 1996-2000 Michael R. Elkins
77 <me@cs.hmc.edu> and others
79 This program is free software; you can redistribute it and/or modify
80 it under the terms of the GNU General Public License as published by
81 the Free Software Foundation; either version 2 of the License, or
82 (at your option) any later version.
84 This program is distributed in the hope that it will be useful,
85 but WITHOUT ANY WARRANTY; without even the implied warranty of
86 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
87 GNU General Public License for more details.
89 You should have received a copy of the GNU General Public License
90 along with this program; if not, write to the Free Software
91 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
96 This section is intended as a brief overview of how to use Mutt. There are
97 many other features which are described elsewhere in the manual. There
98 is even more information available in the Mutt FAQ and various web
99 pages. See the <htmlurl url="http://www.mutt.org/mutt/"
100 name="Mutt Page"> for more details.
102 The keybindings described in this section are the defaults as distributed.
103 Your local system administrator may have altered the defaults for your site.
104 You can always type ``?'' in any menu to display the current bindings.
106 The first thing you need to do is invoke mutt, simply by typing mutt
107 at the command line. There are various command-line options, see
108 either the mutt man page or the <ref id="commandline" name="reference">.
110 <sect1>Moving Around in Menus
113 Information is presented in menus, very similar to ELM. Here is a table
114 showing the common keys used to navigate menus in Mutt.
117 j or Down next-entry move to the next entry
118 k or Up previous-entry move to the previous entry
119 z or PageDn page-down go to the next page
120 Z or PageUp page-up go to the previous page
121 = or Home first-entry jump to the first entry
122 * or End last-entry jump to the last entry
123 q quit exit the current menu
124 ? help list all keybindings for the current menu
127 <sect1>Editing Input Fields<label id="editing">
129 Mutt has a builtin line editor which is used as the primary way to input
130 textual data such as email addresses or filenames. The keys used to move
131 around while editing are very similar to those of Emacs.
134 ^A or <Home> bol move to the start of the line
135 ^B or <Left> backward-char move back one char
136 Esc B backward-word move back one word
137 ^D or <Delete> delete-char delete the char under the cursor
138 ^E or <End> eol move to the end of the line
139 ^F or <Right> forward-char move forward one char
140 Esc F forward-word move forward one word
141 <Tab> complete complete filename or alias
142 ^T complete-query complete address with query
143 ^K kill-eol delete to the end of the line
144 ESC d kill-eow delete to the end ot the word
145 ^W kill-word kill the word in front of the cursor
146 ^U kill-line delete entire line
147 ^V quote-char quote the next typed key
148 <Up> history-up recall previous string from history
149 <Down> history-down recall next string from history
150 <BackSpace> backspace kill the char in front of the cursor
151 Esc u upcase-word convert word to upper case
152 Esc l downcase-word convert word to lower case
153 Esc c capitalize-word capitalize the word
155 <Return> n/a finish editing
158 You can remap the <em/editor/ functions using the <ref id="bind" name="bind">
159 command. For example, to make the <em/Delete/ key delete the character in
160 front of the cursor rather than under, you could use
162 <tt/bind editor <delete> backspace/
164 <sect1>Reading Mail - The Index and Pager
167 Similar to many other mail clients, there are two modes in which mail is
168 read in Mutt. The first is the index of messages in the mailbox, which is
169 called the ``index'' in Mutt. The second mode is the display of the
170 message contents. This is called the ``pager.''
172 The next few sections describe the functions provided in each of these
175 <sect2>The Message Index
179 c change to a different mailbox
180 ESC c change to a folder in read-only mode
181 C copy the current message to another mailbox
182 ESC C decode a message and copy it to a folder
183 ESC s decode a message and save it to a folder
184 D delete messages matching a pattern
185 d delete the current message
187 l show messages matching a pattern
188 N mark message as new
189 o change the current sort method
190 O reverse sort the mailbox
191 q save changes and exit
193 T tag messages matching a pattern
194 t toggle the tag on a message
195 ESC t toggle tag on entire message thread
196 U undelete messages matching a pattern
199 x abort changes and exit
200 <Return> display-message
201 <Tab> jump to the next new message
202 @ show the author's full e-mail address
203 $ save changes to mailbox
206 ^L clear and redraw the screen
207 ^T untag messages matching a pattern
213 In addition to who sent the message and the subject, a short summary of
214 the disposition of each message is printed beside the message number.
215 Zero or more of the following ``flags'' may appear, which mean:
219 <tag/D/ message is deleted (is marked for deletion)
220 <tag/d/ message have attachments marked for deletion
221 <tag/K/ contains a PGP public key
222 <tag/N/ message is new
223 <tag/O/ message is old
224 <tag/P/ message is PGP encrypted
225 <tag/r/ message has been replied to
226 <tag/S/ message is signed, and the signature is succesfully verified
227 <tag/s/ message is signed
228 <tag/!/ message is flagged
229 <tag/*/ message is tagged
232 Some of the status flags can be turned on or off using
234 <item><bf/set-flag/ (default: w)
235 <item><bf/clear-flag/ (default: W)
239 Furthermore, the following flags reflect who the message is addressed
240 to. They can be customized with the
241 <ref id="to_chars" name="$to_chars"> variable.
245 <tag/+/ message is to you and you only
246 <tag/T/ message is to you, but also to or cc'ed to others
247 <tag/C/ message is cc'ed to you
248 <tag/F/ message is from you
249 <tag/L/ message is sent to a subscribed mailing list
255 By default, Mutt uses its builtin pager to display the body of messages.
256 The pager is very similar to the Unix program <em/less/ though not nearly as
260 <Return> go down one line
261 <Space> display the next page (or next message if at the end of a message)
262 - go back to the previous page
263 n search for next match
264 S skip beyond quoted text
265 T toggle display of quoted text
267 / search for a regular expression (pattern)
268 ESC / search backwards for a regular expression
269 \ toggle search pattern coloring
270 ^ jump to the top of the message
273 In addition, many of the functions from the <em/index/ are available in
274 the pager, such as <em/delete-message/ or <em/copy-message/ (this is one
275 advantage over using an external pager to view messages).
277 Also, the internal pager supports a couple other advanced features. For
278 one, it will accept and translate the ``standard'' nroff sequences for
279 bold and underline. These sequences are a series of either the letter,
280 backspace (^H), the letter again for bold or the letter, backspace,
281 ``_'' for denoting underline. Mutt will attempt to display these
282 in bold and underline respectively if your terminal supports them. If
283 not, you can use the bold and underline <ref id="color" name="color">
284 objects to specify a color or mono attribute for them.
286 Additionally, the internal pager supports the ANSI escape sequences for
287 character attributes. Mutt translates them into the correct color and
288 character settings. The sequences Mutt supports are:
292 ESC [ Ps;Ps;Ps;...;Ps m
299 3x Foreground color is x
300 4x Background color is x
313 Mutt uses these attributes for handling text/enriched messages, and they
314 can also be used by an external <ref id="auto_view" name="autoview">
315 script for highlighting purposes. <bf/Note:/ If you change the colors for your
316 display, for example by changing the color associated with color2 for
317 your xterm, then that color will be used instead of green.
319 <sect2>Threaded Mode<label id="threads">
321 When the mailbox is <ref id="sort" name="sorted"> by <em/threads/, there are
322 a few additional functions available in the <em/index/ and <em/pager/ modes.
325 ^D delete-thread delete all messages in the current thread
326 ^U undelete-thread undelete all messages in the current thread
327 ^N next-thread jump to the start of the next thread
328 ^P previous-thread jump to the start of the previous thread
329 ^R read-thread mark the current thread as read
330 ESC d delete-subthread delete all messages in the current subthread
331 ESC u undelete-subthread undelete all messages in the current subthread
332 ESC n next-subthread jump to the start of the next subthread
333 ESC p previous-subthread jump to the start of the previous subthread
334 ESC r read-subthread mark the current subthread as read
335 ESC t tag-thread toggle the tag on the current thread
336 ESC v collapse-thread toggle collapse for the current thread
337 ESC V collapse-all toggle collapse for all threads
338 P parent-message jump to parent message in thread
341 <bf/Note:/ Collapsing a thread displays only the first message
342 in the thread and hides the others. This is useful when threads
343 contain so many messages that you can only see a handful of threads on
344 the screen. See %M in <ref id="index_format"name="$index_format">.
345 For example, you could use "%?M?(#%03M)&(%4l)?" in <ref
346 id="index_format"name="$index_format"> to optionally
347 display the number of hidden messages if the thread is collapsed.
349 See also: <ref id="strict_threads" name="$strict_threads">.
351 <sect2>Miscellaneous Functions
352 <p><bf/create-alias/<label id="create-alias"> (default: a)<newline>
354 Creates a new alias based upon the current message (or prompts for a
355 new one). Once editing is complete, an <ref id="alias" name="alias">
356 command is added to the file specified by the <ref id="alias_file"
357 name="$alias_file"> variable for future use. <bf/Note:/
358 Specifying an <ref id="alias_file" name="$alias_file">
359 does not add the aliases specified there-in, you must also <ref
360 id="source" name="source"> the file.
362 <p><bf/check-traditional-pgp/<label id="check-traditional-pgp"> (default: ESC P)<newline>
364 This function will search the current message for content signed or
365 encrypted with PGP the "traditional" way, that is, without proper
366 MIME tagging. Technically, this function will temporarily change
367 the MIME content types of the body parts containing PGP data; this
368 is similar to the <ref id="edit-type" name="edit-type"> function's
372 <p><bf/display-toggle-weed/<label id="display-toggle-weed"> (default: h)<newline>
374 Toggles the weeding of message header fields specified by <ref id="ignore"
375 name="ignore"> commands.
377 <p><bf/edit/<label id="edit"> (default: e)<newline>
379 This command (available in the ``index'' and ``pager'') allows you to
380 edit the raw current message as it's present in the mail folder.
381 After you have finished editing, the changed message will be
382 appended to the current folder, and the original message will be
385 <p><bf/edit-type/<label id="edit-type"><newline>
386 (default: ^E on the attachment menu, and in the pager and index menus; ^T on the
389 This command is used to temporarily edit an attachment's content
390 type to fix, for instance, bogus character set parameters. When
391 invoked from the index or from the pager, you'll have the
392 opportunity to edit the top-level attachment's content type. On the
393 <ref id="attach_menu" name="attachment menu">, you can change any
394 attachment's content type. These changes are not persistent, and get
395 lost upon changing folders.
397 Note that this command is also available on the <ref
398 id="compose_menu" name="compose menu">. There, it's used to
399 fine-tune the properties of attachments you are going to send.
401 <p><bf/enter-command/<label id="enter-command"> (default: ``:'')<newline>
403 This command is used to execute any command you would normally put in a
404 configuration file. A common use is to check the settings of variables, or
405 in conjunction with <ref id="macro" name="macros"> to change settings on the
408 <p><bf/extract-keys/<label id="extract-keys"> (default: ^K)<newline>
410 This command extracts PGP public keys from the current or tagged
411 message(s) and adds them to your PGP public key ring.
413 <p><bf/forget-passphrase/<label id="forget-passphrase"> (default:
416 This command wipes the passphrase(s) from memory. It is useful, if
417 you misspelled the passphrase.
419 <p><bf/list-reply/<label id="list-reply"> (default: L)<newline>
421 Reply to the current or tagged message(s) by extracting any addresses which
422 match the regular expressions given by the <ref id="lists" name="lists or subscribe">
423 commands, but also honor any <tt/Mail-Followup-To/ header(s) if the
424 <ref id="honor_followup_to" name="$honor_followup_to">
425 configuration variable is set. Using this when replying to messages posted
426 to mailing lists helps avoid duplicate copies being sent to the author of
427 the message you are replying to.
429 <bf/pipe-message/<label id="pipe-message"> (default: |)<newline>
431 Asks for an external Unix command and pipes the current or
432 tagged message(s) to it. The variables <ref id="pipe_decode"
433 name="$pipe_decode">, <ref id="pipe_split"
434 name="$pipe_split">, <ref id="pipe_sep"
435 name="$pipe_sep"> and <ref id="wait_key"
436 name="$wait_key"> control the exact behaviour of this
439 <bf/resend-message/<label id="resend-message"> (default: ESC e)<newline>
441 With resend-message, mutt takes the current message as a template for a
442 new message. This function is best described as "recall from arbitrary
443 folders". It can conveniently be used to forward MIME messages while
444 preserving the original mail structure. Note that the amount of headers
445 included here depends on the value of the <ref id="weed" name="$weed">
448 This function is also available from the attachment menu. You can use this
449 to easily resend a message which was included with a bounce message
450 as a message/rfc822 body part.
452 <bf/shell-escape/<label id="shell-escape"> (default: !)<newline>
454 Asks for an external Unix command and executes it. The <ref
455 id="wait_key" name="$wait_key"> can be used to control
456 whether Mutt will wait for a key to be pressed when the command returns
457 (presumably to let the user read the output of the command), based on
458 the return status of the named command.
460 <bf/toggle-quoted/<label id="toggle-quoted"> (default: T)<newline>
462 The <em/pager/ uses the <ref id="quote_regexp"
463 name="$quote_regexp"> variable to detect quoted text when
464 displaying the body of the message. This function toggles the display
465 of the quoted material in the message. It is particularly useful when
466 are interested in just the response and there is a large amount of
467 quoted text in the way.
469 <bf/skip-quoted/<label id="skip-quoted"> (default: S)<newline>
471 This function will go to the next line of non-quoted text which come
472 after a line of quoted text in the internal pager.
477 The following bindings are available in the <em/index/ for sending
481 m compose compose a new message
482 r reply reply to sender
483 g group-reply reply to all recipients
484 L list-reply reply to mailing list address
485 f forward forward message
486 b bounce bounce (remail) message
487 ESC k mail-key mail a PGP public key to someone
490 Bouncing a message sends the message as is to the recipient you
491 specify. Forwarding a message allows you to add comments or
492 modify the message you are forwarding. These items are discussed
493 in greater detail in the next chapter <ref id="forwarding_mail"
494 name="``Forwarding and Bouncing Mail''">.
496 Mutt will then enter the <em/compose/ menu and prompt you for the
497 recipients to place on the ``To:'' header field. Next, it will ask
498 you for the ``Subject:'' field for the message, providing a default if
499 you are replying to or forwarding a message. See also <ref id="askcc"
500 name="$askcc">, <ref id="askbcc" name="$askbcc">, <ref
501 id="autoedit" name="$autoedit">, <ref id="bounce"
502 name="$bounce">, and <ref id="fast_reply"
503 name="$fast_reply"> for changing how Mutt asks these
506 Mutt will then automatically start your <ref id="editor"
507 name="$editor"> on the message body. If the <ref id="edit_headers"
508 name="$edit_headers"> variable is set, the headers will be at
509 the top of the message in your editor. Any messages you are replying
510 to will be added in sort order to the message, with appropriate <ref
511 id="attribution" name="$attribution">, <ref id="indent_string"
512 name="$indent_string"> and <ref id="post_indent_string"
513 name="$post_indent_string">. When forwarding a
514 message, if the <ref id="mime_forward" name="$mime_forward">
515 variable is unset, a copy of the forwarded message will be included. If
516 you have specified a <ref id="signature" name="$signature">, it
517 will be appended to the message.
519 Once you have finished editing the body of your mail message, you are
520 returned to the <em/compose/ menu. The following options are available:
523 a attach-file attach a file
524 A attach-message attach message(s) to the message
525 ESC k attach-key attach a PGP public key
526 d edit-description edit description on attachment
527 D detach-file detach a file
528 t edit-to edit the To field
529 ESC f edit-from edit the From field
530 r edit-reply-to edit the Reply-To field
531 c edit-cc edit the Cc field
532 b edit-bcc edit the Bcc field
533 y send-message send the message
534 s edit-subject edit the Subject
535 S smime-menu select S/MIME options
536 f edit-fcc specify an ``Fcc'' mailbox
537 p pgp-menu select PGP options
538 P postpone-message postpone this message until later
539 q quit quit (abort) sending the message
540 w write-fcc write the message to a folder
541 i ispell check spelling (if available on your system)
542 ^F forget-passphrase wipe passphrase(s) from memory
545 <bf/Note:/ The attach-message function will prompt you for a folder to
546 attach messages from. You can now tag messages in that folder and they
547 will be attached to the message you are sending. Note that certain
548 operations like composing a new mail, replying, forwarding, etc. are
549 not permitted when you are in that folder. The %r in <ref
550 id="status_format" name="$status_format"> will change to
551 a 'A' to indicate that you are in attach-message mode.
553 <sect2>Editing the message header
555 When editing the header of your outgoing message, there are a couple of
556 special features available.
558 If you specify<newline>
559 <tt/Fcc:/ <em/filename/<newline>
560 Mutt will pick up <em/filename/
561 just as if you had used the <em/edit-fcc/ function in the <em/compose/ menu.
563 You can also attach files to your message by specifying<newline>
564 <tt/Attach:/ <em/filename/ [ <em/description/ ]<newline>
565 where <em/filename/ is the file to attach and <em/description/ is an
566 optional string to use as the description of the attached file.
568 When replying to messages, if you remove the <em/In-Reply-To:/ field from
569 the header field, Mutt will not generate a <em/References:/ field, which
570 allows you to create a new message thread.
572 Also see <ref id="edit_headers" name="edit_headers">.
574 <sect2>Using Mutt with PGP
577 If you want to use PGP, you can specify
579 <tt/Pgp:/ [ <tt/E/ | <tt/S/ | <tt/S/<em/<id>/ ] <newline>
581 ``E'' encrypts, ``S'' signs and
582 ``S<id>'' signs with the given key, setting <ref
583 id="pgp_sign_as" name="$pgp_sign_as"> permanently.
585 If you have told mutt to PGP encrypt a message, it will guide you
586 through a key selection process when you try to send the message.
587 Mutt will not ask you any questions about keys which have a
588 certified user ID matching one of the message recipients' mail
589 addresses. However, there may be situations in which there are
590 several keys, weakly certified user ID fields, or where no matching
593 In these cases, you are dropped into a menu with a list of keys from
594 which you can select one. When you quit this menu, or mutt can't
595 find any matching keys, you are prompted for a user ID. You can, as
596 usually, abort this prompt using <tt/^G/. When you do so, mutt will
597 return to the compose screen.
599 Once you have successfully finished the key selection, the message
600 will be encrypted using the selected public keys, and sent out.
602 Most fields of the entries in the key selection menu (see also <ref
603 id="pgp_entry_format" name="$pgp_entry_format">)
604 have obvious meanings. But some explanations on the capabilities, flags,
605 and validity fields are in order.
607 The flags sequence (%f) will expand to one of the following flags:
609 R The key has been revoked and can't be used.
610 X The key is expired and can't be used.
611 d You have marked the key as disabled.
612 c There are unknown critical self-signature
616 The capabilities field (%c) expands to a two-character sequence
617 representing a key's capabilities. The first character gives
618 the key's encryption capabilities: A minus sign (<bf/-/) means
619 that the key cannot be used for encryption. A dot (<bf/./) means that
620 it's marked as a signature key in one of the user IDs, but may
621 also be used for encryption. The letter <bf/e/ indicates that
622 this key can be used for encryption.
624 The second character indicates the key's signing capabilities. Once
625 again, a ``<bf/-/'' implies ``not for signing'', ``<bf/./'' implies
626 that the key is marked as an encryption key in one of the user-ids, and
627 ``<bf/s/'' denotes a key which can be used for signing.
629 Finally, the validity field (%t) indicates how well-certified a user-id
630 is. A question mark (<bf/?/) indicates undefined validity, a minus
631 character (<bf/-/) marks an untrusted association, a space character
632 means a partially trusted association, and a plus character (<bf/+/)
633 indicates complete validity.
635 <sect2>Sending anonymous messages via mixmaster.
638 You may also have configured mutt to co-operate with Mixmaster, an
639 anonymous remailer. Mixmaster permits you to send your messages
640 anonymously using a chain of remailers. Mixmaster support in mutt is for
641 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
642 It does not support earlier versions or the later so-called version 3 betas,
643 of which the latest appears to be called 2.9b23.
645 To use it, you'll have to obey certain restrictions. Most
646 important, you cannot use the <tt/Cc/ and <tt/Bcc/ headers. To tell
647 Mutt to use mixmaster, you have to select a remailer chain, using
648 the mix function on the compose menu.
650 The chain selection screen is divided into two parts. In the
651 (larger) upper part, you get a list of remailers you may use. In
652 the lower part, you see the currently selected chain of remailers.
654 You can navigate in the chain using the <tt/chain-prev/ and
655 <tt/chain-next/ functions, which are by default bound to the left
656 and right arrows and to the <tt/h/ and <tt/l/ keys (think vi
657 keyboard bindings). To insert a remailer at the current chain
658 position, use the <tt/insert/ function. To append a remailer behind
659 the current chain position, use <tt/select-entry/ or <tt/append/.
660 You can also delete entries from the chain, using the corresponding
661 function. Finally, to abandon your changes, leave the menu, or
662 <tt/accept/ them pressing (by default) the <tt/Return/ key.
664 Note that different remailers do have different capabilities,
665 indicated in the %c entry of the remailer menu lines (see
666 <ref id="mix_entry_format"
667 name="$mix_entry_format">). Most important is
668 the ``middleman'' capability, indicated by a capital ``M'': This
669 means that the remailer in question cannot be used as the final
670 element of a chain, but will only forward messages to other
671 mixmaster remailers. For details on the other capabilities, please
672 have a look at the mixmaster documentation.
674 <sect1>Forwarding and Bouncing Mail<label id="forwarding_mail">
677 Bouncing and forwarding let you send an existing message to recipients
678 that you specify. Bouncing a message uses the <ref id="sendmail"
679 name="sendmail"> command to send a copy to alternative addresses as if
680 they were the message's original recipients. Forwarding a message, on
681 the other hand, allows you to modify the message before it is resent
682 (for example, by adding your own comments).
684 The following keys are bound by default:
687 f forward forward message
688 b bounce bounce (remail) message
691 Forwarding can be done by including the original message in the new
692 message's body (surrounded by indicating lines) or including it as a MIME
693 attachment, depending on the value of the <ref id="mime_forward"
694 name="$mime_forward"> variable. Decoding of attachments,
695 like in the pager, can be controlled by the <ref id="forward_decode"
696 name="$forward_decode"> and <ref id="mime_forward_decode"
697 name="$mime_forward_decode"> variables,
698 respectively. The desired forwarding format may depend on the content,
699 therefore <em/$mime_forward/ is a quadoption which, for
700 example, can be set to ``ask-no''.
702 The inclusion of headers is controlled by the current setting of the
703 <ref id="weed" name="$weed"> variable, unless <ref
704 id="mime_forward" name="mime_forward"> is set.
706 Editing the message to forward follows the same procedure as sending or
707 replying to a message does.
709 <sect1>Postponing Mail<label id="postponing_mail">
712 At times it is desirable to delay sending a message that you have
713 already begun to compose. When the <em/postpone-message/ function is
714 used in the <em/compose/ menu, the body of your message and attachments
715 are stored in the mailbox specified by the <ref id="postponed"
716 name="$postponed"> variable. This means that you can recall the
717 message even if you exit Mutt and then restart it at a later time.
719 Once a message is postponed, there are several ways to resume it. From the
720 command line you can use the ``-p'' option, or if you <em/compose/ a new
721 message from the <em/index/ or <em/pager/ you will be prompted if postponed
722 messages exist. If multiple messages are currently postponed, the
723 <em/postponed/ menu will pop up and you can select which message you would
726 <bf/Note:/ If you postpone a reply to a message, the reply setting of
727 the message is only updated when you actually finish the message and
728 send it. Also, you must be in the same folder with the message you
729 replied to for the status of the message to be updated.
731 See also the <ref id="postpone" name="$postpone"> quad-option.
733 <sect1>Reading news via NNTP<label id="reading_news">
736 If compiled with ``--enable-nntp'' option, Mutt can read news from newsserver
737 via NNTP. You can open a newsgroup with function ``change-newsgroup''
738 (default: i). Default newsserver can be obtained from <em/NNTPSERVER/
739 environment variable. Like other news readers, info about subscribed
740 newsgroups is saved in file by <ref id="newsrc" name="$newsrc">
741 variable. Article headers are cached and can be loaded from file when
742 newsgroup entered instead loading from newsserver.
747 While the default configuration (or ``preferences'') make Mutt-ng usable right out
748 of the box, it is often desirable to tailor Mutt to suit your own tastes. When
749 Mutt-ng is first invoked, it will attempt to read the ``system'' configuration
750 file (defaults set by your local system administrator), unless the ``-n'' <ref
751 id="commandline" name="command line"> option is specified. This file is
752 typically <tt>/usr/local/share/muttng/Muttngrc</tt> or <tt>/etc/Muttngrc</tt>,
753 Mutt-ng users will find this file in <tt>/usr/local/share/muttng/Muttrc</tt> or
754 <tt>/etc/Muttngrc</tt>. Mutt will next look for a file named <tt>.muttrc</tt>
755 in your home directory, Mutt-ng will look for <tt>.muttngrc</tt>. If this file
756 does not exist and your home directory has a subdirectory named <tt/.mutt/,
757 mutt try to load a file named <tt>.muttng/muttngrc</tt>.
759 <tt>.muttrc</tt> (or <tt>.muttngrc</tt> for Mutt-ng) is the file where you will
760 usually place your <ref id="commands" name="commands"> to configure Mutt.
762 In addition, mutt supports version specific configuration files that are
763 parsed instead of the default files as explained above. For instance, if
764 your system has a <tt/Muttrc-0.88/ file in the system configuration
765 directory, and you are running version 0.88 of mutt, this file will be
766 sourced instead of the <tt/Muttrc/ file. The same is true of the user
767 configuration file, if you have a file <tt/.muttrc-0.88.6/ in your home
768 directory, when you run mutt version 0.88.6, it will source this file
769 instead of the default <tt/.muttrc/ file. The version number is the
770 same which is visible using the ``-v'' <ref id="commandline"
771 name="command line"> switch or using the <tt/show-version/ key (default:
772 V) from the index menu.
774 <sect1>Syntax of Initialization Files<label id="muttrc-syntax">
777 An initialization file consists of a series of <ref id="commands"
778 name="commands">. Each line of the file may contain one or more commands.
779 When multiple commands are used, they must be separated by a semicolon (;).
781 set realname='Mutt user' ; ignore x-
783 The hash mark, or pound sign
784 (``#''), is used as a ``comment'' character. You can use it to
785 annotate your initialization file. All text after the comment character
786 to the end of the line is ignored. For example,
789 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
792 Single quotes (') and double quotes (&dquot;) can be used to quote strings
793 which contain spaces or other special characters. The difference between
794 the two types of quotes is similar to that of many popular shell programs,
795 namely that a single quote is used to specify a literal string (one that is
796 not interpreted for shell variables or quoting with a backslash [see
797 next paragraph]), while double quotes indicate a string for which
798 should be evaluated. For example, backtics are evaluated inside of double
799 quotes, but <bf/not/ for single quotes.
801 \ quotes the next character, just as in shells such as bash and zsh.
802 For example, if want to put quotes ``&dquot;'' inside of a string, you can use
803 ``\'' to force the next character to be a literal instead of interpreted
806 set realname="Michael \"MuttDude\" Elkins"
809 ``\\'' means to insert a literal ``\'' into the line.
810 ``\n'' and ``\r'' have their usual C meanings of linefeed and
811 carriage-return, respectively.
813 A \ at the end of a line can be used to split commands over
814 multiple lines, provided that the split points don't appear in the
815 middle of command names.
817 It is also possible to substitute the output of a Unix command in an
818 initialization file. This is accomplished by enclosing the command in
819 backquotes (``). For example,
821 my_hdr X-Operating-System: `uname -a`
823 The output of the Unix command ``uname -a'' will be substituted before the
824 line is parsed. Note that since initialization files are line oriented, only
825 the first line of output from the Unix command will be substituted.
827 UNIX environments can be accessed like the way it is done in shells like
828 sh and bash: Prepend the name of the environment by a ``$''. For
831 set record=+sent_on_$HOSTNAME
834 The commands understood by mutt are explained in the next paragraphs.
835 For a complete list, see the <ref id="commands" name="command reference">.
837 <sect1>Defining/Using aliases<label id="alias">
840 Usage: <tt/alias/ <em/key/ <em/address/ [ , <em/address/, ... ]
842 It's usually very cumbersome to remember or type out the address of someone
843 you are communicating with. Mutt allows you to create ``aliases'' which map
844 a short string to a full address.
846 <bf/Note:/ if you want to create an alias for a group (by specifying more than
847 one address), you <bf/must/ separate the addresses with a comma (``,'').
849 To remove an alias or aliases (``*'' means all aliases):
851 <tt/unalias/ [ * | <em/key/ <em/.../ ]
854 alias muttdude me@cs.hmc.edu (Michael Elkins)
855 alias theguys manny, moe, jack
858 Unlike other mailers, Mutt doesn't require aliases to be defined
859 in a special file. The <tt/alias/ command can appear anywhere in
860 a configuration file, as long as this file is <ref id="source"
861 name="sourced">. Consequently, you can have multiple alias files, or
862 you can have all aliases defined in your muttrc.
864 On the other hand, the <ref id="create-alias" name="create-alias">
865 function can use only one file, the one pointed to by the <ref
866 id="alias_file" name="$alias_file"> variable (which is
867 <tt>˜/.muttrc</tt> by default). This file is not special either,
868 in the sense that Mutt will happily append aliases to any file, but in
869 order for the new aliases to take effect you need to explicitly <ref
870 id="source" name="source"> this file too.
875 source /usr/local/share/Mutt.aliases
876 source ~/.mail_aliases
877 set alias_file=~/.mail_aliases
880 To use aliases, you merely use the alias at any place in mutt where mutt
881 prompts for addresses, such as the <em/To:/ or <em/Cc:/ prompt. You can
882 also enter aliases in your editor at the appropriate headers if you have the
883 <ref id="edit_headers" name="$edit_headers"> variable set.
885 In addition, at the various address prompts, you can use the tab character
886 to expand a partial alias to the full alias. If there are multiple matches,
887 mutt will bring up a menu with the matching aliases. In order to be
888 presented with the full list of aliases, you must hit tab with out a partial
889 alias, such as at the beginning of the prompt or after a comma denoting
892 In the alias menu, you can select as many aliases as you want with the
893 <em/select-entry/ key (default: RET), and use the <em/exit/ key
894 (default: q) to return to the address prompt.
896 <sect1>Changing the default key bindings<label id="bind">
898 Usage: <tt/bind/ <em/map/ <em/key/ <em/function/
900 This command allows you to change the default key bindings (operation
901 invoked when pressing a key).
903 <em/map/ specifies in which menu the binding belongs. Multiple maps may
904 be specified by separating them with commas (no additional whitespace is
905 allowed). The currently defined maps are:
910 This is not a real menu, but is used as a fallback for all of the other
911 menus except for the pager and editor modes. If a key is not defined in
912 another menu, Mutt will look for a binding to use in this menu. This allows
913 you to bind a key to a certain function in multiple menus instead of having
914 multiple bind statements to accomplish the same task.
916 The alias menu is the list of your personal aliases as defined in your
917 muttrc. It is the mapping from a short alias name to the full email
918 address(es) of the recipient(s).
920 The attachment menu is used to access the attachments on received messages.
922 The browser is used for both browsing the local directory structure, and for
923 listing all of your incoming mailboxes.
925 The editor is the line-based editor the user enters text data.
927 The index is the list of messages contained in a mailbox.
929 The compose menu is the screen used when sending a new message.
931 The pager is the mode used to display message/attachment data, and help
934 The pgp menu is used to select the OpenPGP keys used for encrypting outgoing
937 The postpone menu is similar to the index menu, except is used when
938 recalling a message the user was composing, but saved until later.
941 <em/key/ is the key (or key sequence) you wish to bind. To specify a
942 control character, use the sequence <em/\Cx/, where <em/x/ is the
943 letter of the control character (for example, to specify control-A use
944 ``\Ca''). Note that the case of <em/x/ as well as <em/\C/ is
945 ignored, so that <em/\CA/, <em/\Ca/, <em/\cA/ and <em/\ca/ are all
946 equivalent. An alternative form is to specify the key as a three digit
947 octal number prefixed with a ``\'' (for example <em/\177/ is
948 equivalent to <em/\c?/).
950 In addition, <em/key/ may consist of:
965 <backspace> Backspace
974 <f10> function key 10
977 <em/key/ does not need to be enclosed in quotes unless it contains a
980 <em/function/ specifies which action to take when <em/key/ is pressed.
981 For a complete list of functions, see the <ref id="functions"
982 name="reference">. The special function <tt/noop/ unbinds the specified key
985 <sect1>Defining aliases for character sets <label id="charset-hook">
987 Usage: <tt/charset-hook/ <em/alias/ <em/charset/<newline>
988 Usage: <tt/iconv-hook/ <em/charset/ <em/local-charset/
990 The <tt/charset-hook/ command defines an alias for a character set.
991 This is useful to properly display messages which are tagged with a
992 character set name not known to mutt.
994 The <tt/iconv-hook/ command defines a system-specific name for a
995 character set. This is helpful when your systems character
996 conversion library insists on using strange, system-specific names
1000 <sect1>Setting variables based upon mailbox<label id="folder-hook">
1002 Usage: <tt/folder-hook/ [!]<em/regexp/ <em/command/
1004 It is often desirable to change settings based on which mailbox you are
1005 reading. The folder-hook command provides a method by which you can execute
1006 any configuration command. <em/regexp/ is a regular expression specifying
1007 in which mailboxes to execute <em/command/ before loading. If a mailbox
1008 matches multiple folder-hook's, they are executed in the order given in the
1011 <bf/Note:/ if you use the ``!'' shortcut for <ref id="spoolfile"
1012 name="$spoolfile"> at the beginning of the pattern, you must place it
1013 inside of double or single quotes in order to distinguish it from the
1014 logical <em/not/ operator for the expression.
1016 Note that the settings are <em/not/ restored when you leave the mailbox.
1017 For example, a command action to perform is to change the sorting method
1018 based upon the mailbox being read:
1021 folder-hook mutt set sort=threads
1024 However, the sorting method is not restored to its previous value when
1025 reading a different mailbox. To specify a <em/default/ command, use the
1030 folder-hook . set sort=date-sent
1033 <sect1>Keyboard macros<label id="macro">
1035 Usage: <tt/macro/ <em/menu/ <em/key/ <em/sequence/ [ <em/description/ ]
1037 Macros are useful when you would like a single key to perform a series of
1038 actions. When you press <em/key/ in menu <em/menu/, Mutt will behave as if
1039 you had typed <em/sequence/. So if you have a common sequence of commands
1040 you type, you can create a macro to execute those commands with a single
1043 <em/menu/ is the <ref id="maps" name="map"> which the macro will be bound.
1044 Multiple maps may be specified by separating multiple menu arguments by
1045 commas. Whitespace may not be used in between the menu arguments and the
1046 commas separating them.
1048 <em/key/ and <em/sequence/ are expanded by the same rules as the <ref
1049 id="bind" name="key bindings">. There are some additions however. The
1050 first is that control characters in <em/sequence/ can also be specified
1051 as <em/ˆx/. In order to get a caret (`ˆ'') you need to use
1052 <em/ˆˆ/. Secondly, to specify a certain key such as <em/up/
1053 or to invoke a function directly, you can use the format
1054 <em/<key name>/ and <em/<function name>/. For a listing of key
1055 names see the section on <ref id="bind" name="key bindings">. Functions
1056 are listed in the <ref id="functions" name="function reference">.
1058 The advantage with using function names directly is that the macros will
1059 work regardless of the current key bindings, so they are not dependent on
1060 the user having particular key definitions. This makes them more robust
1061 and portable, and also facilitates defining of macros in files used by more
1062 than one user (eg. the system Muttrc).
1064 Optionally you can specify a descriptive text after <em/sequence/,
1065 which is shown in the help screens.
1067 <bf/Note:/ Macro definitions (if any) listed in the help screen(s), are
1068 silently truncated at the screen width, and are not wrapped.
1070 <sect1>Using color and mono video attributes<label id="color">
1072 Usage: <tt/color/ <em/object/ <em/foreground/ <em/background/ [ <em/regexp/ ]<newline>
1073 Usage: <tt/color/ index <em/foreground/ <em/background/ <em/pattern/<newline>
1074 Usage: <tt/uncolor/ index <em/pattern/ [ <em/pattern/ ... ]<newline>
1076 If your terminal supports color, you can spice up Mutt by creating your own
1077 color scheme. To define the color of an object (type of information), you
1078 must specify both a foreground color <bf/and/ a background color (it is not
1079 possible to only specify one or the other).
1081 <em/object/ can be one of:
1085 <item>body (match <em/regexp/ in the body of messages)
1086 <item>bold (hiliting bold patterns in the body of messages)
1087 <item>error (error messages printed by Mutt)
1088 <item>header (match <em/regexp/ in the message header)
1089 <item>hdrdefault (default color of the message header in the pager)
1090 <item>index (match <em/pattern/ in the message index)
1091 <item>indicator (arrow or bar used to indicate the current item in a menu)
1092 <item>markers (the ``+'' markers at the beginning of wrapped lines in the pager)
1093 <item>message (informational messages)
1095 <item>quoted (text matching <ref id="quote_regexp"
1096 name="$quote_regexp"> in the body of a message)
1097 <item>quoted1, quoted2, ..., quoted<bf/N/ (higher levels of quoting)
1098 <item>search (hiliting of words in the pager)
1100 <item>status (mode lines used to display info about the mailbox or message)
1101 <item>tilde (the ``˜'' used to pad blank lines in the pager)
1102 <item>tree (thread tree drawn in the message index and attachment menu)
1103 <item>underline (hiliting underlined patterns in the body of messages)
1106 <em/foreground/ and <em/background/ can be one of the following:
1121 <em/foreground/ can optionally be prefixed with the keyword <tt/bright/ to make
1122 the foreground color boldfaced (e.g., <tt/brightred/).
1124 If your terminal supports it, the special keyword <em/default/ can be
1125 used as a transparent color. The value <em/brightdefault/ is also valid.
1126 If Mutt is linked against the <em/S-Lang/ library, you also need to set
1127 the <em/COLORFGBG/ environment variable to the default colors of your
1128 terminal for this to work; for example (for Bourne-like shells):
1131 set COLORFGBG="green;black"
1135 <bf/Note:/ The <em/S-Lang/ library requires you to use the <em/lightgray/
1136 and <em/brown/ keywords instead of <em/white/ and <em/yellow/ when
1137 setting this variable.
1139 <bf/Note:/ The uncolor command can be applied to the index object only. It
1140 removes entries from the list. You <bf/must/ specify the same pattern
1141 specified in the color command for it to be removed. The pattern ``*'' is
1142 a special token which means to clear the color index list of all entries.
1144 Mutt also recognizes the keywords <em/color0/, <em/color1/, …,
1145 <em/color/<bf/N-1/ (<bf/N/ being the number of colors supported
1146 by your terminal). This is useful when you remap the colors for your
1147 display (for example by changing the color associated with <em/color2/
1148 for your xterm), since color names may then lose their normal meaning.
1150 If your terminal does not support color, it is still possible change the video
1151 attributes through the use of the ``mono'' command:
1153 Usage: <tt/mono/ <em/<object> <attribute>/ [ <em/regexp/ ]<newline>
1154 Usage: <tt/mono/ index <em/attribute/ <em/pattern/<newline>
1155 Usage: <tt/unmono/ index <em/pattern/ [ <em/pattern/ ... ]<newline>
1157 where <em/attribute/ is one of the following:
1167 <sect1>Ignoring (weeding) unwanted message headers<label id="ignore">
1169 Usage: <tt/[un]ignore/ <em/pattern/ [ <em/pattern/ ... ]
1171 Messages often have many header fields added by automatic processing systems,
1172 or which may not seem useful to display on the screen. This command allows
1173 you to specify header fields which you don't normally want to see.
1175 You do not need to specify the full header field name. For example,
1176 ``ignore content-'' will ignore all header fields that begin with the pattern
1177 ``content-''. ``ignore *'' will ignore all headers.
1179 To remove a previously added token from the list, use the ``unignore'' command.
1180 The ``unignore'' command will make Mutt display headers with the given pattern.
1181 For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
1183 ``unignore *'' will remove all tokens from the ignore list.
1187 # Sven's draconian header weeding
1189 unignore from date subject to cc
1190 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
1194 <sect1>Alternative addresses<label id="alternates">
1196 Usage: <tt/[un]alternates/ <em/regexp/ [ <em/regexp/ ... ]<newline>
1198 With various functions, mutt will treat messages differently,
1199 depending on whether you sent them or whether you received them from
1200 someone else. For instance, when replying to a message that you
1201 sent to a different party, mutt will automatically suggest to send
1202 the response to the original message's recipients -- responding to
1203 yourself won't make much sense in many cases. (See <ref
1204 id="reply_to" name="$reply_to">.)
1206 Many users receive e-mail under a number of different addresses. To
1207 fully use mutt's features here, the program must be able to
1208 recognize what e-mail addresses you receive mail under. That's the
1209 purpose of the <tt/alternates/ command: It takes a list of regular
1210 expressions, each of which can identify an address under which you
1213 The <tt/unalternates/ command can be used to write exceptions to
1214 <tt/alternates/ patterns. If an address matches something in an
1215 <tt/alternates/ command, but you nonetheless do not think it is
1216 from you, you can list a more precise pattern under an <tt/unalternates/
1219 To remove a regular expression from the <tt/alternates/ list, use the
1220 <tt/unalternates/ command with exactly the same <em/regexp/.
1221 Likewise, if the <em/regexp/ for a <tt/alternates/ command matches
1222 an entry on the <tt/unalternates/ list, that <tt/unalternates/
1223 entry will be removed. If the <em/regexp/ for <tt/unalternates/
1224 is ``*'', <em/all entries/ on <tt/alternates/ will be removed.
1226 <sect1>Mailing lists<label id="lists">
1228 Usage: <tt/[un]lists/ <em/regexp/ [ <em/regexp/ ... ]<newline>
1229 Usage: <tt/[un]subscribe/ <em/regexp/ [ <em/regexp/ ... ]
1231 Mutt has a few nice features for <ref id="using_lists" name="handling
1232 mailing lists">. In order to take advantage of them, you must
1233 specify which addresses belong to mailing lists, and which mailing
1234 lists you are subscribed to. Once you have done this, the <ref
1235 id="list-reply" name="list-reply"> function will work for all known lists.
1236 Additionally, when you send a message to a subscribed list, mutt will
1237 add a Mail-Followup-To header to tell other users' mail user agents
1238 not to send copies of replies to your personal address. Note that
1239 the Mail-Followup-To header is a non-standard extension which is not
1240 supported by all mail user agents. Adding it is not bullet-proof against
1241 receiving personal CCs of list messages. Also note that the generation
1242 of the Mail-Followup-To header is controlled by the <ref id="followup_to"
1243 name="$followup_to"> configuration variable.
1245 More precisely, Mutt maintains lists of patterns for the addresses
1246 of known and subscribed mailing lists. Every subscribed mailing
1247 list is known. To mark a mailing list as known, use the ``lists''
1248 command. To mark it as subscribed, use ``subscribe''.
1250 You can use regular expressions with both commands. To mark all
1251 messages sent to a specific bug report's address on mutt's bug
1252 tracking system as list mail, for instance, you could say
1253 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
1254 give a portion of the list's e-mail address.
1256 Specify as much of the address as you need to to remove ambiguity. For
1257 example, if you've subscribed to the Mutt mailing list, you will receive mail
1258 addresssed to <em/mutt-users@mutt.org/. So, to tell Mutt that this is a
1259 mailing list, you could add ``lists mutt-users'' to your
1260 initialization file. To tell mutt that you are subscribed to it,
1261 add ``subscribe mutt-users'' to your initialization file instead.
1262 If you also happen to get mail from someone whose address is
1263 <em/mutt-users@example.com/, you could use ``lists mutt-users@mutt\\.org''
1264 or ``subscribe mutt-users@mutt\\.org'' to
1265 match only mail from the actual list.
1267 The ``unlists'' command is used to remove a token from the list of
1268 known and subscribed mailing-lists. Use ``unlists *'' to remove all
1271 To remove a mailing list from the list of subscribed mailing lists,
1272 but keep it on the list of known mailing lists, use ``unsubscribe''.
1274 <sect1>Using Multiple spool mailboxes<label id="mbox-hook">
1276 Usage: <tt/mbox-hook/ [!]<em/pattern/ <em/mailbox/
1278 This command is used to move read messages from a specified mailbox to a
1279 different mailbox automatically when you quit or change folders.
1280 <em/pattern/ is a regular expression specifying the mailbox to treat as a
1281 ``spool'' mailbox and <em/mailbox/ specifies where mail should be saved when
1284 Unlike some of the other <em/hook/ commands, only the <em/first/ matching
1285 pattern is used (it is not possible to save read mail in more than a single
1288 <sect1>Defining mailboxes which receive mail<label id="mailboxes">
1290 Usage: <tt/[un]mailboxes/ [!]<em/filename/ [ <em/filename/ ... ]
1292 This command specifies folders which can receive mail and
1293 which will be checked for new messages. By default, the
1294 main menu status bar displays how many of these folders have
1297 When changing folders, pressing <em/space/ will cycle
1298 through folders with new mail.
1300 Pressing TAB in the directory browser will bring up a menu showing the files
1301 specified by the <tt/mailboxes/ command, and indicate which contain new
1302 messages. Mutt will automatically enter this mode when invoked from the
1303 command line with the <tt/-y/ option.
1305 The ``unmailboxes'' command is used to remove a token from the list
1306 of folders which receive mail. Use ``unmailboxes *'' to remove all
1310 <bf/Note:/ new mail is detected by comparing the last modification time to
1311 the last access time. Utilities like <tt/biff/ or <tt/frm/ or any other
1312 program which accesses the mailbox might cause Mutt to never detect new mail
1313 for that mailbox if they do not properly reset the access time. Backup
1314 tools are another common reason for updated access times.
1317 <bf/Note:/ the filenames in the <tt/mailboxes/ command are resolved when
1318 the command is executed, so if these names contain <ref id="shortcuts"
1319 name="shortcut characters"> (such as ``='' and ``!''), any variable
1320 definition that affect these characters (like <ref id="folder"
1321 name="$folder"> and <ref id="spoolfile" name="$spoolfile">)
1322 should be executed before the <tt/mailboxes/ command.
1324 <sect1>User defined headers<label id="my_hdr">
1327 <tt/my_hdr/ <em/string/<newline>
1328 <tt/unmy_hdr/ <em/field/ [ <em/field/ ... ]
1330 The ``my_hdr'' command allows you to create your own header
1331 fields which will be added to every message you send.
1333 For example, if you would like to add an ``Organization:'' header field to
1334 all of your outgoing messages, you can put the command
1337 my_hdr Organization: A Really Big Company, Anytown, USA
1340 in your <tt/.muttrc/.
1342 <bf/Note:/ space characters are <em/not/ allowed between the keyword and
1343 the colon (``:''). The standard for electronic mail (RFC822) says that
1344 space is illegal there, so Mutt enforces the rule.
1346 If you would like to add a header field to a single message, you should
1347 either set the <ref id="edit_headers" name="edit_headers"> variable,
1348 or use the <em/edit-headers/ function (default: ``E'') in the send-menu so
1349 that you can edit the header of your message along with the body.
1351 To remove user defined header fields, use the ``unmy_hdr''
1352 command. You may specify an asterisk (``*'') to remove all header
1353 fields, or the fields to remove. For example, to remove all ``To'' and
1354 ``Cc'' header fields, you could use:
1360 <sect1>Defining the order of headers when viewing messages<label id="hdr_order">
1362 Usage: <tt/hdr_order/ <em/header1/ <em/header2/ <em/header3/
1364 With this command, you can specify an order in which mutt will attempt
1365 to present headers to you when viewing messages.
1367 ``unhdr_order *'' will clear all previous headers from the order list,
1368 thus removing the header order effects set by the system-wide startup
1372 hdr_order From Date: From: To: Cc: Subject:
1375 <sect1>Specify default save filename<label id="save-hook">
1377 Usage: <tt/save-hook/ [!]<em/pattern/ <em/filename/
1379 This command is used to override the default filename used when saving
1380 messages. <em/filename/ will be used as the default filename if the message is
1381 <em/From:/ an address matching <em/regexp/ or if you are the author and the
1382 message is addressed <em/to:/ something matching <em/regexp/.
1384 See <ref id="pattern_hook" name="Message Matching in Hooks"> for information on the exact format of <em/pattern/.
1389 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
1390 save-hook aol\\.com$ +spam
1393 Also see the <ref id="fcc-save-hook" name="fcc-save-hook"> command.
1395 <sect1>Specify default Fcc: mailbox when composing<label id="fcc-hook">
1397 Usage: <tt/fcc-hook/ [!]<em/pattern/ <em/mailbox/
1399 This command is used to save outgoing mail in a mailbox other than
1400 <ref id="record" name="$record">. Mutt searches the initial list of
1401 message recipients for the first matching <em/regexp/ and uses <em/mailbox/
1402 as the default Fcc: mailbox. If no match is found the message will be saved
1403 to <ref id="record" name="$record"> mailbox.
1405 See <ref id="pattern_hook" name="Message Matching in Hooks"> for information on the exact format of <em/pattern/.
1407 Example: <tt/fcc-hook [@.]aol\\.com$ +spammers/
1409 The above will save a copy of all messages going to the aol.com domain to
1410 the `+spammers' mailbox by default. Also see the <ref id="fcc-save-hook"
1411 name="fcc-save-hook"> command.
1413 <sect1>Specify default save filename and default Fcc: mailbox at once<label
1416 Usage: <tt/fcc-save-hook/ [!]<em/pattern/ <em/mailbox/
1418 This command is a shortcut, equivalent to doing both a <ref id="fcc-hook" name="fcc-hook">
1419 and a <ref id="save-hook" name="save-hook"> with its arguments.
1421 <sect1>Change settings based upon message recipients<label id="send-hook"><label id="reply-hook"><label id="send2-hook">
1423 Usage: <tt/reply-hook/ [!]<em/pattern/ <em/command/<newline>
1424 Usage: <tt/send-hook/ [!]<em/pattern/ <em/command/<newline>
1425 Usage: <tt/send2-hook/ [!]<em/pattern/ <em/command/
1427 These commands can be used to execute arbitrary configuration commands based
1428 upon recipients of the message. <em/pattern/ is a regular expression
1429 matching the desired address. <em/command/ is executed when <em/regexp/
1430 matches recipients of the message.
1432 <tt/reply-hook/ is matched against the message you are <em/replying/
1433 <bf/to/, instead of the message you are <em/sending/. <tt/send-hook/ is
1434 matched against all messages, both <em/new/ and <em/replies/. <bf/Note:/
1435 <tt/reply-hook/s are matched <bf/before/ the <tt/send-hook/, <bf/regardless/
1436 of the order specified in the users's configuration file.
1438 <tt/send2-hook/ is matched every time a message is changed, either
1439 by editing it, or by using the compose menu to change its recipients
1440 or subject. <tt/send2-hook/ is executed after <tt/send-hook/, and
1441 can, e.g., be used to set parameters such as the <ref id="sendmail"
1442 name="$sendmail"> variable depending on the message's sender
1445 For each type of <tt/send-hook/ or <tt/reply-hook/, when multiple matches
1446 occur, commands are executed in the order they are specified in the muttrc
1447 (for that type of hook).
1449 See <ref id="pattern_hook" name="Message Matching in Hooks"> for information on the exact format of <em/pattern/.
1451 Example: <tt/send-hook mutt &dquot;set mime_forward signature=''&dquot;/
1453 Another typical use for this command is to change the values of the
1454 <ref id="attribution" name="$attribution">, <ref id="signature"
1455 name="$signature"> and <ref id="locale" name="$locale">
1456 variables in order to change the language of the attributions and
1457 signatures based upon the recipients.
1459 <bf/Note:/ the send-hook's are only executed ONCE after getting the initial
1460 list of recipients. Adding a recipient after replying or editing the
1461 message will NOT cause any send-hook to be executed. Also note that
1462 my_hdr commands which modify recipient headers, or the message's
1463 subject, don't have any effect on the current message when executed
1466 <sect1>Change settings before formatting a message<label id="message-hook">
1468 Usage: <tt/message-hook/ [!]<em/pattern/ <em/command/
1470 This command can be used to execute arbitrary configuration commands
1471 before viewing or formatting a message based upon information about the message.
1472 <em/command/ is executed if the <em/pattern/ matches the message to be
1473 displayed. When multiple matches occur, commands are executed in the order
1474 they are specified in the muttrc.
1476 See <ref id="pattern_hook" name="Message Matching in Hooks"> for
1477 information on the exact format of <em/pattern/.
1481 message-hook ~A 'set pager=builtin'
1482 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
1485 <sect1>Choosing the cryptographic key of the recipient<label id="crypt-hook">
1487 Usage: <tt/crypt-hook/ <em/pattern/ <em/keyid/
1489 When encrypting messages with PGP or OpenSSL, you may want to associate a certain
1490 key with a given e-mail address automatically, either because the
1491 recipient's public key can't be deduced from the destination address,
1492 or because, for some reasons, you need to override the key Mutt would
1493 normally use. The crypt-hook command provides a method by which you can
1494 specify the ID of the public key to be used when encrypting messages to
1495 a certain recipient.
1497 The meaning of "key id" is to be taken broadly in this context: You
1498 can either put a numerical key ID here, an e-mail address, or even
1501 <sect1>Adding key sequences to the keyboard buffer<label id="push">
1503 Usage: <tt/push/ <em/string/
1505 This command adds the named string to the keyboard buffer. The string may
1506 contain control characters, key names and function names like the sequence
1507 string in the <ref id="macro" name="macro"> command. You may use it to
1508 automatically run a sequence of commands at startup, or when entering
1511 <sect1>Executing functions<label id="exec">
1513 Usage: <tt/exec/ <em/function/ [ <em/function/ ... ]
1515 This command can be used to execute any function. Functions are
1516 listed in the <ref id="functions" name="function reference">.
1517 ``exec function'' is equivalent to ``push <function>''.
1519 <sect1>Message Scoring<label id="score-command">
1521 Usage: <tt/score/ <em/pattern/ <em/value/<newline>
1522 Usage: <tt/unscore/ <em/pattern/ [ <em/pattern/ ... ]
1524 The <tt/score/ commands adds <em/value/ to a message's score if <em/pattern/
1525 matches it. <em/pattern/ is a string in the format described in the <ref
1526 id="patterns" name="patterns"> section (note: For efficiency reasons, patterns
1527 which scan information not available in the index, such as <tt>˜b</tt>,
1528 <tt>˜B</tt> or <tt>˜h</tt>, may not be used). <em/value/ is a
1529 positive or negative integer. A message's final score is the sum total of all
1530 matching <tt/score/ entries. However, you may optionally prefix <em/value/ with
1531 an equal sign (=) to cause evaluation to stop at a particular entry if there is
1532 a match. Negative final scores are rounded up to 0.
1534 The <tt/unscore/ command removes score entries from the list. You <bf/must/
1535 specify the same pattern specified in the <tt/score/ command for it to be
1536 removed. The pattern ``*'' is a special token which means to clear the list
1537 of all score entries.
1539 <sect1>Spam detection<label id="spam">
1541 Usage: <tt/spam/ <em/pattern/ <em/format/<newline>
1542 Usage: <tt/nospam/ <em/pattern/
1544 Mutt has generalized support for external spam-scoring filters.
1545 By defining your spam patterns with the <tt/spam/ and <tt/nospam/
1546 commands, you can <em/limit/, <em/search/, and <em/sort/ your
1547 mail based on its spam attributes, as determined by the external
1548 filter. You also can display the spam attributes in your index
1549 display using the <tt/%H/ selector in the <ref id="index_format"
1550 name="$index_format"> variable. (Tip: try <tt/%?H?[%H] ?/
1551 to display spam tags only when they are defined for a given message.)
1553 Your first step is to define your external filter's spam patterns using
1554 the <tt/spam/ command. <em/pattern/ should be a regular expression
1555 that matches a header in a mail message. If any message in the mailbox
1556 matches this regular expression, it will receive a ``spam tag'' or
1557 ``spam attribute'' (unless it also matches a <tt/nospam/ pattern -- see
1558 below.) The appearance of this attribute is entirely up to you, and is
1559 governed by the <em/format/ parameter. <em/format/ can be any static
1560 text, but it also can include back-references from the <em/pattern/
1561 expression. (A regular expression ``back-reference'' refers to a
1562 sub-expression contained within parentheses.) <tt/%1/ is replaced with
1563 the first back-reference in the regex, <tt/%2/ with the second, etc.
1565 If you're using multiple spam filters, a message can have more than
1566 one spam-related header. You can define <tt/spam/ patterns for each
1567 filter you use. If a message matches two or more of these patterns, and
1568 the $spam_separator variable is set to a string, then the
1569 message's spam tag will consist of all the <em/format/ strings joined
1570 together, with the value of $spam_separator separating
1573 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
1574 define these spam settings:
1576 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
1577 spam "X-Spam-Status: Yes" "90+/SA"
1578 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
1579 set spam_separator=", "
1582 If I then received a message that DCC registered with ``many'' hits
1583 under the ``Fuz2'' checksum, and that PureMessage registered with a
1584 97% probability of being spam, that message's spam tag would read
1585 <tt>90+/DCC-Fuz2, 97/PM</tt>. (The four characters before ``=many'' in a
1586 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
1588 If the $spam_separator variable is unset, then each
1589 spam pattern match supercedes the previous one. Instead of getting
1590 joined <em/format/ strings, you'll get only the last one to match.
1592 The spam tag is what will be displayed in the index when you use
1593 <tt/%H/ in the <tt/$index_format/ variable. It's also the
1594 string that the <tt/~H/ pattern-matching expression matches against for
1595 <em/search/ and <em/limit/ functions. And it's what sorting by spam
1596 attribute will use as a sort key.
1598 That's a pretty complicated example, and most people's actual
1599 environments will have only one spam filter. The simpler your
1600 configuration, the more effective mutt can be, especially when it comes
1603 Generally, when you sort by spam tag, mutt will sort <em/lexically/ --
1604 that is, by ordering strings alphnumerically. However, if a spam tag
1605 begins with a number, mutt will sort numerically first, and lexically
1606 only when two numbers are equal in value. (This is like UNIX's
1607 <tt/sort -n/.) A message with no spam attributes at all -- that is, one
1608 that didn't match <em/any/ of your <tt/spam/ patterns -- is sorted at
1609 lowest priority. Numbers are sorted next, beginning with 0 and ranging
1610 upward. Finally, non-numeric strings are sorted, with ``a'' taking lower
1611 priority than ``z''. Clearly, in general, sorting by spam tags is most
1612 effective when you can coerce your filter to give you a raw number. But
1613 in case you can't, mutt can still do something useful.
1615 The <tt/nospam/ command can be used to write exceptions to <tt/spam/
1616 patterns. If a header pattern matches something in a <tt/spam/ command,
1617 but you nonetheless do not want it to receive a spam tag, you can list a
1618 more precise pattern under a <tt/nospam/ command.
1620 If the <em/pattern/ given to <tt/nospam/ is exactly the same as the
1621 <em/pattern/ on an existing <tt/spam/ list entry, the effect will be to
1622 remove the entry from the spam list, instead of adding an exception.
1623 Likewise, if the <em/pattern/ for a <tt/spam/ command matches an entry
1624 on the <tt/nospam/ list, that <tt/nospam/ entry will be removed. If the
1625 <em/pattern/ for <tt/nospam/ is ``*'', <em/all entries on both lists/
1626 will be removed. This might be the default action if you use <tt/spam/
1627 and <tt/nospam/ in conjunction with a <tt/folder-hook/.
1629 You can have as many <tt/spam/ or <tt/nospam/ commands as you like.
1630 You can even do your own primitive spam detection within mutt -- for
1631 example, if you consider all mail from <tt/MAILER-DAEMON/ to be spam,
1632 you can use a <tt/spam/ command like this:
1635 spam "^From: .*MAILER-DAEMON" "999"
1639 <sect1>Setting variables<label id="set">
1641 Usage: <tt/set/ [no|inv]<em/variable/[=<em/value/] [ <em/variable/ ... ]<newline>
1642 Usage: <tt/toggle/ <em/variable/ [<em/variable/ ... ]<newline>
1643 Usage: <tt/unset/ <em/variable/ [<em/variable/ ... ]<newline>
1644 Usage: <tt/reset/ <em/variable/ [<em/variable/ ... ]
1646 This command is used to set (and unset) <ref id="variables"
1647 name="configuration variables">. There are four basic types of variables:
1648 boolean, number, string and quadoption. <em/boolean/ variables can be
1649 <em/set/ (true) or <em/unset/ (false). <em/number/ variables can be
1650 assigned a positive integer value.
1652 <em/string/ variables consist of any number of printable characters.
1653 <em/strings/ must be enclosed in quotes if they contain spaces or tabs. You
1654 may also use the ``C'' escape sequences <bf/\n/ and <bf/\t/ for
1655 newline and tab, respectively.
1657 <em/quadoption/ variables are used to control whether or not to be prompted
1658 for certain actions, or to specify a default action. A value of <em/yes/
1659 will cause the action to be carried out automatically as if you had answered
1660 yes to the question. Similarly, a value of <em/no/ will cause the the
1661 action to be carried out as if you had answered ``no.'' A value of
1662 <em/ask-yes/ will cause a prompt with a default answer of ``yes'' and
1663 <em/ask-no/ will provide a default answer of ``no.''
1665 Prefixing a variable with ``no'' will unset it. Example: <tt/set noaskbcc/.
1667 For <em/boolean/ variables, you may optionally prefix the variable name with
1668 <tt/inv/ to toggle the value (on or off). This is useful when writing
1669 macros. Example: <tt/set invsmart_wrap/.
1671 The <tt/toggle/ command automatically prepends the <tt/inv/ prefix to all
1672 specified variables.
1674 The <tt/unset/ command automatically prepends the <tt/no/ prefix to all
1675 specified variables.
1677 Using the enter-command function in the <em/index/ menu, you can query the
1678 value of a variable by prefixing the name of the variable with a question
1685 The question mark is actually only required for boolean and quadoption
1688 The <tt/reset/ command resets all given variables to the compile time
1689 defaults (hopefully mentioned in this manual). If you use the command
1690 <tt/set/ and prefix the variable with ``&'' this has the same
1691 behavior as the reset command.
1693 With the <tt/reset/ command there exists the special variable ``all'',
1694 which allows you to reset all variables to their system defaults.
1696 <sect1>Reading initialization commands from another file<label id="source">
1698 Usage: <tt/source/ <em/filename/ [ <em/filename/ ... ]
1700 This command allows the inclusion of initialization commands
1701 from other files. For example, I place all of my aliases in
1702 <tt>˜/.mail_aliases</tt> so that I can make my
1703 <tt>˜/.muttrc</tt> readable and keep my aliases private.
1705 If the filename begins with a tilde (``˜''), it will be expanded to the
1706 path of your home directory.
1708 If the filename ends with a vertical bar (|), then <em/filename/ is
1709 considered to be an executable program from which to read input (eg.
1710 <tt>source ~/bin/myscript|</tt>).
1712 <sect1>Configuring features conditionaly<label id="ifdef">
1714 Usage: <tt/ifdef/ <em/item/ <em/command/
1715 Usage: <tt/ifndef/ <em/item/ <em/command/
1717 These command allows to test if a variable, function or certain feature
1718 is available or not respectively, before actually executing the command.
1719 <tt/ifdef/ (short for ``if defined) handles commands if upon
1720 availability while <tt/ifndef/ (short for ``if not defined'') does if
1721 not. The <em/command/ may be any valid fraction of a configuration file.
1723 All names of variables and functions may be tested. Additionally, the
1724 following compile-features may be tested when prefixed with 'feature_':
1725 ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
1726 gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
1727 classic_smime, gpgme, header_cache.
1731 To only source a file with IMAP related settings only if IMAP support is
1734 ifdef feature_imap 'source ~/.mutt-ng/imap_setup'
1736 # ifdef imap_user 'source ~/.mutt-ng/imap_setup'
1741 To exit mutt-ng directly if no NNTP support is compiled in:
1743 ifndef feature_nntp 'push q'
1745 # ifndef newsrc 'push q'
1750 To only set the <ref id="imap_mail_check"
1751 name="<$imap_mail_check"> when the system's SVN
1752 is recent enough to have it:
1754 ifdef imap_mail_check 'set imap_mail_check=300'
1757 <sect1>Removing hooks<label id="unhook">
1759 Usage: <tt/unhook/ [ * | <em/hook-type/ ]
1761 This command permits you to flush hooks you have previously defined.
1762 You can either remove all hooks by giving the ``*'' character as an
1763 argument, or you can remove all hooks of a specific type by saying
1764 something like <tt/unhook send-hook/.
1766 <sect>Advanced Usage
1768 <sect1>Regular Expressions<label id="regexp">
1770 All string patterns in Mutt including those in more complex
1771 <ref id="patterns" name="patterns"> must be specified
1772 using regular expressions (regexp) in the ``POSIX extended'' syntax (which
1773 is more or less the syntax used by egrep and GNU awk). For your
1774 convenience, we have included below a brief description of this syntax.
1776 The search is case sensitive if the pattern contains at least one upper
1777 case letter, and case insensitive otherwise. Note that ``\''
1778 must be quoted if used for a regular expression in an initialization
1779 command: ``\\''.
1781 A regular expression is a pattern that describes a set of strings.
1782 Regular expressions are constructed analogously to arithmetic
1783 expressions, by using various operators to combine smaller expressions.
1785 Note that the regular expression can be enclosed/delimited by either &dquot;
1786 or ' which is useful if the regular expression includes a white-space
1787 character. See <ref id="muttrc-syntax" name="Syntax of Initialization Files">
1788 for more information on &dquot; and ' delimiter processing. To match a
1789 literal &dquot; or ' you must preface it with \ (backslash).
1791 The fundamental building blocks are the regular expressions that match
1792 a single character. Most characters, including all letters and digits,
1793 are regular expressions that match themselves. Any metacharacter with
1794 special meaning may be quoted by preceding it with a backslash.
1796 The period ``.'' matches any single character. The caret ``ˆ'' and
1797 the dollar sign ``&dollar'' are metacharacters that respectively match
1798 the empty string at the beginning and end of a line.
1800 A list of characters enclosed by ``['' and ``]'' matches any
1801 single character in that list; if the first character of the list
1802 is a caret ``ˆ'' then it matches any character <bf/not/ in the
1803 list. For example, the regular expression <bf/[0123456789]/
1804 matches any single digit. A range of ASCII characters may be specified
1805 by giving the first and last characters, separated by a hyphen
1806 ``‐''. Most metacharacters lose their special meaning inside
1807 lists. To include a literal ``]'' place it first in the list.
1808 Similarly, to include a literal ``ˆ'' place it anywhere but first.
1809 Finally, to include a literal hyphen ``‐'' place it last.
1811 Certain named classes of characters are predefined. Character classes
1812 consist of ``[:'', a keyword denoting the class, and ``:]''.
1813 The following classes are defined by the POSIX standard:
1816 <tag/[:alnum:]/
1817 Alphanumeric characters.
1818 <tag/[:alpha:]/
1819 Alphabetic characters.
1820 <tag/[:blank:]/
1821 Space or tab characters.
1822 <tag/[:cntrl:]/
1824 <tag/[:digit:]/
1826 <tag/[:graph:]/
1827 Characters that are both printable and visible. (A space is printable,
1828 but not visible, while an ``a'' is both.)
1829 <tag/[:lower:]/
1830 Lower-case alphabetic characters.
1831 <tag/[:print:]/
1832 Printable characters (characters that are not control characters.)
1833 <tag/[:punct:]/
1834 Punctuation characters (characters that are not letter, digits, control
1835 characters, or space characters).
1836 <tag/[:space:]/
1837 Space characters (such as space, tab and formfeed, to name a few).
1838 <tag/[:upper:]/
1839 Upper-case alphabetic characters.
1840 <tag/[:xdigit:]/
1841 Characters that are hexadecimal digits.
1844 A character class is only valid in a regular expression inside the
1845 brackets of a character list. Note that the brackets in these
1846 class names are part of the symbolic names, and must be included
1847 in addition to the brackets delimiting the bracket list. For
1848 example, <bf/[[:digit:]]/ is equivalent to
1849 <bf/[0-9]/.
1851 Two additional special sequences can appear in character lists. These
1852 apply to non-ASCII character sets, which can have single symbols (called
1853 collating elements) that are represented with more than one character,
1854 as well as several characters that are equivalent for collating or
1858 <tag/Collating Symbols/
1859 A collating symbol is a multi-character collating element enclosed in
1860 ``[.'' and ``.]''. For example, if ``ch'' is a collating
1861 element, then <bf/[[.ch.]]/ is a regexp that matches
1862 this collating element, while <bf/[ch]/ is a regexp that
1863 matches either ``c'' or ``h''.
1864 <tag/Equivalence Classes/
1865 An equivalence class is a locale-specific name for a list of
1866 characters that are equivalent. The name is enclosed in ``[=''
1867 and ``=]''. For example, the name ``e'' might be used to
1868 represent all of ``è'' ``é'' and ``e''. In this case,
1869 <bf/[[=e=]]/ is a regexp that matches any of
1870 ``è'', ``é'' and ``e''.
1873 A regular expression matching a single character may be followed by one
1874 of several repetition operators:
1878 The preceding item is optional and matched at most once.
1880 The preceding item will be matched zero or more times.
1882 The preceding item will be matched one or more times.
1884 The preceding item is matched exactly <em/n/ times.
1885 <tag/{n,}/
1886 The preceding item is matched <em/n/ or more times.
1887 <tag/{,m}/
1888 The preceding item is matched at most <em/m/ times.
1889 <tag/{n,m}/
1890 The preceding item is matched at least <em/n/ times, but no more than
1894 Two regular expressions may be concatenated; the resulting regular
1895 expression matches any string formed by concatenating two substrings
1896 that respectively match the concatenated subexpressions.
1898 Two regular expressions may be joined by the infix operator ``|'';
1899 the resulting regular expression matches any string matching either
1902 Repetition takes precedence over concatenation, which in turn takes
1903 precedence over alternation. A whole subexpression may be enclosed in
1904 parentheses to override these precedence rules.
1906 <bf/Note:/ If you compile Mutt with the GNU <em/rx/ package, the
1907 following operators may also be used in regular expressions:
1911 Matches the empty string at either the beginning or the end of a word.
1913 Matches the empty string within a word.
1914 <tag/\\</
1915 Matches the empty string at the beginning of a word.
1916 <tag/\\>/
1917 Matches the empty string at the end of a word.
1919 Matches any word-constituent character (letter, digit, or underscore).
1921 Matches any character that is not word-constituent.
1923 Matches the empty string at the beginning of a buffer (string).
1925 Matches the empty string at the end of a buffer.
1928 Please note however that these operators are not defined by POSIX, so
1929 they may or may not be available in stock libraries on various systems.
1931 <sect1>Patterns<label id="patterns">
1933 Many of Mutt's commands allow you to specify a pattern to match
1934 (limit, tag-pattern, delete-pattern, etc.). There are several ways to select
1939 ~b EXPR messages which contain EXPR in the message body
1940 ~B EXPR messages which contain EXPR in the whole message
1941 ~c USER messages carbon-copied to USER
1942 ~C EXPR message is either to: or cc: EXPR
1944 ~d [MIN]-[MAX] messages with ``date-sent'' in a Date range
1946 ~e EXPR message which contains EXPR in the ``Sender'' field
1948 ~f USER messages originating from USER
1949 ~g cryptographically signed messages
1950 ~G cryptographically encrypted messages
1951 ~H EXPR messages with a spam attribute matching EXPR
1952 ~h EXPR messages which contain EXPR in the message header
1953 ~k message contains PGP key material
1954 ~i ID message which match ID in the ``Message-ID'' field
1955 ~L EXPR message is either originated or received by EXPR
1956 ~l message is addressed to a known mailing list
1957 ~m [MIN]-[MAX] message in the range MIN to MAX *)
1958 ~n [MIN]-[MAX] messages with a score in the range MIN to MAX *)
1961 ~p message is addressed to you (consults alternates)
1962 ~P message is from you (consults alternates)
1963 ~Q messages which have been replied to
1965 ~r [MIN]-[MAX] messages with ``date-received'' in a Date range
1966 ~S superseded messages
1967 ~s SUBJECT messages having SUBJECT in the ``Subject'' field.
1969 ~t USER messages addressed to USER
1971 ~v message is part of a collapsed thread.
1972 ~V cryptographically verified messages
1973 ~x EXPR messages which contain EXPR in the `References' field
1974 ~y EXPR messages which contain EXPR in the `X-Label' field
1975 ~z [MIN]-[MAX] messages with a size in the range MIN to MAX *)
1976 ~= duplicated messages (see $duplicate_threads)
1977 ~$ unreferenced messages (requires threaded view)
1978 ~* ``From'' contains realname and (syntactically) valid
1979 address (excluded are addresses matching against
1980 alternates or any alias)
1983 Where EXPR, USER, ID, and SUBJECT are
1984 <ref id="regexp" name="regular expressions">. Special attention has to be
1985 made when using regular expressions inside of patterns. Specifically,
1986 Mutt's parser for these patterns will strip one level of backslash (\),
1987 which is normally used for quoting. If it is your intention to use a
1988 backslash in the regular expression, you will need to use two backslashes
1991 *) The forms <tt/<[MAX]/, <tt/>[MIN]/,
1992 <tt/[MIN]-/ and <tt/-[MAX]/
1995 <sect2>Pattern Modifier
1998 Note that patterns matching 'lists' of addresses (notably c,C,p,P and t)
1999 match if there is at least one match in the whole list. If you want to
2000 make sure that all elements of that list match, you need to prefix your
2002 This example matches all mails which only has recipients from Germany.
2008 <sect2>Complex Patterns
2011 Logical AND is performed by specifying more than one criterion. For
2018 would select messages which contain the word ``mutt'' in the list of
2019 recipients <bf/and/ that have the word ``elkins'' in the ``From'' header
2022 Mutt also recognizes the following operators to create more complex search
2026 <item>! -- logical NOT operator
2027 <item>| -- logical OR operator
2028 <item>() -- logical grouping operator
2031 Here is an example illustrating a complex search pattern. This pattern will
2032 select all messages which do not contain ``mutt'' in the ``To'' or ``Cc''
2033 field and which are from ``elkins''.
2036 !(~t mutt|~c mutt) ~f elkins
2039 Here is an example using white space in the regular expression (note
2040 the ' and &dquot; delimiters). For this to match, the mail's subject must
2041 match the ``^Junk +From +Me$'' and it must be from either ``Jim +Somebody''
2042 or ``Ed +SomeoneElse'':
2045 '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
2048 Note that if a regular expression contains parenthesis, or a veritical bar
2049 ("|"), you <bf/must/ enclose the expression in double or single quotes since
2050 those characters are also used to separate different parts of Mutt's
2051 pattern language. For example,
2054 ~f "me@(mutt\.org|cs\.hmc\.edu)"
2057 Without the quotes, the parenthesis wouldn't end.
2058 This would be seperated to two OR'd patterns: <em/˜f me@(mutt\.org/
2059 and <em/cs\.hmc\.edu)/. They are never what you want.
2061 <sect2>Searching by Date
2063 Mutt supports two types of dates, <em/absolute/ and <em/relative/.
2065 <bf/Absolute/. Dates <bf/must/ be in DD/MM/YY format (month and year are
2066 optional, defaulting to the current month and year). An example of a valid
2070 Limit to messages matching: ~d 20/1/95-31/10
2073 If you omit the minimum (first) date, and just specify ``-DD/MM/YY'', all
2074 messages <em/before/ the given date will be selected. If you omit the maximum
2075 (second) date, and specify ``DD/MM/YY-'', all messages <em/after/ the given
2076 date will be selected. If you specify a single date with no dash (``-''),
2077 only messages sent on the given date will be selected.
2079 <bf/Error Margins/. You can add error margins to absolute dates.
2080 An error margin is a sign (+ or -), followed by a digit, followed by
2081 one of the following units:
2088 As a special case, you can replace the sign by a ``*'' character,
2089 which is equivalent to giving identical plus and minus error margins.
2091 Example: To select any messages two weeks around January 15, 2001,
2092 you'd use the following pattern:
2094 Limit to messages matching: ~d 15/1/2001*2w
2098 <bf/Relative/. This type of date is relative to the current date, and may
2101 <item>><em/offset/ (messages older than <em/offset/ units)
2102 <item><<em/offset/ (messages newer than <em/offset/ units)
2103 <item>=<em/offset/ (messages exactly <em/offset/ units old)
2106 <em/offset/ is specified as a positive number with one of the following
2115 Example: to select messages less than 1 month old, you would use
2117 Limit to messages matching: ~d <1m
2122 <bf/Note:/ all dates used when searching are relative to the
2123 <bf/local/ time zone, so unless you change the setting of your <ref
2124 id="index_format" name="$index_format"> to include a
2125 <tt/%[...]/ format, these are <bf/not/ the dates shown
2131 Sometimes it is desirable to perform an operation on a group of
2132 messages all at once rather than one at a time. An example might be
2133 to save messages to a mailing list to a separate folder, or to
2134 delete all messages with a given subject. To tag all messages
2135 matching a pattern, use the tag-pattern function, which is bound to
2136 ``shift-T'' by default. Or you can select individual messages by
2137 hand using the ``tag-message'' function, which is bound to ``t'' by
2138 default. See <ref id="patterns" name="patterns"> for Mutt's pattern
2141 Once you have tagged the desired messages, you can use the
2142 ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
2143 When the ``tag-prefix'' operator is used, the <bf/next/ operation will
2144 be applied to all tagged messages if that operation can be used in that
2145 manner. If the <ref id="auto_tag" name="$auto_tag">
2146 variable is set, the next operation applies to the tagged messages
2147 automatically, without requiring the ``tag-prefix''.
2149 In <ref id="macro" name="macros"> or <ref id="push" name="push"> commands,
2150 you can use the ``tag-prefix-cond'' operator. If there are no tagged
2151 messages, mutt will "eat" the rest of the macro to abort it's execution.
2152 Mutt will stop "eating" the macro when it encounters the ``end-cond''
2153 operator; after this operator the rest of the macro will be executed as
2156 <sect1>Using Hooks<label id="hooks">
2158 A <em/hook/ is a concept borrowed from the EMACS editor which allows you to
2159 execute arbitrary commands before performing some operation. For example,
2160 you may wish to tailor your configuration based upon which mailbox you are
2161 reading, or to whom you are sending mail. In the Mutt world, a <em/hook/
2162 consists of a <ref id="regexp" name="regular expression"> or
2163 <ref id="patterns" name="pattern"> along with a
2164 configuration option/command. See
2166 <item><ref id="folder-hook" name="folder-hook">
2167 <item><ref id="send-hook" name="send-hook">
2168 <item><ref id="message-hook" name="message-hook">
2169 <item><ref id="save-hook" name="save-hook">
2170 <item><ref id="mbox-hook" name="mbox-hook">
2171 <item><ref id="fcc-hook" name="fcc-hook">
2172 <item><ref id="fcc-save-hook" name="fcc-save-hook">
2174 for specific details on each type of <em/hook/ available.
2176 <bf/Note:/ if a hook changes configuration settings, these changes remain
2177 effective until the end of the current mutt session. As this is generally
2178 not desired, a default hook needs to be added before all other hooks to
2179 restore configuration defaults. Here is an example with send-hook and the
2183 send-hook . 'unmy_hdr From:'
2184 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
2187 <sect2>Message Matching in Hooks<label id="pattern_hook">
2189 Hooks that act upon messages (<tt/send-hook, save-hook, fcc-hook,
2190 message-hook/) are evaluated in a slightly different manner. For the other
2191 types of hooks, a <ref id="regexp" name="regular expression"> is
2192 sufficient. But in dealing with messages a finer grain of control is
2193 needed for matching since for different purposes you want to match
2196 Mutt allows the use of the <ref id="patterns" name="search pattern">
2197 language for matching messages in hook commands. This works in
2198 exactly the same way as it would when <em/limiting/ or
2199 <em/searching/ the mailbox, except that you are restricted to those
2200 operators which match information mutt extracts from the header of
2201 the message (i.e. from, to, cc, date, subject, etc.).
2203 For example, if you wanted to set your return address based upon sending
2204 mail to a specific address, you could do something like:
2206 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
2208 which would execute the given command when sending mail to
2211 However, it is not required that you write the pattern to match using the
2212 full searching language. You can still specify a simple <em/regular
2213 expression/ like the other hooks, in which case Mutt will translate your
2214 pattern into the full language, using the translation specified by the
2215 <ref id="default_hook" name="$default_hook"> variable. The
2216 pattern is translated at the time the hook is declared, so the value of
2217 <ref id="default_hook" name="$default_hook"> that is in effect
2218 at that time will be used.
2220 <sect1>Using the sidebar<label id="sidebar">
2222 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing
2223 which looks very similar to the ones you probably know from GUI mail clients.
2224 The sidebar lists all specified mailboxes, shows the number in each
2225 and highlights the ones with new email
2226 Use the following configuration commands:
2228 set sidebar_visible="yes"
2229 set sidebar_width=25
2232 If you want to specify the mailboxes you can do so with:
2241 You can also specify the colors for mailboxes with new mails by using:
2243 color sidebar_new red black
2244 color sidebar white black
2247 The available functions are:
2249 sidebar-scroll-up Scrolls the mailbox list up 1 page
2250 sidebar-scroll-down Scrolls the mailbox list down 1 page
2251 sidebar-next Hilights the next mailbox
2252 sidebar-next-new Hilights the next mailbox with new mail
2253 sidebar-previous Hilights the previous mailbox
2254 sidebar-open Opens the currently hilighted mailbox
2257 Reasonable key bindings look e.g. like this:
2259 bind index \Cp sidebar-prev
2260 bind index \Cn sidebar-next
2261 bind index \Cb sidebar-open
2262 bind pager \Cp sidebar-prev
2263 bind pager \Cn sidebar-next
2264 bind pager \Cb sidebar-open
2266 macro index B ':toggle sidebar_visible^M'
2267 macro pager B ':toggle sidebar_visible^M'
2270 You can then go up and down by pressing Ctrl-P and Ctrl-N, and
2271 switch on and off the sidebar simply by pressing 'B'.
2273 <sect1>External Address Queries<label id="query">
2275 Mutt supports connecting to external directory databases such as LDAP,
2276 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
2277 using a simple interface. Using the <ref id="query_command"
2278 name="$query_command"> variable, you specify the wrapper
2279 command to use. For example:
2282 set query_command = "mutt_ldap_query.pl '%s'"
2285 The wrapper script should accept the query on the command-line. It
2286 should return a one line message, then each matching response on a
2287 single line, each line containing a tab separated address then name then
2288 some other optional information. On error, or if there are no matching
2289 addresses, return a non-zero exit code and a one line error message.
2291 An example multiple response output:
2293 Searching database ... 20 entries ... 3 matching:
2294 me@cs.hmc.edu Michael Elkins mutt dude
2295 blong@fiction.net Brandon Long mutt and more
2296 roessler@guug.de Thomas Roessler mutt pgp
2299 There are two mechanisms for accessing the query function of mutt. One
2300 is to do a query from the index menu using the query function (default: Q).
2301 This will prompt for a query, then bring up the query menu which will
2302 list the matching responses. From the query menu, you can select
2303 addresses to create aliases, or to mail. You can tag multiple addresses
2304 to mail, start a new query, or have a new query appended to the current
2307 The other mechanism for accessing the query function is for address
2308 completion, similar to the alias completion. In any prompt for address
2309 entry, you can use the complete-query function (default: ^T) to run a
2310 query based on the current address you have typed. Like aliases, mutt
2311 will look for what you have typed back to the last space or comma. If
2312 there is a single response for that query, mutt will expand the address
2313 in place. If there are multiple responses, mutt will activate the query
2314 menu. At the query menu, you can select one or more addresses to be
2315 added to the prompt.
2317 <sect1>Mailbox Formats
2319 Mutt supports reading and writing of four different mailbox formats:
2320 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
2321 is no need to use a flag for different mailbox types. When creating new
2322 mailboxes, Mutt uses the default specified with the <ref id="mbox_type"
2323 name="$mbox_type"> variable.
2325 <bf/mbox/. This is the most widely used mailbox format for UNIX. All
2326 messages are stored in a single file. Each message has a line of the form:
2329 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
2332 to denote the start of a new message (this is often referred to as the
2333 ``From_'' line).
2335 <bf/MMDF/. This is a variant of the <em/mbox/ format. Each message is
2336 surrounded by lines containing ``^A^A^A^A'' (four control-A's).
2338 <bf/MH/. A radical departure from <em/mbox/ and <em/MMDF/, a mailbox
2339 consists of a directory and each message is stored in a separate file.
2340 The filename indicates the message number (however, this is may not
2341 correspond to the message number Mutt displays). Deleted messages are
2342 renamed with a comma (,) prepended to the filename. <bf/Note:/ Mutt
2343 detects this type of mailbox by looking for either <tt/.mh_sequences/
2344 or <tt/.xmhcache/ (needed to distinguish normal directories from MH
2347 <bf/Maildir/. The newest of the mailbox formats, used by the Qmail MTA (a
2348 replacement for sendmail). Similar to <em/MH/, except that it adds three
2349 subdirectories of the mailbox: <em/tmp/, <em/new/ and <em/cur/. Filenames
2350 for the messages are chosen in such a way they are unique, even when two
2351 programs are writing the mailbox over NFS, which means that no file locking
2354 <sect1>Mailbox Shortcuts<label id="shortcuts">
2356 There are a number of built in shortcuts which refer to specific mailboxes.
2357 These shortcuts can be used anywhere you are prompted for a file or mailbox
2361 <item>! -- refers to your <ref id="spoolfile" name="$spoolfile"> (incoming) mailbox
2362 <item>> -- refers to your <ref id="mbox" name="$mbox"> file
2363 <item>< -- refers to your <ref id="record" name="$record"> file
2364 <item>- or !! -- refers to the file you've last visited
2365 <item>˜ -- refers to your home directory
2366 <item>= or + -- refers to your <ref id="folder" name="$folder"> directory
2367 <item>@<em/alias/ -- refers to the <ref id="save-hook"
2368 name="default save folder"> as determined by the address of the alias
2371 <sect1>Handling Mailing Lists<label id="using_lists">
2374 Mutt has a few configuration options that make dealing with large
2375 amounts of mail easier. The first thing you must do is to let Mutt
2376 know what addresses you consider to be mailing lists (technically
2377 this does not have to be a mailing list, but that is what it is most
2378 often used for), and what lists you are subscribed to. This is
2379 accomplished through the use of the <ref id="lists"
2380 name="lists and subscribe"> commands in your muttrc.
2382 Now that Mutt knows what your mailing lists are, it can do several
2383 things, the first of which is the ability to show the name of a list
2384 through which you received a message (i.e., of a subscribed list) in
2385 the <em/index/ menu display. This is useful to distinguish between
2386 personal and list mail in the same mailbox. In the <ref id="index_format"
2387 name="$index_format"> variable, the escape ``%L''
2388 will return the string ``To <list>'' when ``list'' appears in the
2389 ``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
2390 field (otherwise it returns the name of the author).
2392 Often times the ``To'' and ``Cc'' fields in mailing list messages
2393 tend to get quite large. Most people do not bother to remove the
2394 author of the message they are reply to from the list, resulting in
2395 two or more copies being sent to that person. The ``list-reply''
2396 function, which by default is bound to ``L'' in the <em/index/ menu
2397 and <em/pager/, helps reduce the clutter by only replying to the
2398 known mailing list addresses instead of all recipients (except as
2399 specified by <tt/Mail-Followup-To/, see below).
2401 Mutt also supports the <tt/Mail-Followup-To/ header. When you send
2402 a message to a list of recipients which includes one or several
2403 subscribed mailing lists, and if the <ref id="followup_to"
2404 name="$followup_to"> option is set, mutt will generate
2405 a Mail-Followup-To header which contains all the recipients to whom
2406 you send this message, but not your address. This indicates that
2407 group-replies or list-replies (also known as ``followups'') to this
2408 message should only be sent to the original recipients of the
2409 message, and not separately to you - you'll receive your copy through
2410 one of the mailing lists you are subscribed to.
2412 Conversely, when group-replying or list-replying to a message which
2413 has a <tt/Mail-Followup-To/ header, mutt will respect this header if
2414 the <ref id="honor_followup_to"
2415 name="$honor_followup_to"> configuration
2416 variable is set. Using list-reply will in this case also make sure
2417 that the reply goes to the mailing list, even if it's not specified
2418 in the list of recipients in the <tt/Mail-Followup-To/.
2420 Note that, when header editing is enabled, you can create a
2421 <tt/Mail-Followup-To/ header manually. Mutt will only auto-generate
2422 this header if it doesn't exist when you send the message.
2425 The other method some mailing list admins use is to generate a
2426 ``Reply-To'' field which points back to the mailing list address rather
2427 than the author of the message. This can create problems when trying
2428 to reply directly to the author in private, since most mail clients
2429 will automatically reply to the address given in the ``Reply-To''
2430 field. Mutt uses the <ref id="reply_to" name="$reply_to">
2431 variable to help decide which address to use. If set to <em/ask-yes/ or
2432 <em/ask-no/, you will be
2433 prompted as to whether or not you would like to use the address given in
2434 the ``Reply-To'' field, or reply directly to the address given in the
2435 ``From'' field. When set to <em/yes/, the ``Reply-To'' field will be used when
2438 The ``X-Label:'' header field can be used to further identify mailing
2439 lists or list subject matter (or just to annotate messages
2440 individually). The <ref id="index_format"
2441 name="$index_format"> variable's ``%y'' and
2442 ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
2443 index, and Mutt's pattern-matcher can match regular expressions to
2444 ``X-Label:'' fields with the ``~y'' selector. ``X-Label:'' is not a
2445 standard message header field, but it can easily be inserted by procmail
2446 and other mail filtering agents.
2448 Lastly, Mutt has the ability to <ref id="sort" name="sort"> the mailbox into
2449 <ref id="threads" name="threads">. A thread is a group of messages which all relate to the same
2450 subject. This is usually organized into a tree-like structure where a
2451 message and all of its replies are represented graphically. If you've ever
2452 used a threaded news client, this is the same concept. It makes dealing
2453 with large volume mailing lists easier because you can easily delete
2454 uninteresting threads and quickly find topics of value.
2456 <sect1>Editing threads
2458 Mutt has the ability to dynamically restructure threads that are broken
2459 either by misconfigured software or bad behaviour from some
2460 correspondents. This allows to clean your mailboxes formats) from these
2461 annoyances which make it hard to follow a discussion.
2463 <sect2>Linking threads
2466 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
2467 "References:" headers when replying to a message. This results in broken
2468 discussions because Mutt has not enough information to guess the correct
2470 You can fix this by tagging the reply, then moving to the parent message
2471 and using the ``link-threads'' function (bound to & by default). The
2472 reply will then be connected to this "parent" message.
2474 You can also connect multiple childs at once, tagging them and using the
2475 tag-prefix command (';') or the auto_tag option.
2477 <sect2>Breaking threads
2480 On mailing lists, some people are in the bad habit of starting a new
2481 discussion by hitting "reply" to any message from the list and changing
2482 the subject to a totally unrelated one.
2483 You can fix such threads by using the ``break-thread'' function (bound
2484 by default to #), which will turn the subthread starting from the
2485 current message into a whole different thread.
2487 <sect1>Delivery Status Notification (DSN) Support
2490 RFC1894 defines a set of MIME content types for relaying information
2491 about the status of electronic mail messages. These can be thought of as
2492 ``return receipts.'' Berkeley sendmail 8.8.x currently has some command
2493 line options in which the mail client can make requests as to what type
2494 of status messages should be returned.
2496 To support this, there are two variables. <ref id="dsn_notify"
2497 name="$dsn_notify"> is used to request receipts for
2498 different results (such as failed message, message delivered, etc.).
2499 <ref id="dsn_return" name="$dsn_return"> requests how much
2500 of your message should be returned with the receipt (headers or full
2501 message). Refer to the man page on sendmail for more details on DSN.
2503 <sect1>POP3 Support (OPTIONAL)
2506 If Mutt was compiled with POP3 support (by running the <em/configure/
2507 script with the <em/--enable-pop/ flag), it has the ability to work
2508 with mailboxes located on a remote POP3 server and fetch mail for local
2511 You can access the remote POP3 mailbox by selecting the folder
2512 <tt>pop://popserver/</tt>.
2514 You can select an alternative port by specifying it with the server, ie:
2515 <tt>pop://popserver:port/</tt>.
2517 You can also specify different username for each folder, ie:
2518 <tt>pop://username@popserver[:port]/</tt>.
2520 Polling for new mail is more expensive over POP3 than locally. For this
2521 reason the frequency at which Mutt will check for mail remotely can be
2523 <ref id="pop_checkinterval" name="$pop_checkinterval">
2524 variable, which defaults to every 60 seconds.
2526 If Mutt was compiled with SSL support (by running the <em/configure/
2527 script with the <em/--with-ssl/ flag), connections to POP3 servers
2528 can be encrypted. This naturally requires that the server supports
2529 SSL encrypted connections. To access a folder with POP3/SSL, you should
2530 use pops: prefix, ie:
2531 <tt>pops://[username@]popserver[:port]/</tt>.
2533 Another way to access your POP3 mail is the <em/fetch-mail/ function
2534 (default: G). It allows to connect to <ref id="pop_host"
2535 name="pop_host">, fetch all your new mail and place it in the
2536 local <ref id="spoolfile" name="spoolfile">. After this
2537 point, Mutt runs exactly as if the mail had always been local.
2539 <bf/Note:/ If you only need to fetch all messages to local mailbox
2540 you should consider using a specialized program, such as <htmlurl
2541 url="http://www.ccil.org/~esr/fetchmail" name="fetchmail">
2543 <sect1>IMAP Support (OPTIONAL)
2546 If Mutt was compiled with IMAP support (by running the <em/configure/
2547 script with the <em/--enable-imap/ flag), it has the ability to work
2548 with folders located on a remote IMAP server.
2550 You can access the remote inbox by selecting the folder
2551 <tt>imap://imapserver/INBOX</tt>, where <tt/imapserver/ is the name of the
2552 IMAP server and <tt/INBOX/ is the special name for your spool mailbox on
2553 the IMAP server. If you want to access another mail folder at the IMAP
2554 server, you should use <tt>imap://imapserver/path/to/folder</tt> where
2555 <tt>path/to/folder</tt> is the path of the folder you want to access.
2557 You can select an alternative port by specifying it with the server, ie:
2558 <tt>imap://imapserver:port/INBOX</tt>.
2560 You can also specify different username for each folder, ie:
2561 <tt>imap://username@imapserver[:port]/INBOX</tt>.
2563 If Mutt was compiled with SSL support (by running the <em/configure/
2564 script with the <em/--with-ssl/ flag), connections to IMAP servers
2565 can be encrypted. This naturally requires that the server supports
2566 SSL encrypted connections. To access a folder with IMAP/SSL, you should
2567 use <tt>imaps://[username@]imapserver[:port]/path/to/folder</tt> as your
2570 Pine-compatible notation is also supported, ie
2571 <tt>{[username@]imapserver[:port][/ssl]}path/to/folder</tt>
2573 Note that not all servers use / as the hierarchy separator. Mutt should
2574 correctly notice which separator is being used by the server and convert
2577 When browsing folders on an IMAP server, you can toggle whether to look
2578 at only the folders you are subscribed to, or all folders with the
2579 <em/toggle-subscribed/ command. See also the
2580 <ref id="imap_list_subscribed"
2581 name="$imap_list_subscribed"> variable.
2583 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
2584 want to carefully tune the
2585 <ref id="imap_mail_check" name="$imap_mail_check">
2587 <ref id="timeout" name="$timeout">
2590 Note that if you are using mbox as the mail store on UW servers prior to
2591 v12.250, the server has been reported to disconnect a client if another client
2592 selects the same folder.
2594 <sect2>The Folder Browser
2597 As of version 1.2, mutt supports browsing mailboxes on an IMAP
2598 server. This is mostly the same as the local file browser, with the
2599 following differences:
2601 <item>Instead of file permissions, mutt displays the string "IMAP",
2602 possibly followed by the symbol "+", indicating
2603 that the entry contains both messages and subfolders. On
2604 Cyrus-like servers folders will often contain both messages and
2606 <item>For the case where an entry can contain both messages and
2607 subfolders, the selection key (bound to <tt>enter</tt> by default)
2608 will choose to descend into the subfolder view. If you wish to view
2609 the messages in that folder, you must use <tt>view-file</tt> instead
2610 (bound to <tt>space</tt> by default).
2611 <item>You can create, delete and rename mailboxes with the
2612 <tt>create-mailbox</tt>, <tt>delete-mailbox</tt>, and
2613 <tt>rename-mailbox</tt> commands (default bindings: <tt>C</tt>,
2614 <tt>d</tt> and <tt>r</tt>, respectively). You may also
2615 <tt>subscribe</tt> and <tt>unsubscribe</tt> to mailboxes (normally
2616 these are bound to <tt>s</tt> and <tt>u</tt>, respectively).
2619 <sect2>Authentication
2622 Mutt supports four authentication methods with IMAP servers: SASL,
2623 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
2624 NTLM authentication for you poor exchange users out there, but it has
2625 yet to be integrated into the main tree). There is also support for
2626 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
2627 IMAP server without having an account. To use ANONYMOUS, simply make
2628 your username blank or "anonymous".
2630 SASL is a special super-authenticator, which selects among several protocols
2631 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
2632 method available on your host and the server. Using some of these methods
2633 (including DIGEST-MD5 and possibly GSSAPI), your entire session will be
2634 encrypted and invisible to those teeming network snoops. It is the best
2635 option if you have it. To use it, you must have the Cyrus SASL library
2636 installed on your system and compile mutt with the <em/--with-sasl/ flag.
2638 Mutt will try whichever methods are compiled in and available on the server,
2639 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
2641 There are a few variables which control authentication:
2643 <item><ref id="imap_user" name="$imap_user"> - controls
2644 the username under which you request authentication on the IMAP server,
2645 for all authenticators. This is overridden by an explicit username in
2646 the mailbox path (ie by using a mailbox name of the form
2648 <item><ref id="imap_pass" name="$imap_pass"> - a
2649 password which you may preset, used by all authentication methods where
2650 a password is needed.
2651 <item><ref id="imap_authenticators"
2652 name="$imap_authenticators"> - a colon-delimited list of IMAP
2653 authentication methods to try, in the order you wish to try them. If
2654 specified, this overrides mutt's default (attempt everything, in the order
2658 <sect1>Managing multiple IMAP/POP accounts (OPTIONAL)<label id="account-hook">
2661 If you happen to have accounts on multiple IMAP and/or POP servers,
2662 you may find managing all the authentication settings inconvenient and
2663 error-prone. The account-hook command may help. This hook works like
2664 folder-hook but is invoked whenever you access a remote mailbox
2665 (including inside the folder browser), not just when you open the
2671 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
2672 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
2673 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
2676 <sect1>Start a WWW Browser on URLs (EXTERNAL)<label id="urlview">
2678 If a message contains URLs (<em/unified resource locator/ = address in the
2679 WWW space like <em>http://www.mutt.org/</em>), it is efficient to get
2680 a menu with all the URLs and start a WWW browser on one of them. This
2681 functionality is provided by the external urlview program which can be
2682 retrieved at <htmlurl url="ftp://ftp.mutt.org/mutt/contrib/"
2683 name="ftp://ftp.mutt.org/mutt/contrib/"> and the configuration commands:
2685 macro index \cb |urlview\n
2686 macro pager \cb |urlview\n
2689 <sect1>Compressed folders Support (OPTIONAL)
2692 If Mutt was compiled with compressed folders support (by running the
2693 <em/configure/ script with the <em/--enable-compressed/ flag), Mutt
2694 can open folders stored in an arbitrary format, provided that the user
2695 has a script to convert from/to this format to one of the accepted.
2697 The most common use is to open compressed archived folders e.g. with
2700 In addition, the user can provide a script that gets a folder in an
2701 accepted format and appends its context to the folder in the
2702 user-defined format, which may be faster than converting the entire
2703 folder to the accepted format, appending to it and converting back to
2704 the user-defined format.
2706 There are three hooks defined (<ref id="open-hook" name="open-hook">,
2707 <ref id="close-hook" name="close-hook"> and <ref id="append-hook"
2708 name="append-hook">) which define commands to uncompress and compress
2709 a folder and to append messages to an existing compressed folder
2715 open-hook \\.gz$ "gzip -cd %f > %t"
2716 close-hook \\.gz$ "gzip -c %t > %f"
2717 append-hook \\.gz$ "gzip -c %t >> %f"
2720 You do not have to specify all of the commands. If you omit <ref
2721 id="append-hook" name="append-hook">, the folder will be open and
2722 closed again each time you will add to it. If you omit <ref
2723 id="close-hook" name="close-hook"> (or give empty command) , the
2724 folder will be open in the mode. If you specify <ref
2725 id="append-hook" name="append-hook"> though you'll be able to append
2728 Note that Mutt will only try to use hooks if the file is not in one of
2729 the accepted formats. In particular, if the file is empty, mutt
2730 supposes it is not compressed. This is important because it allows the
2731 use of programs that do not have well defined extensions. Just use
2732 &dquot;.&dquot; as a regexp. But this may be surprising if your
2733 compressing script produces empty files. In this situation, unset <ref
2734 id="save_empty" name="$save_empty">, so that the compressed file
2735 will be removed if you delete all of the messages.
2737 <sect2>Open a compressed mailbox for reading<label id="open-hook">
2739 Usage: <tt/open-hook/ <em/regexp/ &dquot;<em/command/&dquot;
2741 The <em/command/ is the command that can be used for opening the
2742 folders whose names match <em/regexp/.
2744 The <em/command/ string is the printf-like format string, and it
2745 should accept two parameters: %f, which is replaced with the
2746 (compressed) folder name, and %t which is replaced with the
2747 name of the temporary folder to which to write.
2749 %f and %t can be repeated any number of times in the
2750 command string, and all of the entries are replaced with the
2751 appropriate folder name. In addition, %% is replaced by
2752 %, as in printf, and any other %anything is left as is.
2754 The <em/command/ should <bf/not/ remove the original compressed file.
2755 The <em/command/ should return non-zero exit status if it fails, so
2756 mutt knows something's wrong.
2761 open-hook \\.gz$ "gzip -cd %f > %t"
2764 If the <em/command/ is empty, this operation is disabled for this file
2767 <sect2>Write a compressed mailbox<label id="close-hook">
2769 Usage: <tt/close-hook/ <em/regexp/ &dquot;<em/command/&dquot;
2771 This is used to close the folder that was open with the <ref id="open-hook"
2772 name="open-hook"> command after some changes were made to it.
2774 The <em/command/ string is the command that can be used for closing the
2775 folders whose names match <em/regexp/. It has the same format as in
2776 the <ref id="open-hook" name="open-hook"> command. Temporary folder
2777 in this case is the folder previously produced by the <<ref id="open-hook"
2778 name="open-hook"> command.
2780 The <em/command/ should <bf/not/ remove the decompressed file. The
2781 <em/command/ should return non-zero exit status if it fails, so mutt
2782 knows something's wrong.
2787 close-hook \\.gz$ "gzip -c %t > %f"
2790 If the <em/command/ is empty, this operation is disabled for this file
2791 type, and the file can only be open in the readonly mode.
2793 <ref id="close-hook" name ="close-hook"> is not called when you exit
2794 from the folder if the folder was not changed.
2796 <sect2>Append a message to a compressed mailbox<label id="append-hook">
2798 Usage: <tt/append-hook/ <em/regexp/ &dquot;<em/command/&dquot;
2800 This command is used for saving to an existing compressed folder.
2801 The <em/command/ is the command that can be used for appending to the
2802 folders whose names match <em/regexp/. It has the same format as in
2803 the <ref id="open-hook" name="open-hook"> command.
2804 The temporary folder in this case contains the messages that are being
2807 The <em/command/ should <bf/not/ remove the decompressed file. The
2808 <em/command/ should return non-zero exit status if it fails, so mutt
2809 knows something's wrong.
2814 append-hook \\.gz$ "gzip -c %t >> %f"
2817 When <ref id="append-hook" name="append-hook"> is used, the folder is
2818 not opened, which saves time, but this means that we can not find out
2819 what the folder type is. Thus the default (<ref id="mbox_type"
2820 name="$mbox_type">) type is always supposed (i.e.
2821 this is the format used for the temporary folder).
2823 If the file does not exist when you save to it, <ref id="close-hook"
2824 name="close-hook"> is called, and not <ref id="append-hook"
2825 name="append-hook">. <ref id="append-hook" name="append-hook"> is only
2826 for appending to existing folders.
2828 If the <em/command/ is empty, this operation is disabled for this file
2829 type. In this case, the folder will be open and closed again (using
2830 <ref id="open-hook" name="open-hook"> and <ref id="close-hook"
2831 name="close-hook">respectively) each time you will add to it.
2833 <sect2>Encrypted folders
2835 The compressed folders support can also be used to handle encrypted
2836 folders. If you want to encrypt a folder with PGP, you may want to use
2837 the following hooks:
2840 open-hook \\.pgp$ "pgp -f < %f > %t"
2841 close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
2844 Please note, that PGP does not support appending to an encrypted
2845 folder, so there is no append-hook defined.
2847 <bf/Note:/ the folder is temporary stored decrypted in the /tmp
2848 directory, where it can be read by your system administrator. So think
2849 about the security aspects of this.
2851 <sect>Mutt's MIME Support
2853 Quite a bit of effort has been made to make Mutt the premier text-mode
2854 MIME MUA. Every effort has been made to provide the functionality that
2855 the discerning MIME user requires, and the conformance to the standards
2856 wherever possible. When configuring Mutt for MIME, there are two extra
2857 types of configuration files which Mutt uses. One is the
2858 <tt/mime.types/ file, which contains the mapping of file extensions to
2859 IANA MIME types. The other is the <tt/mailcap/ file, which specifies
2860 the external commands to use for handling specific MIME types.
2862 <sect1>Using MIME in Mutt
2864 There are three areas/menus in Mutt which deal with MIME, they are the
2865 pager (while viewing a message), the attachment menu and the compose
2868 <sect2>Viewing MIME messages in the pager
2870 When you select a message from the index and view it in the pager, Mutt
2871 decodes the message to a text representation. Mutt internally supports
2872 a number of MIME types, including <tt>text/plain, text/enriched,
2873 message/rfc822, and message/news</tt>. In addition, the export
2874 controlled version of Mutt recognizes a variety of PGP MIME types,
2875 including PGP/MIME and application/pgp.
2877 Mutt will denote attachments with a couple lines describing them.
2878 These lines are of the form:
2880 [-- Attachment #1: Description --]
2881 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
2883 Where the <tt/Description/ is the description or filename given for the
2884 attachment, and the <tt/Encoding/ is one of
2885 <tt>7bit/8bit/quoted-printable/base64/binary</tt>.
2887 If Mutt cannot deal with a MIME type, it will display a message like:
2889 [-- image/gif is unsupported (use 'v' to view this part) --]
2892 <sect2>The Attachment Menu<label id="attach_menu">
2894 The default binding for <tt/view-attachments/ is `v', which displays the
2895 attachment menu for a message. The attachment menu displays a list of
2896 the attachments in a message. From the attachment menu, you can save,
2897 print, pipe, delete, and view attachments. You can apply these
2898 operations to a group of attachments at once, by tagging the attachments
2899 and by using the ``tag-prefix'' operator. You can also reply to the
2900 current message from this menu, and only the current attachment (or the
2901 attachments tagged) will be quoted in your reply. You can view
2902 attachments as text, or view them using the mailcap viewer definition.
2904 Finally, you can apply the usual message-related functions (like
2905 <ref id="resend-message" name="resend-message">, and the reply
2906 and forward functions) to attachments of type <tt>message/rfc822</tt>.
2908 See the help on the attachment menu for more information.
2910 <sect2>The Compose Menu<label id="compose_menu">
2912 The compose menu is the menu you see before you send a message. It
2913 allows you to edit the recipient list, the subject, and other aspects
2914 of your message. It also contains a list of the attachments of your
2915 message, including the main body. From this menu, you can print, copy,
2916 filter, pipe, edit, compose, review, and rename an attachment or a
2917 list of tagged attachments. You can also modifying the attachment
2918 information, notably the type, encoding and description.
2920 Attachments appear as follows:
2922 - 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
2923 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
2926 The '-' denotes that Mutt will delete the file after sending (or
2927 postponing, or cancelling) the message. It can be toggled with the
2928 <tt/toggle-unlink/ command (default: u). The next field is the MIME
2929 content-type, and can be changed with the <tt/edit-type/ command
2930 (default: ^T). The next field is the encoding for the attachment,
2931 which allows a binary message to be encoded for transmission on 7bit
2932 links. It can be changed with the <tt/edit-encoding/ command
2933 (default: ^E). The next field is the size of the attachment,
2934 rounded to kilobytes or megabytes. The next field is the filename,
2935 which can be changed with the <tt/rename-file/ command (default: R).
2936 The final field is the description of the attachment, and can be
2937 changed with the <tt/edit-description/ command (default: d).
2939 <sect1>MIME Type configuration with <tt/mime.types/
2941 When you add an attachment to your mail message, Mutt searches your
2942 personal mime.types file at <tt>${HOME}/.mime.types</tt>, and then
2943 the system mime.types file at <tt>/usr/local/share/mutt/mime.types</tt> or
2944 <tt>/etc/mime.types</tt>
2946 The mime.types file consist of lines containing a MIME type and a space
2947 separated list of extensions. For example:
2949 application/postscript ps eps
2951 audio/x-aiff aif aifc aiff
2953 A sample <tt/mime.types/ file comes with the Mutt distribution, and
2954 should contain most of the MIME types you are likely to use.
2956 If Mutt can not determine the mime type by the extension of the file you
2957 attach, it will look at the file. If the file is free of binary
2958 information, Mutt will assume that the file is plain text, and mark it
2959 as <tt>text/plain</tt>. If the file contains binary information, then Mutt will
2960 mark it as <tt>application/octet-stream</tt>. You can change the MIME
2961 type that Mutt assigns to an attachment by using the <tt/edit-type/
2962 command from the compose menu (default: ^T). The MIME type is actually a
2963 major mime type followed by the sub-type, separated by a '/'. 6 major
2964 types: application, text, image, video, audio, and model have been approved
2965 after various internet discussions. Mutt recognises all of these if the
2966 appropriate entry is found in the mime.types file. It also recognises other
2967 major mime types, such as the chemical type that is widely used in the
2968 molecular modelling community to pass molecular data in various forms to
2969 various molecular viewers. Non-recognised mime types should only be used
2970 if the recipient of the message is likely to be expecting such attachments.
2972 <sect1>MIME Viewer configuration with <tt/mailcap/
2974 Mutt supports RFC 1524 MIME Configuration, in particular the Unix
2975 specific format specified in Appendix A of RFC 1524. This file format
2976 is commonly referred to as the mailcap format. Many MIME compliant
2977 programs utilize the mailcap format, allowing you to specify handling
2978 for all MIME types in one place for all programs. Programs known to
2979 use this format include Netscape, XMosaic, lynx and metamail.
2981 In order to handle various MIME types that Mutt can not handle
2982 internally, Mutt parses a series of external configuration files to
2983 find an external handler. The default search string for these files
2984 is a colon delimited list set to
2986 ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
2988 where <tt/$HOME/ is your home directory.
2990 In particular, the metamail distribution will install a mailcap file,
2991 usually as <tt>/usr/local/etc/mailcap</tt>, which contains some baseline
2994 <sect2>The Basics of the mailcap file
2996 A mailcap file consists of a series of lines which are comments, blank,
2999 A comment line consists of a # character followed by anything you want.
3001 A blank line is blank.
3003 A definition line consists of a content type, a view command, and any
3004 number of optional fields. Each field of a definition line is divided
3005 by a semicolon ';' character.
3007 The content type is specified in the MIME standard type/subtype method.
3009 <tt>text/plain, text/html, image/gif, </tt>
3010 etc. In addition, the mailcap format includes two formats for
3011 wildcards, one using the special '*' subtype, the other is the implicit
3012 wild, where you only include the major type. For example, <tt>image/*</tt>, or
3013 <tt>video,</tt> will match all image types and video types,
3016 The view command is a Unix command for viewing the type specified. There
3017 are two different types of commands supported. The default is to send
3018 the body of the MIME message to the command on stdin. You can change
3019 this behaviour by using %s as a parameter to your view command.
3020 This will cause Mutt to save the body of the MIME message to a temporary
3021 file, and then call the view command with the %s replaced by
3022 the name of the temporary file. In both cases, Mutt will turn over the
3023 terminal to the view program until the program quits, at which time Mutt
3024 will remove the temporary file if it exists.
3026 So, in the simplest form, you can send a text/plain message to the
3027 external pager more on stdin:
3031 Or, you could send the message as a file:
3035 Perhaps you would like to use lynx to interactively view a text/html
3040 In this case, lynx does not support viewing a file from stdin, so you
3041 must use the %s syntax.
3042 <bf/Note:/ <em>Some older versions of lynx contain a bug where they
3043 will check the mailcap file for a viewer for text/html. They will find
3044 the line which calls lynx, and run it. This causes lynx to continuously
3045 spawn itself to view the object.</em>
3047 On the other hand, maybe you don't want to use lynx interactively, you
3048 just want to have it convert the text/html to text/plain, then you can
3051 text/html; lynx -dump %s | more
3054 Perhaps you wish to use lynx to view text/html files, and a pager on
3055 all other text formats, then you would use the following:
3060 This is the simplest form of a mailcap file.
3062 <sect2>Secure use of mailcap
3064 The interpretion of shell meta-characters embedded in MIME parameters
3065 can lead to security problems in general. Mutt tries to quote parameters
3066 in expansion of %s syntaxes properly, and avoids risky characters by
3067 substituting them, see the <ref id="mailcap_sanitize"
3068 name="mailcap_sanitize"> variable.
3070 Although mutt's procedures to invoke programs with mailcap seem to be
3071 safe, there are other applications parsing mailcap, maybe taking less care
3072 of it. Therefore you should pay attention to the following rules:
3074 <em/Keep the %-expandos away from shell quoting./
3075 Don't quote them with single or double quotes. Mutt does this for
3076 you, the right way, as should any other program which interprets
3077 mailcap. Don't put them into backtick expansions. Be highly careful
3078 with eval statements, and avoid them if possible at all. Trying to fix
3079 broken behaviour with quotes introduces new leaks - there is no
3080 alternative to correct quoting in the first place.
3082 If you have to use the %-expandos' values in context where you need
3083 quoting or backtick expansions, put that value into a shell variable
3084 and reference the shell variable where necessary, as in the following
3085 example (using <tt/$charset/ inside the backtick expansion is safe,
3086 since it is not itself subject to any further expansion):
3089 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
3090 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
3093 <sect2>Advanced mailcap Usage
3096 <sect3>Optional Fields
3098 In addition to the required content-type and view command fields, you
3099 can add semi-colon ';' separated fields to set flags and other options.
3100 Mutt recognizes the following optional fields:
3103 This flag tells Mutt that the command passes possibly large amounts of
3104 text on stdout. This causes Mutt to invoke a pager (either the internal
3105 pager or the external pager defined by the pager variable) on the output
3106 of the view command. Without this flag, Mutt assumes that the command
3107 is interactive. One could use this to replace the pipe to <tt>more</tt>
3108 in the <tt>lynx -dump</tt> example in the Basic section:
3110 text/html; lynx -dump %s ; copiousoutput
3112 This will cause lynx to format the text/html output as text/plain
3113 and Mutt will use your standard pager to display the results.
3115 Mutt uses this flag when viewing attachments with <ref id="auto_view"
3116 name="autoview">, in order to decide whether it should honor the setting
3117 of the <ref id="wait_key" name="$wait_key"> variable or
3118 not. When an attachment is viewed using an interactive program, and the
3119 corresponding mailcap entry has a <em/needsterminal/ flag, Mutt will use
3120 <ref id="wait_key" name="$wait_key"> and the exit status
3121 of the program to decide if it will ask you to press a key after the
3122 external program has exited. In all other situations it will not prompt
3124 <tag>compose=<command></tag>
3125 This flag specifies the command to use to create a new attachment of a
3126 specific MIME type. Mutt supports this from the compose menu.
3127 <tag>composetyped=<command></tag>
3128 This flag specifies the command to use to create a new attachment of a
3129 specific MIME type. This command differs from the compose command in
3130 that mutt will expect standard MIME headers on the data. This can be
3131 used to specify parameters, filename, description, etc. for a new
3132 attachment. Mutt supports this from the compose menu.
3133 <tag>print=<command></tag>
3134 This flag specifies the command to use to print a specific MIME type.
3135 Mutt supports this from the attachment and compose menus.
3136 <tag>edit=<command></tag>
3137 This flag specifies the command to use to edit a specific MIME type.
3138 Mutt supports this from the compose menu, and also uses it to compose
3139 new attachments. Mutt will default to the defined editor for text
3141 <tag>nametemplate=<template></tag>
3142 This field specifies the format for the file denoted by %s in the
3143 command fields. Certain programs will require a certain file extension,
3144 for instance, to correctly view a file. For instance, lynx will only
3145 interpret a file as <tt>text/html</tt> if the file ends in <tt/.html/.
3146 So, you would specify lynx as a <tt>text/html</tt> viewer with a line in
3147 the mailcap file like:
3149 text/html; lynx %s; nametemplate=%s.html
3151 <tag>test=<command></tag>
3152 This field specifies a command to run to test whether this mailcap
3153 entry should be used. The command is defined with the command expansion
3154 rules defined in the next section. If the command returns 0, then the
3155 test passed, and Mutt uses this entry. If the command returns non-zero,
3156 then the test failed, and Mutt continues searching for the right entry.
3157 <bf/Note:/ <em>the content-type must match before Mutt performs the test.</em>
3160 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
3163 In this example, Mutt will run the program RunningX which will return 0
3164 if the X Window manager is running, and non-zero if it isn't. If
3165 RunningX returns 0, then Mutt will call netscape to display the
3166 text/html object. If RunningX doesn't return 0, then Mutt will go on
3167 to the next entry and use lynx to display the text/html object.
3172 When searching for an entry in the mailcap file, Mutt will search for
3173 the most useful entry for its purpose. For instance, if you are
3174 attempting to print an <tt>image/gif</tt>, and you have the following
3175 entries in your mailcap file, Mutt will search for an entry with the
3179 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
3182 Mutt will skip the <tt>image/*</tt> entry and use the <tt>image/gif</tt>
3183 entry with the print command.
3185 In addition, you can use this with <ref id="auto_view" name="Autoview">
3186 to denote two commands for viewing an attachment, one to be viewed
3187 automatically, the other to be viewed interactively from the attachment
3188 menu. In addition, you can then use the test feature to determine which
3189 viewer to use interactively depending on your environment.
3191 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
3192 text/html; lynx %s; nametemplate=%s.html
3193 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
3195 For <ref id="auto_view" name="Autoview">, Mutt will choose the third
3196 entry because of the copiousoutput tag. For interactive viewing, Mutt
3197 will run the program RunningX to determine if it should use the first
3198 entry. If the program returns non-zero, Mutt will use the second entry
3199 for interactive viewing.
3201 <sect3>Command Expansion
3203 The various commands defined in the mailcap files are passed to the
3204 <tt>/bin/sh</tt> shell using the system() function. Before the
3205 command is passed to <tt>/bin/sh -c</tt>, it is parsed to expand
3206 various special parameters with information from Mutt. The keywords
3210 As seen in the basic mailcap section, this variable is expanded
3211 to a filename specified by the calling program. This file contains
3212 the body of the message to view/print/edit or where the composing
3213 program should place the results of composition. In addition, the
3214 use of this keyword causes Mutt to not pass the body of the message
3215 to the view/print/edit program on stdin.
3217 Mutt will expand %t to the text representation of the content
3218 type of the message in the same form as the first parameter of the
3219 mailcap definition line, ie <tt>text/html</tt> or
3221 <tag>%{<parameter>}</tag>
3222 Mutt will expand this to the value of the specified parameter
3223 from the Content-Type: line of the mail message. For instance, if
3224 Your mail message contains:
3226 Content-Type: text/plain; charset=iso-8859-1
3228 then Mutt will expand %{charset} to iso-8859-1. The default metamail
3229 mailcap file uses this feature to test the charset to spawn an xterm
3230 using the right charset to view the message.
3231 <tag>\%</tag>
3232 This will be replaced by a %
3234 Mutt does not currently support the %F and %n keywords
3235 specified in RFC 1524. The main purpose of these parameters is for
3236 multipart messages, which is handled internally by Mutt.
3238 <sect2>Example mailcap files
3240 This mailcap file is fairly simple and standard:
3242 # I'm always running X :)
3243 video/*; xanim %s > /dev/null
3244 image/*; xv %s > /dev/null
3246 # I'm always running netscape (if my computer had more memory, maybe)
3247 text/html; netscape -remote 'openURL(%s)'
3250 This mailcap file shows quite a number of examples:
3253 # Use xanim to view all videos Xanim produces a header on startup,
3254 # send that to /dev/null so I don't see it
3255 video/*; xanim %s > /dev/null
3257 # Send html to a running netscape by remote
3258 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
3260 # If I'm not running netscape but I am running X, start netscape on the
3262 text/html; netscape %s; test=RunningX
3264 # Else use lynx to view it as text
3267 # This version would convert the text/html to text/plain
3268 text/html; lynx -dump %s; copiousoutput
3270 # I use enscript to print text in two columns to a page
3271 text/*; more %s; print=enscript -2Gr %s
3273 # Netscape adds a flag to tell itself to view jpegs internally
3274 image/jpeg;xv %s; x-mozilla-flags=internal
3276 # Use xv to view images if I'm running X
3277 # In addition, this uses the \ to extend the line and set my editor
3279 image/*;xv %s; test=RunningX; \
3282 # Convert images to text using the netpbm tools
3283 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
3284 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
3286 # Send excel spreadsheets to my NT box
3287 application/ms-excel; open.pl %s
3290 <sect1>MIME Autoview<label id="auto_view">
3292 In addition to explicitly telling Mutt to view an attachment with the
3293 MIME viewer defined in the mailcap file, Mutt has support for
3294 automatically viewing MIME attachments while in the pager.
3296 To work, you must define a viewer in the mailcap file which uses the
3297 <tt/copiousoutput/ option to denote that it is non-interactive.
3298 Usually, you also use the entry to convert the attachment to a text
3299 representation which you can view in the pager.
3301 You then use the <tt/auto_view/ muttrc command to list the
3302 content-types that you wish to view automatically.
3304 For instance, if you set auto_view to:
3306 auto_view text/html application/x-gunzip application/postscript image/gif application/x-tar-gz
3309 Mutt could use the following mailcap entries to automatically view
3310 attachments of these types.
3312 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
3313 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
3314 application/x-gunzip; gzcat; copiousoutput
3315 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
3316 application/postscript; ps2ascii %s; copiousoutput
3319 ``unauto_view'' can be used to remove previous entries from the autoview list.
3320 This can be used with message-hook to autoview messages based on size, etc.
3321 ``unauto_view *'' will remove all previous entries.
3323 <sect1>MIME Multipart/Alternative<label id="alternative_order">
3325 Mutt has some heuristics for determining which attachment of a
3326 multipart/alternative type to display. First, mutt will check the
3327 alternative_order list to determine if one of the available types
3328 is preferred. The alternative_order list consists of a number of
3329 mimetypes in order, including support for implicit and explicit
3330 wildcards, for example:
3332 alternative_order text/enriched text/plain text application/postscript image/*
3335 Next, mutt will check if any of the types have a defined
3336 <ref id="auto_view" name="auto_view">, and use that. Failing
3337 that, Mutt will look for any text type. As a last attempt, mutt will
3338 look for any type it knows how to handle.
3340 To remove a MIME type from the <tt/alternative_order/ list, use the
3341 <tt/unalternative_order/ command.
3343 <sect1>MIME Lookup<label id="mime_lookup">
3345 Mutt's mime_lookup list specifies a list of mime-types that should not
3346 be treated according to their mailcap entry. This option is designed to
3347 deal with binary types such as application/octet-stream. When an attachment's
3348 mime-type is listed in mime_lookup, then the extension of the filename will
3349 be compared to the list of extensions in the mime.types file. The mime-type
3350 associated with this extension will then be used to process the attachment
3351 according to the rules in the mailcap file and according to any other configuration
3352 options (such as auto_view) specified. Common usage would be:
3354 mime_lookup application/octet-stream application/X-Lotus-Manuscript
3357 In addition, the unmime_lookup command may be used to disable this feature
3358 for any particular mime-type if it had been set, for example, in a global
3362 <sect1>Command line options<label id="commandline">
3364 Running <tt/mutt/ with no arguments will make Mutt attempt to read your spool
3365 mailbox. However, it is possible to read other mailboxes and
3366 to send messages from the command line as well.
3370 -a attach a file to a message
3371 -b specify a blind carbon-copy (BCC) address
3372 -c specify a carbon-copy (Cc) address
3373 -e specify a config command to be run after initilization files are read
3374 -f specify a mailbox to load
3375 -F specify an alternate file to read initialization commands
3376 -h print help on command line options
3377 -H specify a draft file from which to read a header and body
3378 -i specify a file to include in a message composition
3379 -m specify a default mailbox type
3380 -n do not read the system Muttrc
3381 -p recall a postponed message
3382 -Q query a configuration variable
3383 -R open mailbox in read-only mode
3384 -s specify a subject (enclose in quotes if it contains spaces)
3385 -v show version number and compile-time definitions
3386 -x simulate the mailx(1) compose mode
3387 -y show a menu containing the files specified by the mailboxes command
3388 -z exit immediately if there are no messages in the mailbox
3389 -Z open the first folder with new message,exit immediately if none
3392 To read messages in a mailbox
3394 <tt/mutt/ [ -nz ] [ -F <em/muttrc/ ] [ -m <em/type/ ] [ -f <em/mailbox/ ]
3396 To compose a new message
3398 <tt/mutt/ [ -n ] [ -F <em/muttrc/ ] [ -a <em/file/ ] [ -c <em/address/ ] [ -i <em/filename/ ] [ -s <em/subject/ ] <em/address/ [ <em/address/ ... ]
3400 Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect
3401 input from the file you wish to send. For example,
3403 <tt>mutt -s &dquot;data set for run #2&dquot; professor@bigschool.edu
3404 < ˜/run2.dat</tt>
3406 This command will send a message to ``professor@bigschool.edu'' with a subject
3407 of ``data set for run #2''. In the body of the message will be the contents
3408 of the file ``˜/run2.dat''.
3410 <sect1>Configuration Commands<label id="commands">
3412 The following are the commands understood by mutt.
3416 <tt><ref id="account-hook" name="account-hook"></tt> <em/pattern/ <em/command/
3418 <tt><ref id="alias" name="alias"></tt> <em/key/ <em/address/ [ , <em/address/, ... ]
3420 <tt><ref id="alias" name="unalias"></tt> [ * | <em/key/ ... ]
3422 <tt><ref id="alternates" name="alternates"></tt> <em/regexp/ [ <em/regexp/ ... ]
3424 <tt><ref id="alternates" name="unalternates"></tt> [ * | <em/regexp/ ... ]
3426 <tt><ref id="alternative_order" name="alternative_order"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
3428 <tt><ref id="alternative_order" name="unalternative_order"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
3430 <tt><ref id="append-hook" name="append-hook"></tt> <em/regexp/ <em/command/
3432 <tt><ref id="auto_view" name="auto_view"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
3434 <tt><ref id="auto_view" name="unauto_view"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
3436 <tt><ref id="bind" name="bind"></tt> <em/map/ <em/key/ <em/function/
3438 <tt><ref id="charset-hook" name="charset-hook"></tt> <em/alias/ <em/charset/
3440 <tt><ref id="close-hook" name="close-hook"></tt> <em/regexp/ <em/command/
3442 <tt><ref id="color" name="color"></tt> <em/object/ <em/foreground/ <em/background/ [ <em/regexp/ ]
3444 <tt><ref id="color" name="uncolor"></tt> <em/index/ <em/pattern/ [ <em/pattern/ ... ]
3446 <tt><ref id="exec" name="exec"></tt> <em/function/ [ <em/function/ ... ]
3448 <tt><ref id="fcc-hook" name="fcc-hook"></tt> <em/pattern/ <em/mailbox/
3450 <tt><ref id="fcc-save-hook" name="fcc-save-hook"></tt> <em/pattern/ <em/mailbox/
3452 <tt><ref id="folder-hook" name="folder-hook"></tt> <em/pattern/ <em/command/
3454 <tt><ref id="hdr_order" name="hdr_order"></tt> <em/header/ [ <em/header/ ... ]
3456 <tt><ref id="hdr_order" name="unhdr_order"></tt> <em/header/ [ <em/header/ ... ]
3458 <tt><ref id="charset-hook" name="iconv-hook"></tt> <em/charset/ <em/local-charset/
3460 <tt><ref id="ignore" name="ignore"></tt> <em/pattern/ [ <em/pattern/ ... ]
3462 <tt><ref id="ignore" name="unignore"></tt> <em/pattern/ [ <em/pattern/ ... ]
3464 <tt><ref id="lists" name="lists"></tt> <em/regexp/ [ <em/regexp/ ... ]
3466 <tt><ref id="lists" name="unlists"></tt> <em/regexp/ [ <em/regexp/ ... ]
3468 <tt><ref id="macro" name="macro"></tt> <em/menu/ <em/key/ <em/sequence/ [ <em/description/ ]
3470 <tt><ref id="mailboxes" name="mailboxes"></tt> <em/filename/ [ <em/filename/ ... ]
3472 <tt><ref id="mbox-hook" name="mbox-hook"></tt> <em/pattern/ <em/mailbox/
3474 <tt><ref id="message-hook" name="message-hook"></tt> <em/pattern/ <em/command/
3476 <tt><ref id="mime_lookup" name="mime_lookup"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
3478 <tt><ref id="mime_lookup" name="unmime_lookup"></tt> <em/mimetype/ [ <em/mimetype/ ... ]
3480 <tt><ref id="color" name="mono"></tt> <em/object attribute/ [ <em/regexp/ ]
3482 <tt><ref id="color" name="unmono"></tt> <em/index/ <em/pattern/ [ <em/pattern/ ... ]
3484 <tt><ref id="my_hdr" name="my_hdr"></tt> <em/string/
3486 <tt><ref id="my_hdr" name="unmy_hdr"></tt> <em/field/ [ <em/field/ ... ]
3488 <tt><ref id="open-hook" name="open-hook"></tt> <em/regexp/ <em/command/
3490 <tt><ref id="crypt-hook" name="crypt-hook"></tt> <em/pattern/ <em/key-id/
3492 <tt><ref id="push" name="push"></tt> <em/string/
3494 <tt><ref id="set" name="reset"></tt> <em/variable/ [<em/variable/ ... ]
3496 <tt><ref id="save-hook" name="save-hook"></tt> <em/regexp/ <em/filename/
3498 <tt><ref id="score-command" name="score"></tt> <em/pattern/ <em/value/
3500 <tt><ref id="score-command" name="unscore"></tt> <em/pattern/ [ <em/pattern/ ... ]
3502 <tt><ref id="send-hook" name="send-hook"></tt> <em/regexp/ <em/command/
3504 <tt><ref id="reply-hook" name="reply-hook"></tt> <em/regexp/ <em/command/
3506 <tt><ref id="set" name="set"></tt> [no|inv]<em/variable/[=<em/value/] [ <em/variable/ ... ]
3508 <tt><ref id="set" name="unset"></tt> <em/variable/ [<em/variable/ ... ]
3510 <tt><ref id="source" name="source"></tt> <em/filename/
3512 <tt><ref id="spam" name="spam"></tt> <em/pattern/ <em/format/
3514 <tt><ref id="spam" name="nospam"></tt> <em/pattern/
3516 <tt><ref id="lists" name="subscribe"></tt> <em/regexp/ [ <em/regexp/ ... ]
3518 <tt><ref id="lists" name="unsubscribe"></tt> <em/regexp/ [ <em/regexp/ ... ]
3520 <tt><ref id="set" name="toggle"></tt> <em/variable/ [<em/variable/ ... ]
3522 <tt><ref id="unhook" name="unhook"></tt> <em/hook-type/
3525 <sect1>Configuration variables<label id="variables">