1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
8 <title>The Mutt Next Generation E-Mail Client</title>
10 <firstname>Andreas</firstname><surname>Krennmair</surname>
11 <email>ak@synflood.at</email>
14 <firstname>Michael</firstname><surname>Elkins</surname>
15 <email>me@cs.hmc.edu</email>
17 <pubdate>version devel-r473</pubdate>
20 Michael Elinks on mutt, circa 1995:
21 ``All mail clients suck. This one just sucks less.''
24 Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
27 </bookinfo> <!--}}}-->
29 <chapter id="introduction"> <!--{{{-->
30 <title>Introduction</title>
33 <title>Overview</title>
36 <emphasis role="bold">Mutt-ng</emphasis> is a small but very
37 powerful text-based MIME mail client. Mutt-ng is highly
38 configurable, and is well suited to the mail power user with
39 advanced features like key bindings, keyboard macros, mail
40 threading, regular expression searches and a powerful pattern
41 matching language for selecting groups of messages.
45 This documentation additionally contains documentation to
46 <emphasis role="bold"> Mutt-NG </emphasis> ,a fork from Mutt
47 with the goal to fix all the little annoyances of Mutt, to
48 integrate all the Mutt patches that are floating around in the
49 web, and to add other new features. Features specific to Mutt-ng
50 will be discussed in an extra section. Don't be confused when
51 most of the documentation talk about Mutt and not Mutt-ng,
52 Mutt-ng contains all Mutt features, plus many more.
62 <title>Mutt-ng Home Page</title>
65 <ulink url="http://www.muttng.org/">http://www.muttng.org</ulink>
74 <sect1 id="mailinglists">
75 <title>Mailing Lists</title>
83 <email>mutt-ng-users@lists.berlios.de</email>: This is
84 where the mutt-ng user support happens.
90 <email>mutt-ng-devel@lists.berlios.de</email>: The
91 development mailing list for mutt-ng
105 <sect1 id="distrib-sites">
106 <title>Software Distribution Sites</title>
109 So far, there are no official releases of Mutt-ng, but you can
110 download daily snapshots from <ulink
111 url="http://mutt-ng.berlios.de/snapshots/"
112 >http://mutt-ng.berlios.de/snapshots/</ulink>
125 Visit channel <emphasis>#muttng</emphasis> on <ulink
126 url="http://www.freenode.net/">irc.freenode.net
127 (www.freenode.net) </ulink> to chat with other people
128 interested in Mutt-ng.
134 <title>Weblog</title>
137 If you want to read fresh news about the latest development in
138 Mutt-ng, and get informed about stuff like interesting,
139 Mutt-ng-related articles and packages for your favorite
140 distribution, you can read and/or subscribe to our <ulink
141 url="http://mutt-ng.supersized.org/">Mutt-ng development
147 <sect1 id="copyright">
148 <title>Copyright</title>
151 Mutt is Copyright (C) 1996-2000 Michael R. Elkins
152 <me@cs.hmc.edu> and others
156 This program is free software; you can redistribute it and/or modify
157 it under the terms of the GNU General Public License as published by
158 the Free Software Foundation; either version 2 of the License, or
159 (at your option) any later version.
163 This program is distributed in the hope that it will be useful,
164 but WITHOUT ANY WARRANTY; without even the implied warranty of
165 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
166 GNU General Public License for more details.
170 You should have received a copy of the GNU General Public License
171 along with this program; if not, write to the Free Software
172 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
180 <chapter id="getting-started"> <!--{{{-->
181 <title>Getting Started</title>
183 <sect1 id="basic-concepts"> <!--{{{-->
184 <title>Basic Concepts</title>
186 <sect2 id="concept-screens-and-menus"> <!--{{{-->
187 <title>Screens and Menus</title>
190 mutt-ng offers different screens of which every has its special
200 The <emphasis>index</emphasis> displays the contents of the
209 The <emphasis>pager</emphasis> is responsible for displaying
211 is, the header, the body and all attached parts.
218 The <emphasis>file browser</emphasis> offers operations on and
220 information of all folders mutt-ng should watch for mail.
227 The <emphasis>sidebar</emphasis> offers a permanent view of
229 contain how many total, new and/or flagged mails.
236 The <emphasis>help screen</emphasis> lists for all currently
238 commands how to invoke them as well as a short description.
245 The <emphasis>compose</emphasis> menu is a comfortable
247 actions before sending mail: change subjects, attach files,
256 The <emphasis>attachement</emphasis> menu gives a summary and
258 structure of the attachements of the current message.
265 The <emphasis>alias</emphasis> menu lists all or a fraction of
274 The <emphasis>key</emphasis> menu used in connection with
276 users choose the right key to encrypt with.
286 When mutt-ng is started without any further options, it'll open
287 the users default mailbox and display the index.
297 <sect2 id="concept-configuration"> <!--{{{-->
298 <title>Configuration</title>
301 Mutt-ng does <emphasis>not</emphasis> feature an internal
303 interface or menu due to the simple fact that this would be too
304 complex to handle (currently there are several <emphasis>hundred</emphasis>
305 variables which fine-tune the behaviour.)
309 Mutt-ng is configured using configuration files which allow
310 users to add comments or manage them via version control systems
315 Also, mutt-ng comes with a shell script named <literal>grml-muttng</literal>
316 kindly contributed by users which really helps and eases the
317 creation of a user's configuration file. When downloading the
318 source code via a snapshot or via subversion, it can be found in
319 the <literal>contrib</literal> directory.
329 <sect2 id="concept-functions"> <!--{{{-->
330 <title>Functions</title>
333 Mutt-ng offers great flexibility due to the use of functions:
334 internally, every action a user can make mutt-ng perform is named
335 ``function.'' Those functions are assigned to keys (or even key
336 sequences) and may be completely adjusted to user's needs. The
337 basic idea is that the impatient users get a very intuitive
338 interface to start off with and advanced users virtually get no
339 limits to adjustments.
349 <sect2 id="concept-interaction"> <!--{{{-->
350 <title>Interaction</title>
353 Mutt-ng has two basic concepts of user interaction:
362 There is one dedicated line on the screen used to query
363 the user for input, issue any command, query variables and
364 display error and informational messages. As for every type of
365 user input, this requires manual action leading to the need of
373 The automatized interface for interaction are the so
374 called <emphasis>hooks</emphasis>. Hooks specify actions the
376 performed at well-defined situations: what to do when entering
377 which folder, what to do when displaying or replying to what
378 kind of message, etc. These are optional, i.e. a user doesn't
379 need to specify them but can do so.
395 <sect2 id="concept-modularization"> <!--{{{-->
396 <title>Modularization</title>
399 Although mutt-ng has many functionality built-in, many
400 features can be delegated to external tools to increase
401 flexibility: users can define programs to filter a message through
402 before displaying, users can use any program they want for
403 displaying a message, message types (such as PDF or PostScript)
404 for which mutt-ng doesn't have a built-in filter can be rendered
405 by arbitrary tools and so forth. Although mutt-ng has an alias
406 mechanism built-in, it features using external tools to query for
407 nearly every type of addresses from sources like LDAP, databases
408 or just the list of locally known users.
418 <sect2 id="concept-patterns"> <!--{{{-->
419 <title>Patterns</title>
422 Mutt-ng has a built-in pattern matching ``language'' which is
423 as widely used as possible to present a consistent interface to
424 users. The same ``pattern terms'' can be used for searching,
425 scoring, message selection and much more.
443 <sect1 id="screens-and-menus"> <!--{{{-->
444 <title>Screens and Menus</title>
446 <sect2 id="intro-index">
450 The index is the screen that you usually see first when you
451 start mutt-ng. It gives an overview over your emails in the
452 currently opened mailbox. By default, this is your system mailbox.
453 The information you see in the index is a list of emails, each with
454 its number on the left, its flags (new email, important email,
455 email that has been forwarded or replied to, tagged email, ...),
456 the date when email was sent, its sender, the email size, and the
457 subject. Additionally, the index also shows thread hierarchies:
458 when you reply to an email, and the other person replies back, you
459 can see the other's person email in a "sub-tree" below. This is
460 especially useful for personal email between a group of people or
461 when you've subscribed to mailing lists.
470 <sect2 id="intro-pager">
474 The pager is responsible for showing the email content. On the
475 top of the pager you have an overview over the most important email
476 headers like the sender, the recipient, the subject, and much more
477 information. How much information you actually see depends on your
478 configuration, which we'll describe below.
482 Below the headers, you see the email body which usually contains
483 the message. If the email contains any attachments, you will see
484 more information about them below the email body, or, if the
485 attachments are text files, you can view them directly in the
490 To give the user a good overview, it is possible to configure
491 mutt-ng to show different things in the pager with different
492 colors. Virtually everything that can be described with a regular
493 expression can be colored, e.g. URLs, email addresses or smileys.
502 <sect2 id="intro-browser">
503 <title>File Browser</title>
506 The file browser is the interface to the local or remote
507 file system. When selecting a mailbox to open, the browser allows
508 custom sorting of items, limiting the items shown by a regular
509 expression and a freely adjustable format of what to display in
510 which way. It also allows for easy navigation through the
511 file system when selecting file(s) to attach to a message, select
512 multiple files to attach and many more.
521 <sect2 id="intro-sidebar">
522 <title>Sidebar</title>
525 The sidebar comes in handy to manage mails which are spread
526 over different folders. All folders users setup mutt-ng to watch
527 for new mail will be listed. The listing includes not only the
528 name but also the number of total messages, the number of new and
529 flagged messages. Items with new mail may be colored different
530 from those with flagged mail, items may be shortened or compress
531 if they're they to long to be printed in full form so that by
532 abbreviated names, user still now what the name stands for.
541 <sect2 id="intro-help">
545 The help screen is meant to offer a quick help to the user. It
546 lists the current configuration of key bindings and their
547 associated commands including a short description, and currently
548 unbound functions that still need to be associated with a key
549 binding (or alternatively, they can be called via the mutt-ng
559 <sect2 id="intro-compose">
560 <title>Compose Menu</title>
563 The compose menu features a split screen containing the
564 information which really matter before actually sending a
565 message by mail or posting an article to a newsgroup: who gets
566 the message as what (recipient, newsgroup, who gets what kind of
567 copy). Additionally, users may set security options like
568 deciding whether to sign, encrypt or sign and encrypt a message
573 Also, it's used to attach messages, news articles or files to
574 a message, to re-edit any attachment including the message
584 <sect2 id="intro-alias">
585 <title>Alias Menu</title>
588 The alias menu is used to help users finding the recipients
589 of messages. For users who need to contact many people, there's
590 no need to remember addresses or names completely because it
591 allows for searching, too. The alias mechanism and thus the
592 alias menu also features grouping several addresses by a shorter
593 nickname, the actual alias, so that users don't have to select
594 each single recipient manually.
603 <sect2 id="intro-attach">
604 <title>Attachment Menu</title>
607 As will be later discussed in detail, mutt-ng features a good
608 and stable MIME implementation, that is, is greatly supports
609 sending and receiving messages of arbitrary type. The
610 attachment menu displays a message's structure in detail: what
611 content parts are attached to which parent part (which gives a
612 true tree structure), which type is of what type and what size.
613 Single parts may saved, deleted or modified to offer great and
614 easy access to message's internals.
623 <sect2 id="intro-keysel">
624 <title>Key Menu</title>
627 <literal>FIXME</literal>
643 <sect1 id="moving"> <!--{{{-->
644 <title>Moving Around in Menus</title>
647 Information is presented in menus, very similar to ELM. Here is a
648 tableshowing the common keys used to navigate menus in Mutt-ng.
654 <title>Default Menu Movement Keys</title>
655 <tgroup cols="3" align="left" colsep="1" rowsep="1">
659 <entry>Function</entry>
660 <entry>Description</entry>
665 <entry><literal>j</literal> or <literal>Down</literal></entry>
666 <entry><literal>next-entry</literal></entry>
667 <entry>move to the next entry</entry>
670 <entry><literal>k</literal> or <literal>Up</literal></entry>
671 <entry><literal>previous-entry</literal></entry>
672 <entry>move to the previous entry</entry>
675 <entry><literal>z</literal> or <literal>PageDn</literal></entry>
676 <entry><literal>page-down</literal></entry>
677 <entry>go to the next page</entry>
680 <entry><literal>Z</literal> or <literal>PageUp</literal></entry>
681 <entry><literal>page-up</literal></entry>
682 <entry>go to the previous page</entry>
685 <entry><literal>=</literal> or <literal>Home</literal></entry>
686 <entry><literal>first-entry</literal></entry>
687 <entry>jump to the first entry</entry>
690 <entry><literal>*</literal> or <literal>End</literal></entry>
691 <entry><literal>last-entry</literal></entry>
692 <entry>jump to the last entry</entry>
695 <entry><literal>q</literal></entry>
696 <entry><literal>quit</literal></entry>
697 <entry>exit the current menu</entry>
700 <entry><literal>?</literal></entry>
701 <entry><literal>help</literal></entry>
702 <entry>list all key bindings for the current menu</entry>
718 <sect1 id="editing"> <!--{{{-->
719 <title>Editing Input Fields</title>
722 Mutt-ng has a builtin line editor which is used as the primary way to
724 textual data such as email addresses or filenames. The keys used to
726 around while editing are very similar to those of Emacs.
732 <title>Built-In Editor Functions</title>
733 <tgroup cols="3" align="left" colsep="1" rowsep="1">
737 <entry>Function</entry>
738 <entry>Description</entry>
743 <entry><literal>^A or <Home> </literal></entry>
744 <entry><literal>bol </literal></entry>
745 <entry>move to the start of the line</entry>
748 <entry><literal>^B or <Left> </literal></entry>
749 <entry><literal>backward-char </literal>
750 </entry><entry>move back one char</entry>
753 <entry><literal>Esc B </literal></entry>
754 <entry><literal>backward-word </literal></entry>
755 <entry>move back one word</entry>
758 <entry><literal>^D or <Delete> </literal></entry>
759 <entry><literal>delete-char </literal></entry>
760 <entry>delete the char under the cursor</entry>
763 <entry><literal>^E or <End> </literal></entry>
764 <entry><literal>eol </literal></entry>
765 <entry>move to the end of the line</entry>
768 <entry><literal>^F or <Right> </literal></entry>
769 <entry><literal>forward-char </literal></entry>
770 <entry>move forward one char</entry>
773 <entry><literal>Esc F </literal></entry>
774 <entry><literal>forward-word </literal></entry>
775 <entry>move forward one word</entry>
778 <entry><literal><Tab> </literal></entry>
779 <entry><literal>complete </literal></entry>
780 <entry>complete filename or alias</entry>
783 <entry><literal>^T </literal></entry>
784 <entry><literal>complete-query </literal></entry>
785 <entry>complete address with query</entry>
788 <entry><literal>^K </literal></entry>
789 <entry><literal>kill-eol </literal></entry>
790 <entry>delete to the end of the line</entry>
793 <entry><literal>ESC d </literal></entry>
794 <entry><literal>kill-eow </literal></entry>
795 <entry>delete to the end of the word</entry>
798 <entry><literal>^W </literal></entry>
799 <entry><literal>kill-word </literal></entry>
800 <entry>kill the word in front of the cursor</entry>
803 <entry><literal>^U </literal></entry>
804 <entry><literal>kill-line </literal></entry>
805 <entry>delete entire line</entry>
808 <entry><literal>^V </literal></entry>
809 <entry><literal>quote-char </literal></entry>
810 <entry>quote the next typed key</entry>
813 <entry><literal><Up> </literal></entry>
814 <entry><literal>history-up </literal></entry>
815 <entry>recall previous string from history</entry>
818 <entry><literal><Down> </literal></entry>
819 <entry><literal>history-down </literal></entry>
820 <entry>recall next string from history</entry>
823 <entry><literal><BackSpace> </literal></entry>
824 <entry><literal>backspace </literal></entry>
825 <entry>kill the char in front of the cursor</entry>
828 <entry><literal>Esc u </literal></entry>
829 <entry><literal>upcase-word </literal></entry>
830 <entry>convert word to upper case</entry>
833 <entry><literal>Esc l </literal></entry>
834 <entry><literal>downcase-word </literal></entry>
835 <entry>convert word to lower case</entry>
838 <entry><literal>Esc c </literal></entry>
839 <entry><literal>capitalize-word </literal></entry>
840 <entry>capitalize the word</entry>
843 <entry><literal>^G </literal></entry>
844 <entry><literal>n/a </literal></entry>
848 <entry><literal><Return> </literal></entry>
849 <entry><literal>n/a </literal></entry>
850 <entry>finish editing</entry>
859 You can remap the <emphasis>editor</emphasis> functions using the <link linkend="bind">
862 command. For example, to make the <emphasis>Delete</emphasis> key
863 delete the character in
864 front of the cursor rather than under, you could use
868 <literal>bind editor <delete> backspace</literal>
878 <sect1 id="reading"> <!--{{{-->
879 <title>Reading Mail - The Index and Pager</title>
882 Similar to many other mail clients, there are two modes in which mail
883 isread in Mutt-ng. The first is the index of messages in the mailbox,
885 called the ``index'' in Mutt-ng. The second mode is the display of the
886 message contents. This is called the ``pager.''
890 The next few sections describe the functions provided in each of these
894 <sect2 id="reading-index">
895 <title>The Message Index</title>
900 <title>Default Index Menu Bindings</title>
901 <tgroup cols="3" align="left" colsep="1" rowsep="1">
905 <entry>Function</entry>
906 <entry>Description</entry>
910 <row><entry><literal>c </literal></entry><entry><literal></literal></entry><entry>change to a different mailbox</entry></row>
911 <row><entry><literal>ESC c </literal></entry><entry><literal></literal></entry><entry>change to a folder in read-only mode</entry></row>
912 <row><entry><literal>C </literal></entry><entry><literal></literal></entry><entry>copy the current message to another mailbox</entry></row>
913 <row><entry><literal>ESC C </literal></entry><entry><literal></literal></entry><entry>decode a message and copy it to a folder</entry></row>
914 <row><entry><literal>ESC s </literal></entry><entry><literal></literal></entry><entry>decode a message and save it to a folder</entry></row>
915 <row><entry><literal>D </literal></entry><entry><literal></literal></entry><entry>delete messages matching a pattern</entry></row>
916 <row><entry><literal>d </literal></entry><entry><literal></literal></entry><entry>delete the current message</entry></row>
917 <row><entry><literal>F </literal></entry><entry><literal></literal></entry><entry>mark as important</entry></row>
918 <row><entry><literal>l </literal></entry><entry><literal></literal></entry><entry>show messages matching a pattern</entry></row>
919 <row><entry><literal>N </literal></entry><entry><literal></literal></entry><entry>mark message as new</entry></row>
920 <row><entry><literal>o </literal></entry><entry><literal></literal></entry><entry>change the current sort method</entry></row>
921 <row><entry><literal>O </literal></entry><entry><literal></literal></entry><entry>reverse sort the mailbox</entry></row>
922 <row><entry><literal>q </literal></entry><entry><literal></literal></entry><entry>save changes and exit</entry></row>
923 <row><entry><literal>s </literal></entry><entry><literal></literal></entry><entry>save-message</entry></row>
924 <row><entry><literal>T </literal></entry><entry><literal></literal></entry><entry>tag messages matching a pattern</entry></row>
925 <row><entry><literal>t </literal></entry><entry><literal></literal></entry><entry>toggle the tag on a message</entry></row>
926 <row><entry><literal>ESC t </literal></entry><entry><literal></literal></entry><entry>toggle tag on entire message thread</entry></row>
927 <row><entry><literal>U </literal></entry><entry><literal></literal></entry><entry>undelete messages matching a pattern</entry></row>
928 <row><entry><literal>u </literal></entry><entry><literal></literal></entry><entry>undelete-message</entry></row>
929 <row><entry><literal>v </literal></entry><entry><literal></literal></entry><entry>view-attachments</entry></row>
930 <row><entry><literal>x </literal></entry><entry><literal></literal></entry><entry>abort changes and exit</entry></row>
931 <row><entry><literal><Return> </literal></entry><entry><literal></literal></entry><entry>display-message</entry></row>
932 <row><entry><literal><Tab> </literal></entry><entry><literal></literal></entry><entry>jump to the next new or unread message</entry></row>
933 <row><entry><literal>@ </literal></entry><entry><literal></literal></entry><entry>show the author's full e-mail address</entry></row>
934 <row><entry><literal>$ </literal></entry><entry><literal></literal></entry><entry>save changes to mailbox</entry></row>
935 <row><entry><literal>/ </literal></entry><entry><literal></literal></entry><entry>search</entry></row>
936 <row><entry><literal>ESC / </literal></entry><entry><literal></literal></entry><entry>search-reverse</entry></row>
937 <row><entry><literal>^L </literal></entry><entry><literal></literal></entry><entry>clear and redraw the screen</entry></row>
938 <row><entry><literal>^T </literal></entry><entry><literal></literal></entry><entry>untag messages matching a pattern</entry></row>
946 <title>Status Flags</title> <!--{{{-->
949 In addition to who sent the message and the subject, a short
951 the disposition of each message is printed beside the message
953 Zero or more of the following ``flags'' may appear, which mean:
964 message is deleted (is marked for deletion)
972 message have attachments marked for deletion
980 contains a PGP public key
1004 message is PGP encrypted
1012 message has been replied to
1020 message is signed, and the signature is succesfully
1053 Some of the status flags can be turned on or off using
1059 <emphasis role="bold">set-flag</emphasis> (default: w)
1065 <emphasis role="bold">clear-flag</emphasis> (default: W)
1074 Furthermore, the following flags reflect who the message is
1076 to. They can be customized with the
1077 <link linkend="to-chars">$to_chars</link> variable.
1087 message is to you and you only
1095 message is to you, but also to or cc'ed to others
1103 message is cc'ed to you
1119 message is sent to a subscribed mailing list
1130 <sect2 id="reading-pager">
1131 <title>The Pager</title>
1134 By default, Mutt-ng uses its builtin pager to display the body of
1136 The pager is very similar to the Unix program <emphasis>less</emphasis> though not nearly as
1143 <title>Default Pager Menu Bindings</title>
1144 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1148 <entry>Function</entry>
1149 <entry>Description</entry>
1153 <row><entry><literal><Return> </literal></entry><entry><literal></literal></entry><entry>go down one line</entry></row>
1154 <row><entry><literal><Space> </literal></entry><entry><literal></literal></entry><entry>display the next page (or next message if at the end of a message)</entry></row>
1155 <row><entry><literal>- </literal></entry><entry><literal></literal></entry><entry>go back to the previous page</entry></row>
1156 <row><entry><literal>n </literal></entry><entry><literal></literal></entry><entry>search for next match</entry></row>
1157 <row><entry><literal>S </literal></entry><entry><literal></literal></entry><entry>skip beyond quoted text</entry></row>
1158 <row><entry><literal>T </literal></entry><entry><literal></literal></entry><entry>toggle display of quoted text</entry></row>
1159 <row><entry><literal>? </literal></entry><entry><literal></literal></entry><entry>show key bindings</entry></row>
1160 <row><entry><literal>/ </literal></entry><entry><literal></literal></entry><entry>search for a regular expression (pattern)</entry></row>
1161 <row><entry><literal>ESC / </literal></entry><entry><literal></literal></entry><entry>search backwards for a regular expression</entry></row>
1162 <row><entry><literal>\ </literal></entry><entry><literal></literal></entry><entry>toggle search pattern coloring</entry></row>
1163 <row><entry><literal>^ </literal></entry><entry><literal></literal></entry><entry>jump to the top of the message</entry></row>
1172 In addition, many of the functions from the <emphasis>index</emphasis> are available in
1173 the pager, such as <emphasis>delete-message</emphasis> or <emphasis>
1177 advantage over using an external pager to view messages).
1181 Also, the internal pager supports a couple other advanced features.
1183 one, it will accept and translate the ``standard'' nroff sequences
1184 forbold and underline. These sequences are a series of either the
1186 backspace (ˆH), the letter again for bold or the letter,
1188 ``_'' for denoting underline. Mutt-ng will attempt to display
1190 in bold and underline respectively if your terminal supports them. If
1191 not, you can use the bold and underline <link
1192 linkend="color">color</link>
1193 objects to specify a color or mono attribute for them.
1197 Additionally, the internal pager supports the ANSI escape
1198 sequences for character attributes. Mutt-ng translates them
1199 into the correct color and character settings. The sequences
1200 Mutt-ng supports are: <literal>ESC [ Ps;Ps;Ps;...;Ps
1201 m</literal> (see table below for possible values for
1202 <literal>Ps</literal>).
1208 <title>ANSI Escape Sequences</title>
1209 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1212 <entry>Value</entry>
1213 <entry>Attribute</entry>
1217 <row><entry><literal>0 </literal></entry><entry>All Attributes Off</entry></row>
1218 <row><entry><literal>1 </literal></entry><entry>Bold on</entry></row>
1219 <row><entry><literal>4 </literal></entry><entry>Underline on</entry></row>
1220 <row><entry><literal>5 </literal></entry><entry>Blink on</entry></row>
1221 <row><entry><literal>7 </literal></entry><entry>Reverse video on</entry></row>
1222 <row><entry><literal>3x </literal></entry><entry>Foreground color is x (see table below)</entry></row>
1223 <row><entry><literal>4x </literal></entry><entry>Background color is x (see table below)</entry></row>
1230 <title>ANSI Colors</title>
1231 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1234 <entry>Number</entry>
1235 <entry>Color</entry>
1239 <row><entry><literal>0 </literal></entry><entry>black</entry></row>
1240 <row><entry><literal>1 </literal></entry><entry>red</entry></row>
1241 <row><entry><literal>2 </literal></entry><entry>green</entry></row>
1242 <row><entry><literal>3 </literal></entry><entry>yellow</entry></row>
1243 <row><entry><literal>4 </literal></entry><entry>blue</entry></row>
1244 <row><entry><literal>5 </literal></entry><entry>magenta</entry></row>
1245 <row><entry><literal>6 </literal></entry><entry>cyan</entry></row>
1246 <row><entry><literal>7 </literal></entry><entry>white</entry></row>
1255 Mutt-ng uses these attributes for handling text/enriched messages,
1257 can also be used by an external <link
1258 linkend="auto-view">autoview</link>
1259 script for highlighting purposes. <emphasis role="bold">Note:</emphasis> If you change the colors for your
1260 display, for example by changing the color associated with color2 for
1261 your xterm, then that color will be used instead of green.
1266 <sect2 id="threads">
1267 <title>Threaded Mode</title>
1270 When the mailbox is <link linkend="sort">sorted</link> by <emphasis>
1274 a few additional functions available in the <emphasis>index</emphasis> and <emphasis>
1283 <title>Default Thread Function Bindings</title>
1284 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1288 <entry>Function</entry>
1289 <entry>Description</entry>
1293 <row><entry><literal>^D </literal></entry><entry><literal>delete-thread </literal></entry><entry>delete all messages in the current thread</entry></row>
1294 <row><entry><literal>^U </literal></entry><entry><literal>undelete-thread </literal></entry><entry>undelete all messages in the current thread</entry></row>
1295 <row><entry><literal>^N </literal></entry><entry><literal>next-thread </literal></entry><entry>jump to the start of the next thread</entry></row>
1296 <row><entry><literal>^P </literal></entry><entry><literal>previous-thread </literal></entry><entry>jump to the start of the previous thread</entry></row>
1297 <row><entry><literal>^R </literal></entry><entry><literal>read-thread </literal></entry><entry>mark the current thread as read</entry></row>
1298 <row><entry><literal>ESC d </literal></entry><entry><literal>delete-subthread </literal></entry><entry>delete all messages in the current subthread</entry></row>
1299 <row><entry><literal>ESC u </literal></entry><entry><literal>undelete-subthread </literal></entry><entry>undelete all messages in the current subthread</entry></row>
1300 <row><entry><literal>ESC n </literal></entry><entry><literal>next-subthread </literal></entry><entry>jump to the start of the next subthread</entry></row>
1301 <row><entry><literal>ESC p </literal></entry><entry><literal>previous-subthread </literal></entry><entry>jump to the start of the previous subthread</entry></row>
1302 <row><entry><literal>ESC r </literal></entry><entry><literal>read-subthread </literal></entry><entry>mark the current subthread as read </entry></row>
1303 <row><entry><literal>ESC t </literal></entry><entry><literal>tag-thread </literal></entry><entry>toggle the tag on the current thread</entry></row>
1304 <row><entry><literal>ESC v </literal></entry><entry><literal>collapse-thread </literal></entry><entry>toggle collapse for the current thread</entry></row>
1305 <row><entry><literal>ESC V </literal></entry><entry><literal>collapse-all </literal></entry><entry>toggle collapse for all threads</entry></row>
1306 <row><entry><literal>P </literal></entry><entry><literal>parent-message </literal></entry><entry>jump to parent message in thread</entry></row>
1315 <emphasis role="bold">Note:</emphasis> Collapsing a thread displays
1316 only the first message
1317 in the thread and hides the others. This is useful when threads
1318 contain so many messages that you can only see a handful of threads
1319 onthe screen. See %M in <link
1320 linkend="index-format">
1324 For example, you could use
1325 "%?M?(#%03M)&(%4l)?" in <link linkend="index-format">
1329 display the number of hidden messages if the thread is collapsed.
1333 See also: <link linkend="strict-threads">strict-threads</link>.
1338 <sect2 id="pager-functions">
1339 <title>Miscellaneous Functions</title>
1342 <emphasis role="bold">create-alias</emphasis><anchor id="create-alias"/>
1348 Creates a new alias based upon the current message (or prompts for a
1349 new one). Once editing is complete, an <link linkend="alias">alias</link>
1350 command is added to the file specified by the <link linkend="alias-file">
1353 variable for future use. <emphasis role="bold">Note:</emphasis>
1354 Specifying an <link linkend="alias-file">alias-file</link>
1355 does not add the aliases specified there-in, you must also <link linkend="source">
1362 <emphasis role="bold">check-traditional-pgp</emphasis><anchor id="check-traditional-pgp"/>
1368 This function will search the current message for content signed or
1369 encrypted with PGP the "traditional" way, that is, without proper
1370 MIME tagging. Technically, this function will temporarily change
1371 the MIME content types of the body parts containing PGP data; this
1372 is similar to the <link linkend="edit-type">edit-type</link>
1378 <emphasis role="bold">display-toggle-weed</emphasis><anchor id="display-toggle-weed"/>
1384 Toggles the weeding of message header fields specified by <link linkend="ignore">
1391 <emphasis role="bold">edit</emphasis><anchor id="edit"/>
1397 This command (available in the ``index'' and ``pager'') allows you to
1398 edit the raw current message as it's present in the mail folder.
1399 After you have finished editing, the changed message will be
1400 appended to the current folder, and the original message will be
1401 marked for deletion.
1405 <emphasis role="bold">edit-type</emphasis><anchor id="edit-type"/>
1407 (default: ˆE on the attachment menu, and in the pager and index
1408 menus; ˆT on the
1413 This command is used to temporarily edit an attachment's content
1414 type to fix, for instance, bogus character set parameters. When
1415 invoked from the index or from the pager, you'll have the
1416 opportunity to edit the top-level attachment's content type. On the
1417 <link linkend="attach-menu">attach-menu</link>, you can change any
1418 attachment's content type. These changes are not persistent, and get
1419 lost upon changing folders.
1423 Note that this command is also available on the <link linkend="compose-menu">
1426 .There, it's used to
1427 fine-tune the properties of attachments you are going to send.
1431 <emphasis role="bold">enter-command</emphasis><anchor id="enter-command"/>
1437 This command is used to execute any command you would normally put in
1439 configuration file. A common use is to check the settings of
1441 in conjunction with <link linkend="macro">macro</link> to change
1447 <emphasis role="bold">extract-keys</emphasis><anchor id="extract-keys"/>
1453 This command extracts PGP public keys from the current or tagged
1454 message(s) and adds them to your PGP public key ring.
1458 <emphasis role="bold">forget-passphrase</emphasis><anchor id="forget-passphrase"/>
1465 This command wipes the passphrase(s) from memory. It is useful, if
1466 you misspelled the passphrase.
1470 <emphasis role="bold">list-reply</emphasis><anchor id="func-list-reply"/>
1476 Reply to the current or tagged message(s) by extracting any addresses
1478 match the regular expressions given by the <link linkend="lists">
1481 commands, but also honor any <literal>Mail-Followup-To</literal>
1483 <link linkend="honor-followup-to">honor-followup-to</link>
1484 configuration variable is set. Using this when replying to messages
1486 to mailing lists helps avoid duplicate copies being sent to the
1488 the message you are replying to.
1492 <emphasis role="bold">pipe-message</emphasis><anchor id="pipe-message"/>
1498 Asks for an external Unix command and pipes the current or
1499 tagged message(s) to it. The variables <link linkend="pipe-decode">
1502 ,<link linkend="pipe-split">pipe-split</link>, <link linkend="pipe-sep">
1505 and <link linkend="wait-key">wait-key</link> control the exact
1511 <emphasis role="bold">resend-message</emphasis><anchor id="resend-message"/>
1517 With resend-message, mutt takes the current message as a template for
1519 new message. This function is best described as "recall from
1521 folders". It can conveniently be used to forward MIME messages while
1522 preserving the original mail structure. Note that the amount of
1524 included here depends on the value of the <link linkend="weed">weed</link>
1529 This function is also available from the attachment menu. You can use
1531 to easily resend a message which was included with a bounce message
1532 as a message/rfc822 body part.
1536 <emphasis role="bold">shell-escape</emphasis><anchor id="shell-escape"/>
1542 Asks for an external Unix command and executes it. The <link linkend="wait-key">
1545 can be used to control
1546 whether Mutt-ng will wait for a key to be pressed when the command
1548 (presumably to let the user read the output of the command), based on
1549 the return status of the named command.
1553 <emphasis role="bold">toggle-quoted</emphasis><anchor id="toggle-quoted"/>
1559 The <emphasis>pager</emphasis> uses the <link linkend="quote-regexp">
1562 variable to detect quoted text when
1563 displaying the body of the message. This function toggles the
1564 displayof the quoted material in the message. It is particularly
1566 are interested in just the response and there is a large amount of
1567 quoted text in the way.
1571 <emphasis role="bold">skip-quoted</emphasis><anchor id="skip-quoted"/>
1577 This function will go to the next line of non-quoted text which come
1578 after a line of quoted text in the internal pager.
1590 <sect1 id="sending"> <!--{{{-->
1591 <title>Sending Mail</title>
1594 The following bindings are available in the <emphasis>index</emphasis>
1602 <title>Default Mail Composition Bindings</title>
1603 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1607 <entry>Function</entry>
1608 <entry>Description</entry>
1612 <row><entry><literal>m </literal></entry><entry><literal>compose </literal></entry><entry>compose a new message</entry></row>
1613 <row><entry><literal>r </literal></entry><entry><literal>reply </literal></entry><entry>reply to sender</entry></row>
1614 <row><entry><literal>g </literal></entry><entry><literal>group-reply </literal></entry><entry>reply to all recipients</entry></row>
1615 <row><entry><literal>L </literal></entry><entry><literal>list-reply </literal></entry><entry>reply to mailing list address</entry></row>
1616 <row><entry><literal>f </literal></entry><entry><literal>forward </literal></entry><entry>forward message</entry></row>
1617 <row><entry><literal>b </literal></entry><entry><literal>bounce </literal></entry><entry>bounce (remail) message</entry></row>
1618 <row><entry><literal>ESC k </literal></entry><entry><literal>mail-key </literal></entry><entry>mail a PGP public key to someone</entry></row>
1626 Bouncing a message sends the message as is to the recipient you
1627 specify. Forwarding a message allows you to add comments or
1628 modify the message you are forwarding. These items are discussed
1629 in greater detail in the next chapter <link linkend="forwarding-mail">
1635 <sect2 id="sending-compose">
1636 <title>Composing new messages</title>
1639 When you want to send an email using mutt-ng, simply press <literal>m</literal> on
1640 your keyboard. Then, mutt-ng asks for the recipient via a prompt in
1652 After you've finished entering the recipient(s), press return. If you
1653 want to send an email to more than one recipient, separate the email
1654 addresses using the comma "<literal>,</literal>". Mutt-ng then asks
1656 subject. Again, press return after you've entered it. After that,
1658 got the most important information from you, and starts up an editor
1659 where you can then enter your email.
1663 The editor that is called is selected in the following way: you
1664 can e.g. set it in the mutt-ng configuration:
1670 set editor = "vim +/^$/ -c ':set tw=72'"
1672 set editor = "emacs"</screen>
1677 If you don't set your preferred editor in your configuration, mutt-ng
1678 first looks whether the environment variable <literal>$VISUAL</literal> is set, and if
1679 so, it takes its value as editor command. Otherwise, it has a look
1680 at <literal>$EDITOR</literal> and takes its value if it is set. If no
1682 can be found, mutt-ng simply assumes <literal>vi</literal> to be the
1684 since it's the most widespread editor in the Unix world and it's
1686 safe to assume that it is installed and available.
1690 When you've finished entering your message, save it and quit your
1691 editor. Mutt-ng will then present you with a summary screen, the
1693 On the top, you see a summary of the most important available key
1695 Below that, you see the sender, the recipient(s), Cc and/or Bcc
1696 recipient(s), the subject, the reply-to address, and optionally
1697 information where the sent email will be stored and whether it should
1698 be digitally signed and/or encrypted.
1702 Below that, you see a list of "attachments". The mail you've just
1703 entered before is also an attachment, but due to its special type
1704 (it's plain text), it will be displayed as the normal message on
1705 the receiver's side.
1709 At this point, you can add more attachments, pressing <literal>a</literal>, you
1710 can edit the recipient addresses, pressing <literal>t</literal> for
1712 <literal>c</literal> for the "Cc:" field, and <literal>b</literal>
1713 for the "Bcc: field. You can
1714 also edit the subject the subject by simply pressing <literal>s</literal> or the
1715 email message that you've entered before by pressing <literal>e</literal>. You will
1716 then again return to the editor. You can even edit the sender, by
1718 <literal><esc>f</literal>, but this shall only be used with
1723 Alternatively, you can configure mutt-ng in a way that most of the
1724 above settings can be edited using the editor. Therefore, you only
1725 need to add the following to your configuration:
1731 set edit_headers</screen>
1736 Once you have finished editing the body of your mail message, you are
1737 returned to the <emphasis>compose</emphasis> menu. The following
1738 options are available:
1744 <title>Default Compose Menu Bindings</title>
1745 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1749 <entry>Function</entry>
1750 <entry>Description</entry>
1754 <row><entry><literal>a </literal></entry><entry><literal>attach-file </literal></entry><entry>attach a file</entry></row>
1755 <row><entry><literal>A </literal></entry><entry><literal>attach-message </literal></entry><entry>attach message(s) to the message</entry></row>
1756 <row><entry><literal>ESC k </literal></entry><entry><literal>attach-key </literal></entry><entry>attach a PGP public key</entry></row>
1757 <row><entry><literal>d </literal></entry><entry><literal>edit-description </literal></entry><entry>edit description on attachment</entry></row>
1758 <row><entry><literal>D </literal></entry><entry><literal>detach-file </literal></entry><entry>detach a file</entry></row>
1759 <row><entry><literal>t </literal></entry><entry><literal>edit-to </literal></entry><entry>edit the To field</entry></row>
1760 <row><entry><literal>ESC f </literal></entry><entry><literal>edit-from </literal></entry><entry>edit the From field</entry></row>
1761 <row><entry><literal>r </literal></entry><entry><literal>edit-reply-to </literal></entry><entry>edit the Reply-To field</entry></row>
1762 <row><entry><literal>c </literal></entry><entry><literal>edit-cc </literal></entry><entry>edit the Cc field</entry></row>
1763 <row><entry><literal>b </literal></entry><entry><literal>edit-bcc </literal></entry><entry>edit the Bcc field</entry></row>
1764 <row><entry><literal>y </literal></entry><entry><literal>send-message </literal></entry><entry>send the message</entry></row>
1765 <row><entry><literal>s </literal></entry><entry><literal>edit-subject </literal></entry><entry>edit the Subject</entry></row>
1766 <row><entry><literal>S </literal></entry><entry><literal>smime-menu </literal></entry><entry>select S/MIME options</entry></row>
1767 <row><entry><literal>f </literal></entry><entry><literal>edit-fcc </literal></entry><entry>specify an ``Fcc'' mailbox</entry></row>
1768 <row><entry><literal>p </literal></entry><entry><literal>pgp-menu </literal></entry><entry>select PGP options</entry></row>
1769 <row><entry><literal>P </literal></entry><entry><literal>postpone-message </literal></entry><entry>postpone this message until later</entry></row>
1770 <row><entry><literal>q </literal></entry><entry><literal>quit </literal></entry><entry>quit (abort) sending the message</entry></row>
1771 <row><entry><literal>w </literal></entry><entry><literal>write-fcc </literal></entry><entry>write the message to a folder</entry></row>
1772 <row><entry><literal>i </literal></entry><entry><literal>ispell </literal></entry><entry>check spelling (if available on your system)</entry></row>
1773 <row><entry><literal>^F </literal></entry><entry><literal>forget-passphrase </literal></entry><entry>wipe passphrase(s) from memory</entry></row>
1781 <emphasis role="bold">Note:</emphasis> The attach-message function
1782 will prompt you for a folder to
1783 attach messages from. You can now tag messages in that folder and
1784 theywill be attached to the message you are sending. Note that
1785 certainoperations like composing a new mail, replying, forwarding,
1787 not permitted when you are in that folder. The %r in <link linkend="status-format">
1791 a 'A' to indicate that you are in attach-message mode.
1800 <sect2 id="sending-reply">
1801 <title>Replying</title>
1803 <sect3 id="sending-simple-reply">
1804 <title>Simple Replies</title>
1807 When you want to reply to an email message, select it in the index
1808 menu and then press <literal>r</literal>. Mutt-ng's behaviour is
1810 behaviour when you compose a message: first, you will be asked for
1811 the recipient, then for the subject, and then, mutt-ng will start
1812 the editor with the quote attribution and the quoted message. This
1813 can e.g. look like the example below.
1819 On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
1820 > Bill, can you please send last month's progress report to Mr.
1821 > Morgan? We also urgently need the cost estimation for the new
1822 > production server that we want to set up before our customer's
1823 > project will go live.</screen>
1828 You can start editing the email message. It is strongly
1829 recommended to put your answer <emphasis>below</emphasis> the
1831 only quote what is really necessary and that you refer to. Putting
1832 your answer on top of the quoted message, is, although very
1833 widespread, very often not considered to be a polite way to answer
1838 The quote attribution is configurable, by default it is set to
1841 set attribution = "On %d, %n wrote:"</screen>
1846 It can also be set to something more compact, e.g.
1849 set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</screen>
1854 The example above results in the following attribution:
1857 * Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
1858 > Bill, can you please send last month's progress report to Mr.
1859 > Morgan? We also urgently need the cost estimation for the new
1860 > production server that we want to set up before our customer's
1861 > project will go live.</screen>
1866 Generally, try to keep your attribution short yet
1867 information-rich. It is <emphasis>not</emphasis> the right place
1869 long "attribution" novels or anything like that: the right place
1870 for such things is - if at all - the email signature at the very
1871 bottom of the message.
1875 When you're done with writing your message, save and quit the
1876 editor. As before, you will return to the compose menu, which is
1877 used in the same way as before.
1886 <sect3 id="sending-group-reply">
1887 <title>Group Replies</title>
1890 In the situation where a group of people uses email as a
1891 discussion, most of the emails will have one or more recipients,
1892 and probably several "Cc:" recipients. The group reply
1893 functionalityensures that when you press <literal>g</literal>
1894 instead of <literal>r</literal> to do a reply,
1895 each and every recipient that is contained in the original message
1896 will receive a copy of the message, either as normal recipient or
1906 <sect3 id="sending-list-reply">
1907 <title>List Replies</title>
1910 When you use mailing lists, it's generally better to send your
1911 reply to a message only to the list instead of the list and the
1912 original author. To make this easy to use, mutt-ng features list
1917 To do a list reply, simply press <literal>L</literal>. If the email
1919 a <literal>Mail-Followup-To:</literal> header, its value will be
1921 address. Otherwise, mutt-ng searches through all mail addresses in
1922 the original message and tries to match them a list of regular
1923 expressions which can be specified using the <literal>lists</literal> command.
1924 If any of the regular expression matches, a mailing
1925 list address has been found, and it will be used as reply address.
1931 lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</screen>
1936 Nowadays, most mailing list software like GNU Mailman adds a
1937 <literal>Mail-Followup-To:</literal> header to their emails anyway,
1939 <literal>lists</literal> is hardly ever necessary in practice.
1954 <sect2 id="sending-edit-header">
1955 <title>Editing the message header</title>
1958 When editing the header of your outgoing message, there are a couple
1960 special features available.
1966 <literal>Fcc:</literal> <emphasis>filename</emphasis>
1968 Mutt-ng will pick up <emphasis>filename</emphasis>
1969 just as if you had used the <emphasis>edit-fcc</emphasis> function in
1970 the <emphasis>compose</emphasis> menu.
1974 You can also attach files to your message by specifying
1976 <literal>Attach:</literal> <emphasis>filename</emphasis> [ <emphasis>
1981 where <emphasis>filename</emphasis> is the file to attach and <emphasis>
1985 optional string to use as the description of the attached file.
1989 When replying to messages, if you remove the <emphasis>In-Reply-To:</emphasis> field from
1990 the header field, Mutt-ng will not generate a <emphasis>References:</emphasis> field, which
1991 allows you to create a new message thread.
1995 Also see <link linkend="edit-headers">edit-headers</link>.
2004 <sect2 id="sending-crypto">
2005 <title>Using Mutt-ng with PGP</title>
2008 If you want to use PGP, you can specify
2012 <literal>Pgp:</literal> [ <literal>E</literal> | <literal>
2015 | <literal>S</literal><emphasis><id></emphasis> ]
2020 ``E'' encrypts, ``S'' signs and
2021 ``S<id>'' signs with the given key, setting <link linkend="pgp-sign-as">
2028 If you have told mutt to PGP encrypt a message, it will guide you
2029 through a key selection process when you try to send the message.
2030 Mutt-ng will not ask you any questions about keys which have a
2031 certified user ID matching one of the message recipients' mail
2032 addresses. However, there may be situations in which there are
2033 several keys, weakly certified user ID fields, or where no matching
2038 In these cases, you are dropped into a menu with a list of keys from
2039 which you can select one. When you quit this menu, or mutt can't
2040 find any matching keys, you are prompted for a user ID. You can, as
2041 usually, abort this prompt using <literal>ˆG</literal>. When
2042 you do so, mutt will
2043 return to the compose screen.
2047 Once you have successfully finished the key selection, the message
2048 will be encrypted using the selected public keys, and sent out.
2052 Most fields of the entries in the key selection menu (see also <link linkend="pgp-entry-format">
2056 have obvious meanings. But some explanations on the capabilities,
2058 and validity fields are in order.
2062 The flags sequence (%f) will expand to one of the following
2067 <title>PGP Key Menu Flags</title>
2068 <tgroup cols="2" align="left" colsep="1" rowsep="1">
2072 <entry>Description</entry>
2076 <row><entry><literal>R </literal></entry><entry>The key has been revoked and can't be used.</entry></row>
2077 <row><entry><literal>X </literal></entry><entry>The key is expired and can't be used.</entry></row>
2078 <row><entry><literal>d </literal></entry><entry>You have marked the key as disabled.</entry></row>
2079 <row><entry><literal>c </literal></entry><entry>There are unknown critical self-signature packets.</entry></row>
2087 The capabilities field (%c) expands to a two-character
2088 sequencerepresenting a key's capabilities. The first character gives
2089 the key's encryption capabilities: A minus sign (<emphasis role="bold">
2093 that the key cannot be used for encryption. A dot (<emphasis role="bold">
2097 it's marked as a signature key in one of the user IDs, but may
2098 also be used for encryption. The letter <emphasis role="bold">e</emphasis> indicates that
2099 this key can be used for encryption.
2103 The second character indicates the key's signing capabilities. Once
2104 again, a ``<emphasis role="bold">-</emphasis>'' implies ``not for
2105 signing'', ``<emphasis role="bold">.</emphasis>'' implies
2106 that the key is marked as an encryption key in one of the user-ids,
2108 ``<emphasis role="bold">s</emphasis>'' denotes a key which can be
2113 Finally, the validity field (%t) indicates how well-certified
2115 is. A question mark (<emphasis role="bold">?</emphasis>) indicates
2116 undefined validity, a minus
2117 character (<emphasis role="bold">-</emphasis>) marks an untrusted
2118 association, a space character
2119 means a partially trusted association, and a plus character (<emphasis role="bold">
2123 indicates complete validity.
2132 <sect2 id="sending-mixmaster">
2133 <title>Sending anonymous messages via mixmaster</title>
2136 You may also have configured mutt to co-operate with Mixmaster, an
2137 anonymous remailer. Mixmaster permits you to send your messages
2138 anonymously using a chain of remailers. Mixmaster support in mutt is
2140 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
2141 It does not support earlier versions or the later so-called version 3
2143 of which the latest appears to be called 2.9b23.
2147 To use it, you'll have to obey certain restrictions. Most
2148 important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell
2149 Mutt-ng to use mixmaster, you have to select a remailer chain, using
2150 the mix function on the compose menu.
2154 The chain selection screen is divided into two parts. In the
2155 (larger) upper part, you get a list of remailers you may use. In
2156 the lower part, you see the currently selected chain of remailers.
2160 You can navigate in the chain using the <literal>chain-prev</literal>
2162 <literal>chain-next</literal> functions, which are by default bound
2164 and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi
2165 keyboard bindings). To insert a remailer at the current chain
2166 position, use the <literal>insert</literal> function. To append a
2168 the current chain position, use <literal>select-entry</literal> or <literal>
2172 You can also delete entries from the chain, using the corresponding
2173 function. Finally, to abandon your changes, leave the menu, or
2174 <literal>accept</literal> them pressing (by default) the <literal>
2181 Note that different remailers do have different capabilities,
2182 indicated in the %c entry of the remailer menu lines (see
2183 <link linkend="mix-entry-format">mix-entry-format</link>). Most
2185 the ``middleman'' capability, indicated by a capital ``M'': This
2186 means that the remailer in question cannot be used as the final
2187 element of a chain, but will only forward messages to other
2188 mixmaster remailers. For details on the other capabilities, please
2189 have a look at the mixmaster documentation.
2204 <sect1 id="forwarding-mail">
2205 <title>Forwarding and Bouncing Mail</title>
2208 Often, it is necessary to forward mails to other people.
2209 Therefore, mutt-ng supports forwarding messages in two different
2214 The first one is regular forwarding, as you probably know it from
2215 other mail clients. You simply press <literal>f</literal>, enter the
2217 email address, the subject of the forwarded email, and then you can
2218 edit the message to be forwarded in the editor. The forwarded
2219 message is separated from the rest of the message via the two
2226 ----- Forwarded message from Lucas User <luser@example.com> -----
2228 From: Lucas User <luser@example.com>
2229 Date: Thu, 02 Dec 2004 03:08:34 +0100
2230 To: Michael Random <mrandom@example.com>
2231 Subject: Re: blackmail
2233 Pay me EUR 50,000.- cash or your favorite stuffed animal will die
2236 ----- End forwarded message -----</screen>
2241 When you're done with editing the mail, save and quit the editor,
2242 and you will return to the compose menu, the same menu you also
2243 encounter when composing or replying to mails.
2247 The second mode of forwarding emails with mutt-ng is the
2248 so-called <emphasis>bouncing</emphasis>: when you bounce an email to
2250 address, it will be sent in practically the same format you send it
2251 (except for headers that are created during transporting the
2252 message). To bounce a message, press <literal>b</literal> and enter the
2254 email address. By default, you are then asked whether you really
2255 want to bounce the message to the specified recipient. If you answer
2256 with yes, the message will then be bounced.
2260 To the recipient, the bounced email will look as if he got it
2261 like a regular email where he was <literal>Bcc:</literal> recipient.
2263 possibility to find out whether it was a bounced email is to
2264 carefully study the email headers and to find out which host really
2274 <sect1 id="postponing-mail">
2275 <title>Postponing Mail</title>
2278 At times it is desirable to delay sending a message that you have
2279 already begun to compose. When the <emphasis>postpone-message</emphasis> function is
2280 used in the <emphasis>compose</emphasis> menu, the body of your message
2282 are stored in the mailbox specified by the <link linkend="postponed">
2285 variable. This means that you can recall the
2286 message even if you exit Mutt-ng and then restart it at a later time.
2290 Once a message is postponed, there are several ways to resume it. From
2292 command line you can use the ``-p'' option, or if you <emphasis>compose</emphasis> a new
2293 message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed
2294 messages exist. If multiple messages are currently postponed, the
2295 <emphasis>postponed</emphasis> menu will pop up and you can select
2296 which message you would
2301 <emphasis role="bold">Note:</emphasis> If you postpone a reply to a
2302 message, the reply setting of
2303 the message is only updated when you actually finish the message and
2304 send it. Also, you must be in the same folder with the message you
2305 replied to for the status of the message to be updated.
2309 See also the <link linkend="postpone">postpone</link> quad-option.
2327 <chapter id="configuration"> <!--{{{-->
2328 <title>Configuration</title>
2330 <sect1 id="configuration-files">
2331 <title>Locations of Configuration Files</title>
2334 While the default configuration (or ``preferences'') make Mutt-ng
2336 of the box, it is often desirable to tailor Mutt-ng to suit your own
2338 Mutt-ng is first invoked, it will attempt to read the ``system''
2340 file (defaults set by your local system administrator), unless the
2341 ``-n'' <link linkend="commandline">commandline</link> option is
2342 specified. This file is
2343 typically <literal>/usr/local/share/muttng/Muttngrc</literal> or <literal>
2347 Mutt-ng users will find this file in <literal>
2348 /usr/local/share/muttng/Muttrc
2351 <literal>/etc/Muttngrc</literal>. Mutt will next look for a file named <literal>
2354 in your home directory, Mutt-ng will look for <literal>.muttngrc</literal>. If this file
2355 does not exist and your home directory has a subdirectory named <literal>
2359 mutt try to load a file named <literal>.muttng/muttngrc</literal>.
2363 <literal>.muttrc</literal> (or <literal>.muttngrc</literal> for
2364 Mutt-ng) is the file where you will
2365 usually place your <link linkend="commands">commands</link> to
2375 <sect1 id="configuration-syntax">
2376 <title>Basic Syntax of Initialization Files</title>
2379 An initialization file consists of a series of <link linkend="commands">
2382 .Each line of the file may contain one or more commands.
2383 When multiple commands are used, they must be separated by a semicolon
2387 set realname='Mutt-ng user' ; ignore x-</screen>
2389 The hash mark, or pound sign
2390 (``#''), is used as a ``comment'' character. You can use it to
2391 annotate your initialization file. All text after the comment character
2392 to the end of the line is ignored. For example,
2398 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
2403 Single quotes (') and double quotes (") can be used to quote
2405 which contain spaces or other special characters. The difference
2407 the two types of quotes is similar to that of many popular shell
2409 namely that a single quote is used to specify a literal string (one
2411 not interpreted for shell variables or quoting with a backslash
2413 next paragraph]), while double quotes indicate a string for which
2414 should be evaluated. For example, backtics are evaluated inside of
2416 quotes, but <emphasis role="bold">not</emphasis> for single quotes.
2420 \ quotes the next character, just as in shells such as bash and
2422 For example, if want to put quotes ``"'' inside of a string, you
2424 ``\'' to force the next character to be a literal instead of
2429 set realname="Michael \"MuttDude\" Elkins"</screen>
2434 ``\\'' means to insert a literal ``\'' into the line.
2435 ``\n'' and ``\r'' have their usual C meanings of linefeed and
2436 carriage-return, respectively.
2440 A \ at the end of a line can be used to split commands over
2441 multiple lines, provided that the split points don't appear in the
2442 middle of command names.
2446 Please note that, unlike the various shells, mutt-ng interprets a
2448 at the end of a line also in comments. This allows you to disable a
2450 split over multiple lines with only one ``#''.
2457 set realname="Michael \"MuttDude\" Elkins"</screen>
2462 When testing your config files, beware the following caveat. The
2464 at the end of the commented line extends the current line with the next
2466 - then referred to as a ``continuation line''. As the first line is
2467 commented with a hash (#) all following continuation lines are also
2468 part of a comment and therefore are ignored, too. So take care of
2470 when continuation lines are involved within your setup files!
2489 line1 ``continues'' until line4. however, the part after the # is a
2490 comment which includes line3 and line4. line5 is a new line of its own
2492 thus is interpreted again.
2496 The commands understood by mutt are explained in the next paragraphs.
2497 For a complete list, see the <link linkend="commands">commands</link>.
2506 <sect1 id="configuration-expansion">
2507 <title>Expansion within variables</title>
2510 Besides just assign static content to variables, there's plenty of
2511 ways of adding external and more or less dynamic content.
2514 <sect2 id="configuration-expansion-commands">
2515 <title>Commands' Output</title>
2518 It is possible to substitute the output of a Unix command in an
2519 initialization file. This is accomplished by enclosing the command
2520 in backquotes (``) as in, for example:
2526 my_hdr X-Operating-System: `uname -a`</screen>
2531 The output of the Unix command ``uname -a'' will be substituted
2532 before the line is parsed. Note that since initialization files are
2533 line oriented, only the first line of output from the Unix command
2534 will be substituted.
2539 <sect2 id="configuration-expansion-environment">
2540 <title>Environment Variables</title>
2543 UNIX environments can be accessed like the way it is done in
2544 shells like sh and bash: Prepend the name of the environment by a
2545 ``$'' sign. For example,
2551 set record=+sent_on_$HOSTNAME</screen>
2556 sets the <link linkend="record">record</link> variable to the
2557 string <emphasis>+sent_on_</emphasis> and appends the
2558 value of the evironment
2559 variable <literal>$HOSTNAME</literal>.
2563 <emphasis role="bold">Note:</emphasis> There will be no warning if an
2564 environment variable
2565 is not defined. The result will of the expansion will then be empty.
2570 <sect2 id="configuration-expansion-config">
2571 <title>Configuration Variables</title>
2574 As for environment variables, the values of all configuration
2575 variables as string can be used in the same way, too. For example,
2581 set imap_home_namespace = $folder</screen>
2586 would set the value of <link linkend="imap-home-namespace">
2590 which <link linkend="folder">folder</link> is <emphasis>currently</emphasis> set
2595 <emphasis role="bold">Note:</emphasis> There're no logical links
2596 established in such cases so
2597 that the the value for <link linkend="imap-home-namespace">
2601 if <link linkend="folder">folder</link> gets changed.
2605 <emphasis role="bold">Note:</emphasis> There will be no warning if a
2606 configuration variable
2607 is not defined or is empty. The result will of the expansion will
2613 <sect2 id="configuration-expansion-self">
2614 <title>Self-Defined Variables</title>
2617 Mutt-ng flexibly allows users to define their own variables. To
2618 avoid conflicts with the standard set and to prevent misleading
2619 error messages, there's a reserved namespace for them: all
2620 user-defined variables must be prefixed with <literal>user_</literal> and can be
2621 used just like any ordinary configuration or environment
2626 For example, to view the manual, users can either define two
2627 macros like the following
2633 macro generic <F1> "!less -r /path/to/manual" "Show manual"
2634 macro pager <F1> "!less -r /path/to/manual" "Show manual"</screen>
2639 for <literal>generic</literal>, <literal>pager</literal> and <literal>
2642 .The alternative is to
2643 define a custom variable like so:
2649 set user_manualcmd = "!less -r /path/to_manual"
2650 macro generic <F1> "$user_manualcmd<enter>" "Show manual"
2651 macro pager <F1> "$user_manualcmd<enter>" "Show manual"
2652 macro index <F1> "$user_manualcmd<enter>" "Show manual"</screen>
2657 to re-use the command sequence as in:
2663 macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</screen>
2668 Using this feature, arbitrary sequences can be defined once and
2669 recalled and reused where necessary. More advanced scenarios could
2670 include to save a variable's value at the beginning of macro
2671 sequence and restore it at end.
2675 When the variable is first defined, the first value it gets
2676 assigned is also the initial value to which it can be reset using
2677 the <literal>reset</literal> command.
2681 The complete removal is done via the <literal>unset</literal>
2686 After the following sequence:
2693 set user_foo = 666</screen>
2698 the variable <literal>$user_foo</literal> has a current value
2700 initial of 42. The query
2706 set ?user_foo</screen>
2711 will show 666. After doing the reset via
2717 reset user_foo</screen>
2722 a following query will give 42 as the result. After unsetting it
2729 unset user_foo</screen>
2734 any query or operation (except the noted expansion within other
2735 statements) will lead to an error message.
2740 <sect2 id="configuration-expansion-predef">
2741 <title>Pre-Defined Variables</title>
2744 In order to allow users to share one setup over a number of
2745 different machines without having to change its contents, there's a
2746 number of pre-defined variables. These are prefixed with
2747 <literal>muttng_</literal> and are read-only, i.e. they cannot
2749 reset. The reference chapter lists all available variables.
2753 <emphasis> Please consult the local copy of your manual for their
2754 values as they may differ from different manual sources.
2757 the manual is installed in can be queried (already using such a
2758 variable) by running:
2764 muttng -Q muttng_docdir</screen>
2769 To extend the example for viewing the manual via self-defined
2770 variables, it can be made more readable and more portable by
2771 changing the real path in:
2777 set user_manualcmd = '!less -r /path/to_manual'</screen>
2788 set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</screen>
2793 which works everywhere if a manual is installed.
2797 Please note that by the type of quoting, muttng determines when
2798 to expand these values: when it finds double quotes, the value will
2799 be expanded during reading the setup files but when it finds single
2800 quotes, it'll expand it at runtime as needed.
2804 For example, the statement
2810 folder-hook . "set user_current_folder = $muttng_folder_name"</screen>
2815 will be already be translated to the following when reading the
2822 folder-hook . "set user_current_folder = some_folder"</screen>
2827 with <literal>some_folder</literal> being the name of the
2829 opens. On the contrary,
2835 folder-hook . 'set user_current_folder = $muttng_folder_name'</screen>
2840 will be executed at runtime because of the single quotes so that
2841 <literal>user_current_folder</literal> will always have
2842 the value of the currently
2847 A more practical example is:
2853 folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</screen>
2858 which can be used to source files containing score commands
2859 depending on the folder the user enters.
2864 <sect2 id="configuration-expansion-typeconv">
2865 <title>Type Conversions</title>
2868 A note about variable's types during conversion: internally
2869 values are stored in internal types but for any dump/query or set
2870 operation they're converted to and from string. That means that
2871 there's no need to worry about types when referencing any variable.
2872 As an example, the following can be used without harm (besides
2873 makeing muttng very likely behave strange):
2880 set folder = $read_inc
2881 set read_inc = $folder
2882 set user_magic_number = 42
2883 set folder = $user_magic_number</screen>
2892 <title>Defining/Using aliases</title>
2896 Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>address</emphasis>[ , <emphasis>address</emphasis>, ... ]
2901 It's usually very cumbersome to remember or type out the address of
2903 you are communicating with. Mutt-ng allows you to create ``aliases''
2905 a short string to a full address.
2909 <emphasis role="bold">Note:</emphasis> if you want to create an alias
2910 for a group (by specifying more than
2911 one address), you <emphasis role="bold">must</emphasis> separate the
2912 addresses with a comma (``,'').
2916 To remove an alias or aliases (``*'' means all aliases):
2920 <literal>unalias</literal> [ * | <emphasis>key</emphasis> <emphasis>
2929 alias muttdude me@cs.hmc.edu (Michael Elkins)
2930 alias theguys manny, moe, jack</screen>
2935 Unlike other mailers, Mutt-ng doesn't require aliases to be defined
2936 in a special file. The <literal>alias</literal> command can appear
2938 a configuration file, as long as this file is <link linkend="source">
2941 .Consequently, you can have multiple alias files, or
2942 you can have all aliases defined in your muttrc.
2946 On the other hand, the <link linkend="create-alias">create-alias</link>
2947 function can use only one file, the one pointed to by the <link linkend="alias-file">
2951 <literal>˜/.muttrc</literal> by default). This file is not
2953 in the sense that Mutt-ng will happily append aliases to any file, but
2955 order for the new aliases to take effect you need to explicitly <link linkend="source">
2968 source /usr/local/share/Mutt-ng.aliases
2969 source ~/.mail_aliases
2970 set alias_file=~/.mail_aliases</screen>
2975 To use aliases, you merely use the alias at any place in mutt where
2976 muttprompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>
2980 also enter aliases in your editor at the appropriate headers if you
2982 <link linkend="edit-headers">edit-headers</link> variable set.
2986 In addition, at the various address prompts, you can use the tab
2988 to expand a partial alias to the full alias. If there are multiple
2990 mutt will bring up a menu with the matching aliases. In order to be
2991 presented with the full list of aliases, you must hit tab with out a
2993 alias, such as at the beginning of the prompt or after a comma denoting
2998 In the alias menu, you can select as many aliases as you want with the
2999 <emphasis>select-entry</emphasis> key (default: RET), and use the <emphasis>
3003 (default: q) to return to the address prompt.
3013 <title>Changing the default key bindings</title>
3017 Usage: <literal>bind</literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
3022 This command allows you to change the default key bindings (operation
3023 invoked when pressing a key).
3027 <emphasis>map</emphasis> specifies in which menu the binding belongs.
3029 be specified by separating them with commas (no additional whitespace
3030 isallowed). The currently defined maps are:
3038 <term>generic</term>
3041 This is not a real menu, but is used as a fallback for all of
3043 menus except for the pager and editor modes. If a key is not
3045 another menu, Mutt-ng will look for a binding to use in this
3047 you to bind a key to a certain function in multiple menus
3049 multiple bind statements to accomplish the same task.
3057 The alias menu is the list of your personal aliases as defined
3059 muttrc. It is the mapping from a short alias name to the full
3061 address(es) of the recipient(s).
3069 The attachment menu is used to access the attachments on
3075 <term>browser</term>
3078 The browser is used for both browsing the local directory
3080 listing all of your incoming mailboxes.
3088 The editor is the line-based editor the user enters text data.
3096 The index is the list of messages contained in a mailbox.
3101 <term>compose</term>
3104 The compose menu is the screen used when sending a new message.
3112 The pager is the mode used to display message/attachment data,
3122 The pgp menu is used to select the OpenPGP keys used for
3129 <term>postpone</term>
3132 The postpone menu is similar to the index menu, except is used
3134 recalling a message the user was composing, but saved until
3143 <emphasis>key</emphasis> is the key (or key sequence) you wish to bind.
3145 control character, use the sequence <emphasis>\Cx</emphasis>,
3146 where <emphasis>x</emphasis> is the
3147 letter of the control character (for example, to specify control-A use
3148 ``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
3149 <emphasis>\C</emphasis> is
3150 ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
3153 and <emphasis>\ca</emphasis> are all
3154 equivalent. An alternative form is to specify the key as a three digit
3155 octal number prefixed with a ``\'' (for example <emphasis>
3159 equivalent to <emphasis>\c?</emphasis>).
3163 In addition, <emphasis>key</emphasis> may consist of:
3169 <title>Alternative Key Names</title>
3170 <tgroup cols="2" align="left" colsep="1" rowsep="1">
3173 <entry>Sequence</entry>
3174 <entry>Description</entry>
3178 <row><entry><literal>\t </literal></entry><entry>tab</entry></row>
3179 <row><entry><literal><tab> </literal></entry><entry>tab</entry></row>
3180 <row><entry><literal><backtab> </literal></entry><entry>backtab / shift-tab</entry></row>
3181 <row><entry><literal>\r </literal></entry><entry>carriage return</entry></row>
3182 <row><entry><literal>\n </literal></entry><entry>newline</entry></row>
3183 <row><entry><literal>\e </literal></entry><entry>escape</entry></row>
3184 <row><entry><literal><esc> </literal></entry><entry>escape</entry></row>
3185 <row><entry><literal><up> </literal></entry><entry>up arrow</entry></row>
3186 <row><entry><literal><down> </literal></entry><entry>down arrow</entry></row>
3187 <row><entry><literal><left> </literal></entry><entry>left arrow</entry></row>
3188 <row><entry><literal><right> </literal></entry><entry>right arrow</entry></row>
3189 <row><entry><literal><pageup> </literal></entry><entry>Page Up</entry></row>
3190 <row><entry><literal><pagedown> </literal></entry><entry>Page Down</entry></row>
3191 <row><entry><literal><backspace> </literal></entry><entry>Backspace</entry></row>
3192 <row><entry><literal><delete> </literal></entry><entry>Delete</entry></row>
3193 <row><entry><literal><insert> </literal></entry><entry>Insert</entry></row>
3194 <row><entry><literal><enter> </literal></entry><entry>Enter</entry></row>
3195 <row><entry><literal><return> </literal></entry><entry>Return</entry></row>
3196 <row><entry><literal><home> </literal></entry><entry>Home</entry></row>
3197 <row><entry><literal><end> </literal></entry><entry>End</entry></row>
3198 <row><entry><literal><space> </literal></entry><entry>Space bar</entry></row>
3199 <row><entry><literal><f1> </literal></entry><entry>function key 1</entry></row>
3200 <row><entry><literal><f10> </literal></entry><entry>function key 10</entry></row>
3208 <emphasis>key</emphasis> does not need to be enclosed in quotes unless
3214 <emphasis>function</emphasis> specifies which action to take when <emphasis>
3218 For a complete list of functions, see the <link linkend="functions">
3221 .The special function <literal>noop</literal> unbinds the specified key
3231 <sect1 id="charset-hook">
3232 <title>Defining aliases for character sets</title>
3236 Usage: <literal>charset-hook</literal> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
3237 Usage: <literal>iconv-hook</literal> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
3242 The <literal>charset-hook</literal> command defines an alias for a
3244 This is useful to properly display messages which are tagged with a
3245 character set name not known to mutt.
3249 The <literal>iconv-hook</literal> command defines a system-specific
3251 character set. This is helpful when your systems character
3252 conversion library insists on using strange, system-specific names
3262 <sect1 id="folder-hook">
3263 <title>Setting variables based upon mailbox</title>
3267 Usage: <literal>folder-hook</literal> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
3273 It is often desirable to change settings based on which mailbox you are
3274 reading. The folder-hook command provides a method by which you can
3276 any configuration command. <emphasis>regexp</emphasis> is a regular
3277 expression specifying
3278 in which mailboxes to execute <emphasis>command</emphasis> before
3279 loading. If a mailbox
3280 matches multiple folder-hook's, they are executed in the order given in
3286 <emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut
3287 for <link linkend="spoolfile">spoolfile</link> at the beginning of the
3288 pattern, you must place it
3289 inside of double or single quotes in order to distinguish it from the
3290 logical <emphasis>not</emphasis> operator for the expression.
3294 Note that the settings are <emphasis>not</emphasis> restored when you
3296 For example, a command action to perform is to change the sorting
3297 methodbased upon the mailbox being read:
3303 folder-hook mutt set sort=threads</screen>
3308 However, the sorting method is not restored to its previous value when
3309 reading a different mailbox. To specify a <emphasis>default</emphasis>
3317 folder-hook . set sort=date-sent</screen>
3328 <title>Keyboard macros</title>
3332 Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
3337 Macros are useful when you would like a single key to perform a series
3339 actions. When you press <emphasis>key</emphasis> in menu <emphasis>
3342 ,Mutt-ng will behave as if
3343 you had typed <emphasis>sequence</emphasis>. So if you have a common
3344 sequence of commands
3345 you type, you can create a macro to execute those commands with a
3350 <emphasis>menu</emphasis> is the <link linkend="maps">maps</link> which
3351 the macro will be bound.
3352 Multiple maps may be specified by separating multiple menu arguments by
3353 commas. Whitespace may not be used in between the menu arguments and
3354 thecommas separating them.
3358 <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
3359 by the same rules as the <link linkend="bind">bind</link>. There are
3360 some additions however. The
3361 first is that control characters in <emphasis>sequence</emphasis> can
3363 as <emphasis>ˆx</emphasis>. In order to get a caret (`ˆ'')
3365 <emphasis>ˆˆ</emphasis>. Secondly, to specify a certain key
3366 such as <emphasis>up</emphasis>
3367 or to invoke a function directly, you can use the format
3368 <emphasis><key name></emphasis> and <emphasis><function
3371 .For a listing of key
3372 names see the section on <link linkend="bind">bind</link>. Functions
3373 are listed in the <link linkend="functions">functions</link>.
3377 The advantage with using function names directly is that the macros
3378 willwork regardless of the current key bindings, so they are not
3380 the user having particular key definitions. This makes them more
3381 robustand portable, and also facilitates defining of macros in files
3383 than one user (eg. the system Muttngrc).
3387 Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
3388 which is shown in the help screens.
3392 <emphasis role="bold">Note:</emphasis> Macro definitions (if any)
3393 listed in the help screen(s), are
3394 silently truncated at the screen width, and are not wrapped.
3404 <title>Using color and mono video attributes</title>
3408 Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis><emphasis>background</emphasis> [ <emphasis>regexp</emphasis>]
3409 Usage: <literal>color</literal> index <emphasis>foreground</emphasis> <emphasis>background</emphasis><emphasis>pattern</emphasis>
3410 Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis>[ <emphasis>pattern</emphasis> ... ]
3415 If your terminal supports color, you can spice up Mutt-ng by creating
3417 color scheme. To define the color of an object (type of information),
3419 must specify both a foreground color <emphasis role="bold">and</emphasis> a background color (it is not
3420 possible to only specify one or the other).
3424 <emphasis>object</emphasis> can be one of:
3439 body (match <emphasis>regexp</emphasis> in the body of messages)
3445 bold (highlighting bold patterns in the body of messages)
3451 error (error messages printed by Mutt-ng)
3457 header (match <emphasis>regexp</emphasis> in the message header)
3463 hdrdefault (default color of the message header in the pager)
3469 index (match <emphasis>pattern</emphasis> in the message index)
3475 indicator (arrow or bar used to indicate the current item in a
3482 markers (the ``+'' markers at the beginning of wrapped lines in
3489 message (informational messages)
3501 quoted (text matching <link linkend="quote-regexp">quote-regexp</link> in the body of a message)
3507 quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis>
3508 (higher levels of quoting)
3514 search (highlighting of words in the pager)
3526 status (mode lines used to display info about the mailbox or
3533 tilde (the ``˜'' used to pad blank lines in the pager)
3539 tree (thread tree drawn in the message index and attachment menu)
3545 underline (highlighting underlined patterns in the body of
3555 <emphasis>foreground</emphasis> and <emphasis>background</emphasis> can
3556 be one of the following:
3619 color<emphasis>x</emphasis>
3628 <emphasis>foreground</emphasis> can optionally be prefixed with the
3629 keyword <literal>bright</literal> to make
3630 the foreground color boldfaced (e.g., <literal>brightred</literal>).
3634 If your terminal supports it, the special keyword <emphasis>default</emphasis> can be
3635 used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
3636 If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library,
3637 you also need to set
3638 the <emphasis>COLORFGBG</emphasis> environment variable to the default
3640 terminal for this to work; for example (for Bourne-like shells):
3646 set COLORFGBG="green;black"
3647 export COLORFGBG</screen>
3652 <emphasis role="bold">Note:</emphasis> The <emphasis>S-Lang</emphasis>
3653 library requires you to use the <emphasis>lightgray</emphasis>
3654 and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>
3658 setting this variable.
3662 <emphasis role="bold">Note:</emphasis> The uncolor command can be
3663 applied to the index object only. It
3664 removes entries from the list. You <emphasis role="bold">must</emphasis> specify the same pattern
3665 specified in the color command for it to be removed. The pattern ``*''
3667 a special token which means to clear the color index list of all
3672 Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
3676 <emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">
3679 being the number of colors supported
3680 by your terminal). This is useful when you remap the colors for your
3681 display (for example by changing the color associated with <emphasis>
3684 for your xterm), since color names may then lose their normal meaning.
3688 If your terminal does not support color, it is still possible change
3690 attributes through the use of the ``mono'' command:
3695 Usage: <literal>mono</literal> <emphasis><object> <attribute></emphasis>[ <emphasis>regexp</emphasis> ]
3696 Usage: <literal>mono</literal> index <emphasis>attribute</emphasis> <emphasis>pattern</emphasis>
3697 Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis>[ <emphasis>pattern</emphasis> ... ]
3702 where <emphasis>attribute</emphasis> is one of the following:
3750 <title>Ignoring (weeding) unwanted message headers</title>
3754 Usage: <literal>[un]ignore</literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>... ]
3759 Messages often have many header fields added by automatic processing
3761 or which may not seem useful to display on the screen. This command
3763 you to specify header fields which you don't normally want to see.
3767 You do not need to specify the full header field name. For example,
3768 ``ignore content-'' will ignore all header fields that begin with the
3770 ``content-''. ``ignore *'' will ignore all headers.
3774 To remove a previously added token from the list, use the ``unignore''
3776 The ``unignore'' command will make Mutt-ng display headers with the
3778 For example, if you do ``ignore x-'' it is possible to ``unignore
3783 ``unignore *'' will remove all tokens from the ignore list.
3790 # Sven's draconian header weeding
3792 unignore from date subject to cc
3793 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
3794 unignore posted-to:</screen>
3804 <sect1 id="alternates">
3805 <title>Alternative addresses</title>
3808 Usage: <literal>[un]alternates</literal> <emphasis>regexp</emphasis> [ <emphasis>
3816 With various functions, mutt will treat messages differently,
3817 depending on whether you sent them or whether you received them from
3818 someone else. For instance, when replying to a message that you
3819 sent to a different party, mutt will automatically suggest to send
3820 the response to the original message's recipients--responding to
3821 yourself won't make much sense in many cases. (See <link linkend="reply-to">
3828 Many users receive e-mail under a number of different addresses. To
3829 fully use mutt's features here, the program must be able to
3830 recognize what e-mail addresses you receive mail under. That's the
3831 purpose of the <literal>alternates</literal> command: It takes a list
3833 expressions, each of which can identify an address under which you
3838 The <literal>unalternates</literal> command can be used to write
3840 <literal>alternates</literal> patterns. If an address matches something
3842 <literal>alternates</literal> command, but you nonetheless do not think
3844 from you, you can list a more precise pattern under an <literal>
3851 To remove a regular expression from the <literal>alternates</literal>
3853 <literal>unalternates</literal> command with exactly the same <emphasis>
3857 Likewise, if the <emphasis>regexp</emphasis> for a <literal>alternates</literal> command matches
3858 an entry on the <literal>unalternates</literal> list, that <literal>
3861 entry will be removed. If the <emphasis>regexp</emphasis> for <literal>
3864 is ``*'', <emphasis>all entries</emphasis> on <literal>alternates</literal> will be removed.
3873 <sect1 id="format-flowed">
3874 <title>Format = Flowed</title>
3876 <sect2 id="format-flowed-intro">
3877 <title>Introduction</title>
3880 Mutt-ng contains support for so-called <literal>format=flowed</literal> messages.
3881 In the beginning of email, each message had a fixed line width, and
3882 it was enough for displaying them on fixed-size terminals. But times
3883 changed, and nowadays hardly anybody still uses fixed-size terminals:
3884 more people nowaydays use graphical user interfaces, with dynamically
3885 resizable windows. This led to the demand of a new email format that
3886 makes it possible for the email client to make the email look nice
3887 in a resizable window without breaking quoting levels and creating
3888 an incompatible email format that can also be displayed nicely on
3889 old fixed-size terminals.
3893 For introductory information on <literal>format=flowed</literal>
3895 <ulink URL="http://www.joeclark.org/ffaq.html"><http://www.joeclark.org/ffaq.html></ulink>.
3900 <sect2 id="format-flowed-display">
3901 <title>Receiving: Display Setup</title>
3904 When you receive emails that are marked as <literal>format=flowed</literal>
3905 messages, and is formatted correctly, mutt-ng will try to reformat
3906 the message to optimally fit on your terminal. If you want a fixed
3907 margin on the right side of your terminal, you can set the
3914 set wrapmargin = 10</screen>
3919 The code above makes the line break 10 columns before the right
3920 side of the terminal.
3924 If your terminal is so wide that the lines are embarrassingly long,
3925 you can also set a maximum line length:
3931 set max_line_length = 120</screen>
3936 The example above will give you lines not longer than 120
3941 When you view at <literal>format=flowed</literal> messages, you will
3943 the quoting hierarchy like in the following example:
3949 >Bill, can you please send last month's progress report to Mr.
3950 >Morgan? We also urgently need the cost estimation for the new
3951 >production server that we want to set up before our customer's
3952 >project will go live.</screen>
3957 This obviously doesn't look very nice, and it makes it very
3958 hard to differentiate between text and quoting character. The
3959 solution is to configure mutt-ng to "stuff" the quoting:
3965 set stuff_quoted</screen>
3970 This will lead to a nicer result that is easier to read:
3976 > Bill, can you please send last month's progress report to Mr.
3977 > Morgan? We also urgently need the cost estimation for the new
3978 > production server that we want to set up before our customer's
3979 > project will go live.</screen>
3985 <sect2 id="format-flowed-send">
3986 <title>Sending</title>
3989 If you want mutt-ng to send emails with <literal>format=flowed</literal> set, you
3990 need to explicitly set it:
3996 set text_flowed</screen>
4001 Additionally, you have to use an editor which supports writing
4002 <literal>format=flowed</literal>-conforming emails. For vim, this is
4004 adding <literal>w</literal> to the formatoptions (see <literal>:h
4008 <literal>:h fo-table</literal>) when writing emails.
4012 Also note that <emphasis>format=flowed</emphasis> knows about
4014 that is, when sending messages, some kinds of lines have to be
4015 indented with a single space on the sending side. On the receiving
4016 side, the first space (if any) is removed. As a consequence and in
4017 addition to the above simple setting, please keep this in mind when
4018 making manual formattings within the editor. Also note that mutt-ng
4019 currently violates the standard (RfC 3676) as it does not
4020 space-stuff lines starting with:
4029 <literal>></literal> This is <emphasis>not</emphasis> the
4030 quote character but a right
4031 angle used for other reasons
4038 <literal>From</literal> with a trailing space.
4045 just a space for formatting reasons
4055 Please make sure that you manually prepend a space to each of them.
4060 <sect2 id="format-flowed-notes">
4061 <title>Additional Notes</title>
4064 For completeness, the <link linkend="delete-space">delete-space</link> variable provides the mechanism
4065 to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
4069 According to the standard, clients receiving a <literal>format=flowed</literal>
4070 messages should delete the last space of a flowed line but still
4071 interpret the line as flowed. Because flowed lines usually contain
4072 only one space at the end, this parameter would make the receiving
4073 client concatenate the last word of the previous with the first of
4074 the current line <emphasis>without</emphasis> a space. This makes
4076 unreadable and is intended for languages rarely using spaces. So
4077 please use this setting only if you're sure what you're doing.
4089 <title>Mailing lists</title>
4093 Usage: <literal>[un]lists</literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>... ]
4094 Usage: <literal>[un]subscribe</literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>... ]
4099 Mutt-ng has a few nice features for <link linkend="using-lists">
4102 .In order to take advantage of them, you must
4103 specify which addresses belong to mailing lists, and which mailing
4104 lists you are subscribed to. Once you have done this, the <link linkend="func-list-reply">
4107 function will work for all known lists.
4108 Additionally, when you send a message to a subscribed list, mutt will
4109 add a Mail-Followup-To header to tell other users' mail user agents
4110 not to send copies of replies to your personal address. Note that
4111 the Mail-Followup-To header is a non-standard extension which is not
4112 supported by all mail user agents. Adding it is not bullet-proof
4114 receiving personal CCs of list messages. Also note that the generation
4115 of the Mail-Followup-To header is controlled by the <link linkend="followup-to">
4118 configuration variable.
4122 More precisely, Mutt-ng maintains lists of patterns for the addresses
4123 of known and subscribed mailing lists. Every subscribed mailing
4124 list is known. To mark a mailing list as known, use the ``lists''
4125 command. To mark it as subscribed, use ``subscribe''.
4129 You can use regular expressions with both commands. To mark all
4130 messages sent to a specific bug report's address on mutt's bug
4131 tracking system as list mail, for instance, you could say
4132 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
4133 give a portion of the list's e-mail address.
4137 Specify as much of the address as you need to to remove ambiguity. For
4138 example, if you've subscribed to the Mutt-ng mailing list, you will
4140 addressed to <emphasis>mutt-users@mutt.org</emphasis>. So, to tell
4141 Mutt-ng that this is a
4142 mailing list, you could add ``lists mutt-users'' to your
4143 initialization file. To tell mutt that you are subscribed to it,
4144 add ``subscribe mutt-users'' to your initialization file instead.
4145 If you also happen to get mail from someone whose address is
4146 <emphasis>mutt-users@example.com</emphasis>, you could use ``lists
4147 mutt-users@mutt\\.org''
4148 or ``subscribe mutt-users@mutt\\.org'' to
4149 match only mail from the actual list.
4153 The ``unlists'' command is used to remove a token from the list of
4154 known and subscribed mailing-lists. Use ``unlists *'' to remove all
4159 To remove a mailing list from the list of subscribed mailing lists,
4160 but keep it on the list of known mailing lists, use ``unsubscribe''.
4169 <sect1 id="mbox-hook">
4170 <title>Using Multiple spool mailboxes</title>
4174 Usage: <literal>mbox-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4179 This command is used to move read messages from a specified mailbox to
4180 adifferent mailbox automatically when you quit or change folders.
4181 <emphasis>pattern</emphasis> is a regular expression specifying the
4182 mailbox to treat as a
4183 ``spool'' mailbox and <emphasis>mailbox</emphasis> specifies where mail
4184 should be saved when
4189 Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>
4193 pattern is used (it is not possible to save read mail in more than a
4204 <sect1 id="mailboxes">
4205 <title>Defining mailboxes which receive mail</title>
4209 Usage: <literal>[un]mailboxes</literal> [!]<emphasis>filename</emphasis>[ <emphasis>filename</emphasis> ... ]
4214 This command specifies folders which can receive mail and
4215 which will be checked for new messages. By default, the
4216 main menu status bar displays how many of these folders have
4221 When changing folders, pressing <emphasis>space</emphasis> will cycle
4222 through folders with new mail.
4226 Pressing TAB in the directory browser will bring up a menu showing the
4228 specified by the <literal>mailboxes</literal> command, and indicate
4230 messages. Mutt-ng will automatically enter this mode when invoked from
4232 command line with the <literal>-y</literal> option.
4236 The ``unmailboxes'' command is used to remove a token from the list
4237 of folders which receive mail. Use ``unmailboxes *'' to remove all
4242 <emphasis role="bold">Note:</emphasis> new mail is detected by
4243 comparing the last modification time to
4244 the last access time. Utilities like <literal>biff</literal> or <literal>
4248 program which accesses the mailbox might cause Mutt-ng to never detect
4250 for that mailbox if they do not properly reset the access time. Backup
4251 tools are another common reason for updated access times.
4255 <emphasis role="bold">Note:</emphasis> the filenames in the <literal>
4258 command are resolved when
4259 the command is executed, so if these names contain <link linkend="shortcuts">
4262 (such as ``='' and ``!''), any variable
4263 definition that affect these characters (like <link linkend="folder">
4266 and <link linkend="spoolfile">spoolfile</link>)
4267 should be executed before the <literal>mailboxes</literal> command.
4277 <title>User defined headers</title>
4281 Usage: <literal>my_hdr</literal> <emphasis>string</emphasis>
4282 Usage: <literal>unmy_hdr</literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis>... ]
4287 The ``my_hdr'' command allows you to create your own header
4288 fields which will be added to every message you send.
4292 For example, if you would like to add an ``Organization:'' header field
4294 all of your outgoing messages, you can put the command
4299 my_hdr Organization: A Really Big Company, Anytown, USA</screen>
4303 in your <literal>.muttrc</literal>.
4307 <emphasis role="bold">Note:</emphasis> space characters are <emphasis>
4310 allowed between the keyword and
4311 the colon (``:''). The standard for electronic mail (RFC822) says that
4312 space is illegal there, so Mutt-ng enforces the rule.
4316 If you would like to add a header field to a single message, you should
4317 either set the <link linkend="edit-headers">edit-headers</link>
4319 or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
4321 that you can edit the header of your message along with the body.
4325 To remove user defined header fields, use the ``unmy_hdr''
4326 command. You may specify an asterisk (``*'') to remove all header
4327 fields, or the fields to remove. For example, to remove all ``To'' and
4328 ``Cc'' header fields, you could use:
4333 unmy_hdr to cc</screen>
4342 <sect1 id="hdr-order">
4343 <title>Defining the order of headers when viewing messages</title>
4347 Usage: <literal>hdr_order</literal> <emphasis>header1</emphasis><emphasis>header2</emphasis> <emphasis>header3</emphasis>
4352 With this command, you can specify an order in which mutt will attempt
4353 to present headers to you when viewing messages.
4357 ``unhdr_order *'' will clear all previous headers from the order
4359 thus removing the header order effects set by the system-wide startup
4366 hdr_order From Date: From: To: Cc: Subject:</screen>
4376 <sect1 id="save-hook">
4377 <title>Specify default save filename</title>
4381 Usage: <literal>save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
4386 This command is used to override the default filename used when saving
4387 messages. <emphasis>filename</emphasis> will be used as the default
4388 filename if the message is
4389 <emphasis>From:</emphasis> an address matching <emphasis>regexp</emphasis> or if you are the author and the
4390 message is addressed <emphasis>to:</emphasis> something matching <emphasis>
4397 See <link linkend="pattern-hook">pattern-hook</link> for information on
4398 the exact format of <emphasis>pattern</emphasis>.
4408 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
4409 save-hook aol\\.com$ +spam</screen>
4414 Also see the <link linkend="fcc-save-hook">fcc-save-hook</link>
4424 <sect1 id="fcc-hook">
4425 <title>Specify default Fcc: mailbox when composing</title>
4429 Usage: <literal>fcc-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4434 This command is used to save outgoing mail in a mailbox other than
4435 <link linkend="record">record</link>. Mutt-ng searches the initial
4437 message recipients for the first matching <emphasis>regexp</emphasis>
4438 and uses <emphasis>mailbox</emphasis>
4439 as the default Fcc: mailbox. If no match is found the message will be
4441 to <link linkend="record">record</link> mailbox.
4445 See <link linkend="pattern-hook">pattern-hook</link> for information on
4446 the exact format of <emphasis>pattern</emphasis>.
4450 Example: <literal>fcc-hook [@.]aol\\.com$
4456 The above will save a copy of all messages going to the aol.com domain
4458 the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook">
4470 <sect1 id="fcc-save-hook">
4471 <title>Specify default save filename and default Fcc: mailbox at once</title>
4475 Usage: <literal>fcc-save-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4480 This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook">
4483 and a <link linkend="save-hook">save-hook</link> with its arguments.
4492 <sect1 id="send-hook">
4493 <title>Change settings based upon message recipients</title>
4495 <anchor id="reply-hook"/>
4498 Usage: <literal>reply-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4499 Usage: <literal>send-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4500 Usage: <literal>send2-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4505 These commands can be used to execute arbitrary configuration commands
4507 upon recipients of the message. <emphasis>pattern</emphasis> is a
4509 matching the desired address. <emphasis>command</emphasis> is executed
4510 when <emphasis>regexp</emphasis>
4511 matches recipients of the message.
4515 <literal>reply-hook</literal> is matched against the message you are <emphasis>
4518 <emphasis role="bold">to</emphasis>, instead of the message you are <emphasis>
4521 .<literal>send-hook</literal> is
4522 matched against all messages, both <emphasis>new</emphasis> and <emphasis>
4525 .<emphasis role="bold">Note:</emphasis>
4526 <literal>reply-hook</literal>s are matched <emphasis role="bold">before</emphasis> the <literal>
4529 ,<emphasis role="bold">regardless</emphasis>
4530 of the order specified in the users's configuration file.
4534 <literal>send2-hook</literal> is matched every time a message is
4536 by editing it, or by using the compose menu to change its recipients
4537 or subject. <literal>send2-hook</literal> is executed after <literal>
4541 can, e.g., be used to set parameters such as the <link linkend="sendmail">
4544 variable depending on the message's sender
4549 For each type of <literal>send-hook</literal> or <literal>reply-hook</literal>, when multiple matches
4550 occur, commands are executed in the order they are specified in the
4552 (for that type of hook).
4556 See <link linkend="pattern-hook">pattern-hook</link> for information on
4557 the exact format of <emphasis>pattern</emphasis>.
4561 Example: <literal>send-hook mutt "set mime_forward
4567 Another typical use for this command is to change the values of the
4568 <link linkend="attribution">attribution</link>, <link linkend="signature">
4571 and <link linkend="locale">locale</link>
4572 variables in order to change the language of the attributions and
4573 signatures based upon the recipients.
4577 <emphasis role="bold">Note:</emphasis> the send-hook's are only
4578 executed ONCE after getting the initial
4579 list of recipients. Adding a recipient after replying or editing the
4580 message will NOT cause any send-hook to be executed. Also note that
4581 my_hdr commands which modify recipient headers, or the message's
4582 subject, don't have any effect on the current message when executed
4592 <sect1 id="message-hook">
4593 <title>Change settings before formatting a message</title>
4597 Usage: <literal>message-hook</literal> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4602 This command can be used to execute arbitrary configuration commands
4603 before viewing or formatting a message based upon information about the
4605 <emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be
4606 displayed. When multiple matches occur, commands are executed in the
4608 they are specified in the muttrc.
4612 See <link linkend="pattern-hook">pattern-hook</link> for
4613 information on the exact format of <emphasis>pattern</emphasis>.
4620 message-hook ~A 'set pager=builtin'
4621 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</screen>
4631 <sect1 id="crypt-hook">
4632 <title>Choosing the cryptographic key of the recipient</title>
4636 Usage: <literal>crypt-hook</literal> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
4641 When encrypting messages with PGP or OpenSSL, you may want to associate
4643 key with a given e-mail address automatically, either because the
4644 recipient's public key can't be deduced from the destination address,
4645 or because, for some reasons, you need to override the key Mutt-ng
4646 wouldnormally use. The crypt-hook command provides a method by which
4648 specify the ID of the public key to be used when encrypting messages to
4649 a certain recipient.
4653 The meaning of "key id" is to be taken broadly in this context: You
4654 can either put a numerical key ID here, an e-mail address, or even
4665 <title>Adding key sequences to the keyboard buffer</title>
4669 Usage: <literal>push</literal> <emphasis>string</emphasis>
4675 This command adds the named string to the keyboard buffer. The
4676 string may contain control characters, key names and function
4677 names like the sequence string in the <link
4678 linkend="macro">macro</link> command. You may use it to
4679 automatically run a sequence of commands at startup, or when
4680 entering certain folders. For example, the following command
4681 will automatically collapse all threads when entering a folder:
4684 folder-hook . 'push <collapse-all>'
4696 <title>Executing functions</title>
4700 Usage: <literal>exec</literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
4705 This command can be used to execute any function. Functions are
4706 listed in the <link linkend="functions">functions</link>.
4707 ``exec function'' is equivalent to ``push <function>''.
4716 <sect1 id="score-command">
4717 <title>Message Scoring</title>
4721 Usage: <literal>score</literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
4722 Usage: <literal>unscore</literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>... ]
4727 In situations where you have to cope with a lot of emails, e.g.
4728 when you read many different mailing lists, and take part in
4729 discussions, it is always useful to have the important messages
4730 marked and the annoying messages or the ones that you aren't
4731 interested in deleted. For this purpose, mutt-ng features a
4732 mechanism called ``scoring''.
4736 When you use scoring, every message has a base score of 0. You
4737 can then use the <literal>score</literal> command to define patterns
4739 positive or negative value associated with it. When a pattern
4740 matches a message, the message's score will be raised or lowered by
4741 the amount of the value associated with the pattern.
4747 score "~f nion@muttng\.org" 50
4748 score "~f @sco\.com" -100</screen>
4753 If the pattern matches, it is also possible to set the score
4754 value of the current message to a certain value and then stop
4761 score "~f santaclaus@northpole\.int" =666</screen>
4766 What is important to note is that negative score values will be
4771 To make scoring actually useful, the score must be applied in
4772 some way. That's what the <emphasis>score thresholds</emphasis> are
4774 there are three score thresholds:
4783 flag threshold: when a message has a score value equal or higher
4784 than the flag threshold, it will be flagged.
4791 read threshold: when a message has a score value equal or lower
4792 than the read threshold, it will be marked as read.
4799 delete threshold: when a message has a score value equal or
4800 lower than the delete threshold, it will be marked as deleted.
4810 These three thresholds can be set via the variables <link linkend="score-threshold-flag">
4811 score-threshold-flag
4813 ,<link linkend="score-threshold-read">score-threshold-read</link>, <link linkend="score-threshold-delete">
4814 score-threshold-delete
4817 default, <link linkend="score-threshold-read">score-threshold-read</link> and <link linkend="score-threshold-delete">
4818 score-threshold-delete
4821 <literal>-1</literal>, which means that in the default threshold
4823 message will ever get marked as read or deleted.
4827 Scoring gets especially interesting when combined with the <literal>
4831 and the <literal>˜n</literal> pattern:
4837 color index black yellow "~n 10-"
4838 color index red yellow "~n 100-"</screen>
4843 The rules above mark all messages with a score between 10 and 99
4844 with black and yellow, and messages with a score greater or equal
4845 100 with red and yellow. This might be unusual to you if you're used
4846 to e.g. slrn's scoring mechanism, but it is more flexible, as it
4847 visually marks different scores.
4857 <title>Spam detection</title>
4861 Usage: <literal>spam</literal> <emphasis>pattern</emphasis> <emphasis>format </emphasis>
4862 Usage: <literal>nospam</literal> <emphasis>pattern</emphasis>
4867 Mutt-ng has generalized support for external spam-scoring filters.
4868 By defining your spam patterns with the <literal>spam</literal> and <literal>
4871 commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>
4875 mail based on its spam attributes, as determined by the external
4876 filter. You also can display the spam attributes in your index
4877 display using the <literal>%H</literal> selector in the <link linkend="index-format">
4880 variable. (Tip: try <literal>%?H?[%H] ?</literal>
4881 to display spam tags only when they are defined for a given message.)
4885 Your first step is to define your external filter's spam patterns using
4886 the <literal>spam</literal> command. <emphasis>pattern</emphasis>
4887 should be a regular expression
4888 that matches a header in a mail message. If any message in the mailbox
4889 matches this regular expression, it will receive a ``spam tag'' or
4890 ``spam attribute'' (unless it also matches a <literal>nospam</literal>
4892 below.) The appearance of this attribute is entirely up to you, and is
4893 governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static
4894 text, but it also can include back-references from the <emphasis>
4897 expression. (A regular expression ``back-reference'' refers to a
4898 sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
4899 the first back-reference in the regex, <literal>%2</literal>
4900 with the second, etc.
4904 If you're using multiple spam filters, a message can have more than
4905 one spam-related header. You can define <literal>spam</literal>
4907 filter you use. If a message matches two or more of these patterns, and
4908 the $spam_separator variable is set to a string, then the
4909 message's spam tag will consist of all the <emphasis>format</emphasis>
4911 together, with the value of $spam_separator separating
4916 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
4917 define these spam settings:
4920 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
4921 spam "X-Spam-Status: Yes" "90+/SA"
4922 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
4923 set spam_separator=", "</screen>
4928 If I then received a message that DCC registered with ``many'' hits
4929 under the ``Fuz2'' checksum, and that PureMessage registered with a
4930 97% probability of being spam, that message's spam tag would
4931 read<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
4933 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
4937 If the $spam_separator variable is unset, then each
4938 spam pattern match supersedes the previous one. Instead of getting
4939 joined <emphasis>format</emphasis> strings, you'll get only the last
4944 The spam tag is what will be displayed in the index when you use
4945 <literal>%H</literal> in the <literal>
4946 $index_format
4948 variable. It's also the
4949 string that the <literal>˜H</literal> pattern-matching expression
4951 <emphasis>search</emphasis> and <emphasis>limit</emphasis> functions.
4952 And it's what sorting by spam
4953 attribute will use as a sort key.
4957 That's a pretty complicated example, and most people's actual
4958 environments will have only one spam filter. The simpler your
4959 configuration, the more effective mutt can be, especially when it comes
4964 Generally, when you sort by spam tag, mutt will sort <emphasis>
4968 that is, by ordering strings alphnumerically. However, if a spam tag
4969 begins with a number, mutt will sort numerically first, and lexically
4970 only when two numbers are equal in value. (This is like UNIX's
4971 <literal>sort -n</literal>.) A message with no spam attributes at all
4973 that didn't match <emphasis>any</emphasis> of your <literal>spam</literal> patterns -- is sorted at
4974 lowest priority. Numbers are sorted next, beginning with 0 and ranging
4975 upward. Finally, non-numeric strings are sorted, with ``a'' taking
4976 lowerpriority than ``z''. Clearly, in general, sorting by spam tags is
4978 effective when you can coerce your filter to give you a raw number. But
4979 in case you can't, mutt can still do something useful.
4983 The <literal>nospam</literal> command can be used to write exceptions
4984 to <literal>spam</literal>
4985 patterns. If a header pattern matches something in a <literal>spam</literal> command,
4986 but you nonetheless do not want it to receive a spam tag, you can list
4987 amore precise pattern under a <literal>nospam</literal> command.
4991 If the <emphasis>pattern</emphasis> given to <literal>nospam</literal>
4992 is exactly the same as the
4993 <emphasis>pattern</emphasis> on an existing <literal>spam</literal>
4994 list entry, the effect will be to
4995 remove the entry from the spam list, instead of adding an exception.
4996 Likewise, if the <emphasis>pattern</emphasis> for a <literal>spam</literal> command matches an entry
4997 on the <literal>nospam</literal> list, that <literal>nospam</literal>
4998 entry will be removed. If the
4999 <emphasis>pattern</emphasis> for <literal>nospam</literal> is ``*'', <emphasis>
5000 all entries on both lists
5002 will be removed. This might be the default action if you use <literal>
5005 and <literal>nospam</literal> in conjunction with a <literal>
5012 You can have as many <literal>spam</literal> or <literal>nospam</literal> commands as you like.
5013 You can even do your own primitive spam detection within mutt -- for
5014 example, if you consider all mail from <literal>MAILER-DAEMON</literal>
5016 you can use a <literal>spam</literal> command like this:
5022 spam "^From: .*MAILER-DAEMON" "999"</screen>
5033 <title>Setting variables</title>
5037 Usage: <literal>set</literal> [no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>] [ <emphasis>variable</emphasis> ... ]
5038 Usage: <literal>toggle</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>... ]
5039 Usage: <literal>unset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>... ]
5040 Usage: <literal>reset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>... ]
5046 This command is used to set (and unset) <link linkend="variables">
5049 .There are four basic types of variables:
5050 boolean, number, string and quadoption. <emphasis>boolean</emphasis>
5052 <emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false).
5053 <emphasis>number</emphasis> variables can be
5054 assigned a positive integer value.
5058 <emphasis>string</emphasis> variables consist of any number of
5059 printable characters.
5060 <emphasis>strings</emphasis> must be enclosed in quotes if they contain
5062 may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
5066 newline and tab, respectively.
5070 <emphasis>quadoption</emphasis> variables are used to control whether
5071 or not to be prompted
5072 for certain actions, or to specify a default action. A value of <emphasis>
5075 will cause the action to be carried out automatically as if you had
5077 yes to the question. Similarly, a value of <emphasis>no</emphasis>
5079 action to be carried out as if you had answered ``no.'' A value of
5080 <emphasis>ask-yes</emphasis> will cause a prompt with a default answer
5082 <emphasis>ask-no</emphasis> will provide a default answer of ``no.''
5086 Prefixing a variable with ``no'' will unset it. Example: <literal>set
5093 For <emphasis>boolean</emphasis> variables, you may optionally prefix
5094 the variable name with
5095 <literal>inv</literal> to toggle the value (on or off). This is useful
5097 macros. Example: <literal>set invsmart_wrap</literal>.
5101 The <literal>toggle</literal> command automatically prepends the <literal>
5105 specified variables.
5109 The <literal>unset</literal> command automatically prepends the <literal>
5113 specified variables.
5117 Using the enter-command function in the <emphasis>index</emphasis>
5118 menu, you can query the
5119 value of a variable by prefixing the name of the variable with a
5127 set ?allow_8bit</screen>
5132 The question mark is actually only required for boolean and quadoption
5137 The <literal>reset</literal> command resets all given variables to the
5139 defaults (hopefully mentioned in this manual). If you use the command
5140 <literal>set</literal> and prefix the variable with ``&'' this has
5142 behavior as the reset command.
5146 With the <literal>reset</literal> command there exists the special
5148 which allows you to reset all variables to their system defaults.
5158 <title>Reading initialization commands from another file</title>
5162 Usage: <literal>source</literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis>... ]
5167 This command allows the inclusion of initialization commands
5168 from other files. For example, I place all of my aliases in
5169 <literal>˜/.mail_aliases</literal> so that I can make my
5170 <literal>˜/.muttrc</literal> readable and keep my aliases
5175 If the filename begins with a tilde (``˜''), it will be expanded
5177 path of your home directory.
5181 If the filename ends with a vertical bar (|), then <emphasis>
5185 considered to be an executable program from which to read input (eg.
5186 <literal>source ˜/bin/myscript|</literal>).
5196 <title>Removing hooks</title>
5200 Usage: <literal>unhook</literal> [ * | <emphasis>hook-type</emphasis> ]
5205 This command permits you to flush hooks you have previously defined.
5206 You can either remove all hooks by giving the ``*'' character as an
5207 argument, or you can remove all hooks of a specific type by saying
5208 something like <literal>unhook send-hook</literal>.
5218 <title>Sharing Setups</title>
5220 <sect2 id="share-charset">
5221 <title>Character Sets</title>
5224 As users may run mutt-ng on different systems, the configuration
5225 must be maintained because it's likely that people want to use the
5226 setup everywhere they use mutt-ng. And mutt-ng tries to help where it
5231 To not produce conflicts with different character sets, mutt-ng
5232 allows users to specify in which character set their configuration
5233 files are encoded. Please note that while reading the configuration
5234 files, this is only respected after the corresponding declaration
5235 appears. It's advised to put the following at the very beginning of a
5242 set config_charset = "..."</screen>
5247 and replacing the dots with the actual character set. To avoid
5248 problems while maintaining the setup, vim user's may want to use
5249 modelines as show in:
5255 # vim:fileencoding=...:</screen>
5260 while, again, replacing the dots with the appropriate name. This
5261 tells vim as which character set to read and save the file.
5270 <sect2 id="share-modularization">
5271 <title>Modularization</title>
5274 ``Modularization'' means to divide the setup into several files
5275 while sorting the options or commands by topic. Especially for
5276 longer setups (e.g. with many hooks), this helps maintaining it
5277 and solving trouble.
5281 When using separation, setups may be, as a whole or in
5282 fractions, shared over different systems.
5291 <sect2 id="share-conditional">
5292 <title>Conditional parts</title>
5295 When using a configuration on different systems, the user may not
5296 always have influence on how mutt-ng is installed and which features
5301 To solve this, mutt-ng contain a feature based on the ``ifdef''
5302 patch written for mutt. Its basic syntax is:
5308 ifdef <item> <command>
5309 ifndef <item> <command></screen>
5314 ...whereby <literal><item></literal> can be one of:
5354 All available functions, variables and menus are documented
5355 elsewhere in this manual but ``features'' is specific to these
5356 two commands. To test for one, prefix one of the following
5357 keywords with <literal>feature_</literal>: ncurses,
5358 slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
5359 gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
5360 classic_smime, gpgme, header_cache
5364 As an example, one can use the following in
5365 <literal>˜/.muttngrc</literal>:
5371 ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
5372 ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
5373 ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</screen>
5378 ...to only source <literal>˜/.mutt-ng/setup-imap</literal> if
5380 support is built in, only source <literal>˜/.mutt-ng/setup-pop</literal>
5381 if POP support is built in and only source
5382 <literal>˜/.mutt-ng/setup-nntp</literal> if NNTP support is
5387 An example for testing for variable names can be used if users
5388 use different revisions of mutt-ng whereby the older one may not
5389 have a certain variable. To test for the availability of <link linkend="imap-mail-check">
5399 ifdef imap_mail_check 'set imap_mail_check = 300'</screen>
5404 Provided for completeness is the test for menu names. To set <link linkend="pager-index-lines">
5408 menu is available, use:
5414 ifdef pager 'set pager_index_lines = 10'</screen>
5419 For completeness, too, the opposite of <literal>ifdef</literal> is
5421 <literal>ifndef</literal> which only executes the command if the test
5423 example, the following two examples are equivalent:
5429 ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
5430 ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</screen>
5441 ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
5442 ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</screen>
5458 <sect1 id="vars-obsolete">
5459 <title>Obsolete Variables</title>
5462 In the process of ensuring and creating more consistency, many
5463 variables have been renamed and some of the old names were already
5464 removed. Please see <link linkend="sect-obsolete">sect-obsolete</link>
5465 for a complete list.
5481 <chapter id="advanced-usage"> <!--{{{-->
5482 <title>Advanced Usage</title>
5484 <sect1 id="advanced-regexp">
5485 <title>Regular Expressions</title>
5488 All string patterns in Mutt-ng including those in more complex
5489 <link linkend="tab-patterns">patterns</link> must be specified
5490 using regular expressions (regexp) in the ``POSIX extended'' syntax
5492 is more or less the syntax used by egrep and GNU awk). For your
5493 convenience, we have included below a brief description of this syntax.
5497 The search is case sensitive if the pattern contains at least one upper
5498 case letter, and case insensitive otherwise. Note that ``\''
5499 must be quoted if used for a regular expression in an initialization
5500 command: ``\\''.
5504 A regular expression is a pattern that describes a set of strings.
5505 Regular expressions are constructed analogously to arithmetic
5506 expressions, by using various operators to combine smaller expressions.
5510 Note that the regular expression can be enclosed/delimited by either
5512 or ' which is useful if the regular expression includes a white-space
5513 character. See <link linkend="configuration-syntax">muttrc-syntax</link>
5514 for more information on " and ' delimiter processing. To match a
5515 literal " or ' you must preface it with \ (backslash).
5519 The fundamental building blocks are the regular expressions that match
5520 a single character. Most characters, including all letters and digits,
5521 are regular expressions that match themselves. Any metacharacter with
5522 special meaning may be quoted by preceding it with a backslash.
5526 The period ``.'' matches any single character. The caret ``ˆ''
5527 andthe dollar sign ``$'' are metacharacters that respectively
5529 the empty string at the beginning and end of a line.
5533 A list of characters enclosed by ``['' and ``]'' matches any
5534 single character in that list; if the first character of the list
5535 is a caret ``ˆ'' then it matches any character <emphasis role="bold">
5539 list. For example, the regular expression <emphasis role="bold">
5540 [0123456789]
5542 matches any single digit. A range of ASCII characters may be specified
5543 by giving the first and last characters, separated by a hyphen
5544 ``-''. Most metacharacters lose their special meaning inside
5545 lists. To include a literal ``]'' place it first in the list.
5546 Similarly, to include a literal ``ˆ'' place it anywhere but first.
5547 Finally, to include a literal hyphen ``-'' place it last.
5551 Certain named classes of characters are predefined. Character classes
5552 consist of ``[:'', a keyword denoting the class, and ``:]''.
5553 The following classes are defined by the POSIX standard:
5560 <term>[:alnum:]</term>
5563 Alphanumeric characters.
5568 <term>[:alpha:]</term>
5571 Alphabetic characters.
5576 <term>[:blank:]</term>
5579 Space or tab characters.
5584 <term>[:cntrl:]</term>
5592 <term>[:digit:]</term>
5600 <term>[:graph:]</term>
5603 Characters that are both printable and visible. (A space is
5605 but not visible, while an ``a'' is both.)
5610 <term>[:lower:]</term>
5613 Lower-case alphabetic characters.
5618 <term>[:print:]</term>
5621 Printable characters (characters that are not control
5627 <term>[:punct:]</term>
5630 Punctuation characters (characters that are not letter, digits,
5632 characters, or space characters).
5637 <term>[:space:]</term>
5640 Space characters (such as space, tab and formfeed, to name a
5646 <term>[:upper:]</term>
5649 Upper-case alphabetic characters.
5654 <term>[:xdigit:]</term>
5657 Characters that are hexadecimal digits.
5665 A character class is only valid in a regular expression inside the
5666 brackets of a character list. Note that the brackets in these
5667 class names are part of the symbolic names, and must be included
5668 in addition to the brackets delimiting the bracket list. For
5669 example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
5670 <emphasis role="bold">[0-9]</emphasis>.
5674 Two additional special sequences can appear in character lists. These
5675 apply to non-ASCII character sets, which can have single symbols
5676 (calledcollating elements) that are represented with more than one
5678 as well as several characters that are equivalent for collating or
5686 <term>Collating Symbols</term>
5689 A collating symbol is a multi-character collating element
5691 ``[.'' and ``.]''. For example, if ``ch'' is a
5693 element, then <emphasis role="bold">
5694 [[.ch.]]
5696 is a regexp that matches
5697 this collating element, while <emphasis role="bold">
5701 matches either ``c'' or ``h''.
5706 <term>Equivalence Classes</term>
5709 An equivalence class is a locale-specific name for a list of
5710 characters that are equivalent. The name is enclosed in
5712 and ``=]''. For example, the name ``e'' might be used to
5713 represent all of ``è'' ``é'' and ``e''. In this
5715 <emphasis role="bold">[[=e=]]</emphasis> is
5716 a regexp that matches any of
5717 ``è'', ``é'' and ``e''.
5725 A regular expression matching a single character may be followed by one
5726 of several repetition operators:
5736 The preceding item is optional and matched at most once.
5744 The preceding item will be matched zero or more times.
5752 The preceding item will be matched one or more times.
5757 <term>{n}</term>
5760 The preceding item is matched exactly <emphasis>n</emphasis>
5766 <term>{n,}</term>
5769 The preceding item is matched <emphasis>n</emphasis> or more
5775 <term>{,m}</term>
5778 The preceding item is matched at most <emphasis>m</emphasis>
5784 <term>{n,m}</term>
5787 The preceding item is matched at least <emphasis>n</emphasis>
5788 times, but no more than
5789 <emphasis>m</emphasis> times.
5797 Two regular expressions may be concatenated; the resulting regular
5798 expression matches any string formed by concatenating two substrings
5799 that respectively match the concatenated subexpressions.
5803 Two regular expressions may be joined by the infix operator
5805 the resulting regular expression matches any string matching either
5810 Repetition takes precedence over concatenation, which in turn takes
5811 precedence over alternation. A whole subexpression may be enclosed in
5812 parentheses to override these precedence rules.
5816 <emphasis role="bold">Note:</emphasis> If you compile Mutt-ng with the
5817 GNU <emphasis>rx</emphasis> package, the
5818 following operators may also be used in regular expressions:
5825 <term>\\y</term>
5828 Matches the empty string at either the beginning or the end of
5834 <term>\\B</term>
5837 Matches the empty string within a word.
5842 <term>\\<</term>
5845 Matches the empty string at the beginning of a word.
5850 <term>\\></term>
5853 Matches the empty string at the end of a word.
5858 <term>\\w</term>
5861 Matches any word-constituent character (letter, digit, or
5867 <term>\\W</term>
5870 Matches any character that is not word-constituent.
5875 <term>\\`</term>
5878 Matches the empty string at the beginning of a buffer (string).
5883 <term>\\'</term>
5886 Matches the empty string at the end of a buffer.
5894 Please note however that these operators are not defined by POSIX, so
5895 they may or may not be available in stock libraries on various systems.
5904 <sect1 id="advanced-patterns">
5905 <title>Patterns</title>
5908 Mutt-ng's pattern language provides a simple yet effective way to
5909 set up rules to match messages, e.g. for operations like tagging and
5910 scoring. A pattern consists of one or more sub-pattern, which can be
5911 logically grouped, ORed, and negated. For a complete listing of
5912 these patterns, please refer to table <link linkend="tab-patterns">patterns</link> in the Reference chapter.
5916 It must be noted that in this table, <literal>EXPR</literal> is
5917 a regular expression. For ranges, the forms
5918 <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
5919 <literal> [MIN]-</literal> and <literal>-[MAX]</literal> are
5923 <sect2 id="patterns-complex">
5924 <title>Complex Patterns</title>
5927 It is possible to combine several sub-patterns to a more complex
5928 pattern. The most simple possibility is to logically AND several
5929 patterns by stringing them together:
5935 ~s 'SPAM' ~U</screen>
5940 The pattern above matches all messages that contain ``SPAM'' in
5941 the subject and are unread.
5945 To logical OR patterns, simply use the <literal>|</literal>
5947 especially useful when using local groups:
5953 ~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
5954 (~b mutt-ng|~s Mutt-ng)
5955 !~x '@synflood\.at'</screen>
5960 The first pattern matches all messages that were sent by one of
5961 the mutt-ng maintainers, while the seconds pattern matches all
5962 messages that contain ``mutt-ng'' in the message body or ``Mutt-ng''
5963 in the subject. The third pattern matches all messages that do not
5964 contain ``@synflood\.at'' in the <literal>References:</literal>
5966 messages that are not an (indirect) reply to one of my messages. A
5967 pattern can be logicall negated using the <literal>!</literal>
5973 <sect2 sect="patterns-dates">
5974 <title>Patterns and Dates</title>
5977 When using dates in patterns, the dates must be specified in a
5978 special format, i.e. <literal>DD/MM/YYYY</literal>. If you don't
5980 month or year, they default to the current month or year. When using
5981 date ranges, and you specify only the minimum or the maximum, the
5982 specified date will be excluded, e.g. <literal>01/06/2005-</literal>
5984 against all messages <emphasis>after</emphasis> Juni 1st, 2005.
5988 It is also possible to use so-called ``error margins'' when
5989 specifying date ranges. You simply specify a date, and then the
5990 error margin. This margin needs to contain the information whether
5991 it goes ``forth'' or ``back'' in time, by using <literal>+</literal>
5992 and <literal>-</literal>.
5993 Then follows a number and a unit, i.e. <literal>y</literal> for
5994 years, <literal>m</literal> for
5995 months, <literal>w</literal> for weeks and <literal>d</literal> for
5996 days. If you use the special
5997 <literal>*</literal> sign, it means that the error margin goes to
5998 both``directions'' in time.
6006 ~d 28/12/2004*1d</screen>
6011 The first pattern matches all dates between January 1st, 2005 and
6012 January 1st 2006. The second pattern matches all dates between
6013 October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004),
6014 while the third pattern matches all dates 1 day around December
6015 28th, 2004 (i.e. Dec 27th, 28th and 29th).
6019 Relative dates are also very important, as they make it possible
6020 to specify date ranges between a fixed number of units and the
6021 current date. How this works can be seen in the following example:
6027 ~d >2w # messages older than two weeks
6028 ~d <3d # messages newer than 3 days
6029 ~d =1m # messages that are exactly one month old</screen>
6041 <sect1 id="formatstrings">
6042 <title>Format Strings</title>
6044 <sect2 id="formatstrings-intro">
6045 <title>Introduction</title>
6048 The so called <emphasis>Format Strings</emphasis> offer great
6050 configuring mutt-ng. In short, they describe what items to print
6051 out how in menus and status messages.
6055 Basically, they work as this: for different menus and bars,
6056 there's a variable specifying the layout. For every item
6057 available, there is a so called <emphasis>expando</emphasis>.
6061 For example, when running mutt-ng on different machines or
6062 different versions for testing purposes, it may be interesting to
6063 have the following information always printed on screen when one
6073 the current hostname
6080 the current mutt-ng version number
6090 The setting for the status bar of the index is controlled via the
6091 <link linkend="status-format">status-format</link>
6092 variable. For the hostname and version string, there's an expando
6093 for <literal>$status_format</literal>: <literal>
6097 hostname and <literal>%v</literal> to the version string. When
6104 set status_format = "%v on %h: ..."</screen>
6109 mutt-ng will replace the sequence <literal>%v</literal> with
6111 and <literal>%h</literal> with the host's name. When you are,
6112 for example, running
6113 mutt-ng version <literal>1.5.9i</literal> on host <literal>mailhost</literal>, you'll see the
6114 following when you're in the index:
6120 Mutt-ng 1.5.9i on mailhost: ...</screen>
6125 In the index, there're more useful information one could want to
6135 which mailbox is open
6142 how man new, flagged or postponed messages
6159 To include the mailbox' name is as easy as:
6165 set status_format = "%v on %h: %B: ...</screen>
6170 When the currently opened mailbox is <literal>Inbox</literal>, this
6178 Mutt-ng 1.5.9i on mailhost: Inbox: ...</screen>
6183 For the number of certain types of messages, one more feature of the
6185 strings is extremely useful. If there aren't messages of a certain
6187 may not be desired to print just that there aren't any but instead
6189 print something if there are any.
6198 <sect2 id="formatstrings-conditional">
6199 <title>Conditional Expansion</title>
6202 To only print the number of messages if there are new messages in
6203 the current mailbox, further extend
6204 <literal>$status_format</literal> to:
6210 set status_format = "%v on %h: %B %?n?%n new? ...</screen>
6215 This feature is called <emphasis>nonzero-printing</emphasis> and
6217 some expandos may be optionally printed nonzero, i.e. a portion
6218 of the format string is only evaluated if the value of the expando
6219 is different from zero. The basic syntax is:
6225 %?<item>?<string if nonzero>?</screen>
6230 which tells mutt-ng to only look at <literal><string if
6233 if the value of the <literal>%<item%gt;</literal>
6234 expando is different from zero. In our example, we used <literal>n</literal> as
6235 the expando to check for and <literal>%n new</literal> as the
6241 But this is not all: this feature only offers one alternative:
6242 ``print something if not zero.'' Mutt-ng does, as you might guess,
6243 also provide a logically complete version: ``if zero, print
6244 something and else print something else.'' This is achieved by the
6245 following syntax for those expandos which may be printed nonzero:
6251 %?<item>?<string if nonzero>&<string if zero>?</screen>
6256 Using this we can make mutt-ng to do the following:
6265 make it print ``<emphasis>n</emphasis> new messages'' whereby <emphasis>
6269 count but only if there new ones
6276 and make it print ``no new messages'' if there aren't any
6286 The corresponding configuration is:
6292 set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</screen>
6297 This doubles the use of the ``new messages'' string because it'll get
6298 always printed. Thus, it can be shortened to:
6304 set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</screen>
6309 As you might see from this rather simple example, one can create
6310 very complex but fancy status messages. Please see the reference
6311 chapter for expandos and those which may be printed nonzero.
6320 <sect2 id="formatstrings-padding">
6321 <title>Modifications and Padding</title>
6324 Besides the information given so far, there're even more features of
6334 When specifying <literal>%_<item></literal>
6336 just <literal>%<item></literal>, mutt-ng will
6338 characters in the expansion of <literal><item></literal>
6347 When specifying <literal>%:<item></literal>
6349 <literal>%<item></literal>, mutt-ng will convert
6351 expansion of <literal><item></literal> to underscores
6352 (<literal>_</literal>).
6362 Also, there's a feature called <emphasis>Padding</emphasis> supplied
6364 following two expandos: <literal>%|X</literal> and <literal>
6375 <literal>%|X</literal>
6379 When this occurs, mutt-ng will fill the
6380 rest of the line with the character <literal>X</literal>. In
6382 filling the rest of the line with dashes is done by setting:
6388 set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
6395 <literal>%>X</literal>
6399 Since the previous expando stops at
6400 the end of line, there must be a way to fill the gap between
6401 two items via the <literal>%>X</literal> expando:
6403 characters <literal>X</literal> in between two items so that
6405 the line will be right-justified. For example, to not put the
6406 version string and hostname of our example on the left but on
6407 the right and fill the gap with spaces, one might use (note
6408 the space after <literal>%></literal>):
6414 set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>
6434 <sect1 id="using-tags">
6435 <title>Using Tags</title>
6438 Sometimes it is desirable to perform an operation on a group of
6439 messages all at once rather than one at a time. An example might be
6440 to save messages to a mailing list to a separate folder, or to
6441 delete all messages with a given subject. To tag all messages
6442 matching a pattern, use the tag-pattern function, which is bound to
6443 ``shift-T'' by default. Or you can select individual messages by
6444 hand using the ``tag-message'' function, which is bound to ``t'' by
6445 default. See <link linkend="tab-patterns">patterns</link> for Mutt-ng's
6451 Once you have tagged the desired messages, you can use the
6452 ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
6453 When the ``tag-prefix'' operator is used, the <emphasis role="bold">
6457 be applied to all tagged messages if that operation can be used in that
6458 manner. If the <link linkend="auto-tag">auto-tag</link>
6459 variable is set, the next operation applies to the tagged messages
6460 automatically, without requiring the ``tag-prefix''.
6464 In <link linkend="macro">macro</link> or <link linkend="push">push</link> commands,
6465 you can use the ``tag-prefix-cond'' operator. If there are no tagged
6466 messages, mutt will "eat" the rest of the macro to abort it's
6467 execution.Mutt-ng will stop "eating" the macro when it encounters the
6469 operator; after this operator the rest of the macro will be executed
6480 <title>Using Hooks</title>
6483 A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor
6485 execute arbitrary commands before performing some operation. For
6487 you may wish to tailor your configuration based upon which mailbox you
6489 reading, or to whom you are sending mail. In the Mutt-ng world, a <emphasis>
6492 consists of a <link linkend="advanced-regexp">regexp</link> or
6493 <link linkend="tab-patterns">patterns</link> along with a
6494 configuration option/command. See
6500 <link linkend="folder-hook">folder-hook</link>
6506 <link linkend="send-hook">send-hook</link>
6512 <link linkend="message-hook">message-hook</link>
6518 <link linkend="save-hook">save-hook</link>
6524 <link linkend="mbox-hook">mbox-hook</link>
6530 <link linkend="fcc-hook">fcc-hook</link>
6536 <link linkend="fcc-save-hook">fcc-save-hook</link>
6542 for specific details on each type of <emphasis>hook</emphasis>
6547 <emphasis role="bold">Note:</emphasis> if a hook changes configuration
6548 settings, these changes remain
6549 effective until the end of the current mutt session. As this is
6551 not desired, a default hook needs to be added before all other hooks to
6552 restore configuration defaults. Here is an example with send-hook and
6554 my_hdr directive:
6560 send-hook . 'unmy_hdr From:'
6561 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c</screen>
6565 <sect2 id="pattern-hook">
6566 <title>Message Matching in Hooks</title>
6569 Hooks that act upon messages (<literal>send-hook, save-hook,
6570 fcc-hook,message-hook
6572 )are evaluated in a slightly different manner. For the other
6573 types of hooks, a <link linkend="advanced-regexp">regexp</link> is
6574 sufficient. But in dealing with messages a finer grain of control is
6575 needed for matching since for different purposes you want to match
6580 Mutt-ng allows the use of the <link linkend="tab-patterns">patterns</link>
6581 language for matching messages in hook commands. This works in
6582 exactly the same way as it would when <emphasis>limiting</emphasis>
6583 or<emphasis>searching</emphasis> the mailbox, except that you are
6585 operators which match information mutt extracts from the header of
6586 the message (i.e. from, to, cc, date, subject, etc.).
6590 For example, if you wanted to set your return address based upon
6592 mail to a specific address, you could do something like:
6595 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'</screen>
6597 which would execute the given command when sending mail to
6598 <emphasis>me@cs.hmc.edu</emphasis>.
6602 However, it is not required that you write the pattern to match using
6604 full searching language. You can still specify a simple <emphasis>
6608 like the other hooks, in which case Mutt-ng will translate your
6609 pattern into the full language, using the translation specified by
6611 <link linkend="default-hook">default-hook</link> variable. The
6612 pattern is translated at the time the hook is declared, so the value
6614 <link linkend="default-hook">default-hook</link> that is in effect
6615 at that time will be used.
6626 <sect1 id="sidebar">
6627 <title>Using the sidebar</title>
6630 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox
6632 which looks very similar to the ones you probably know from GUI mail
6634 The sidebar lists all specified mailboxes, shows the number in each
6635 and highlights the ones with new email
6636 Use the following configuration commands:
6639 set sidebar_visible="yes"
6640 set sidebar_width=25</screen>
6645 If you want to specify the mailboxes you can do so with:
6657 You can also specify the colors for mailboxes with new mails by using:
6660 color sidebar_new red black
6661 color sidebar white black</screen>
6666 The available functions are:
6669 <title>Default Sidebar Function Bindings</title>
6670 <tgroup cols="3" align="left" colsep="1" rowsep="1">
6674 <entry>Function</entry>
6675 <entry>Description</entry>
6679 <row><entry><literal>none</literal></entry><entry><literal>sidebar-scroll-up </literal></entry><entry>Scrolls the mailbox list up 1 page</entry></row>
6680 <row><entry><literal>none</literal></entry><entry><literal>sidebar-scroll-down </literal></entry><entry>Scrolls the mailbox list down 1 page</entry></row>
6681 <row><entry><literal>none</literal></entry><entry><literal>sidebar-next </literal></entry><entry>Highlights the next mailbox</entry></row>
6682 <row><entry><literal>none</literal></entry><entry><literal>sidebar-next-new </literal></entry><entry>Highlights the next mailbox with new mail</entry></row>
6683 <row><entry><literal>none</literal></entry><entry><literal>sidebar-previous </literal></entry><entry>Highlights the previous mailbox</entry></row>
6684 <row><entry><literal>none</literal></entry><entry><literal>sidebar-open </literal></entry><entry>Opens the currently highlighted mailbox</entry></row>
6692 Reasonable key bindings look e.g. like this:
6695 bind index \Cp sidebar-prev
6696 bind index \Cn sidebar-next
6697 bind index \Cb sidebar-open
6698 bind pager \Cp sidebar-prev
6699 bind pager \Cn sidebar-next
6700 bind pager \Cb sidebar-open
6702 macro index B ':toggle sidebar_visible^M'
6703 macro pager B ':toggle sidebar_visible^M'</screen>
6708 You can then go up and down by pressing Ctrl-P and Ctrl-N, and
6709 switch on and off the sidebar simply by pressing 'B'.
6719 <title>External Address Queries</title>
6722 Mutt-ng supports connecting to external directory databases such as
6724 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
6725 using a simple interface. Using the <link linkend="query-command">
6728 variable, you specify the wrapper
6729 command to use. For example:
6735 set query_command = "mutt_ldap_query.pl '%s'"</screen>
6740 The wrapper script should accept the query on the command-line. It
6741 should return a one line message, then each matching response on a
6742 single line, each line containing a tab separated address then name
6743 thensome other optional information. On error, or if there are no
6745 addresses, return a non-zero exit code and a one line error message.
6749 An example multiple response output:
6752 Searching database ... 20 entries ... 3 matching:
6753 me@cs.hmc.edu Michael Elkins mutt dude
6754 blong@fiction.net Brandon Long mutt and more
6755 roessler@guug.de Thomas Roessler mutt pgp</screen>
6760 There are two mechanisms for accessing the query function of mutt. One
6761 is to do a query from the index menu using the query function (default:
6763 This will prompt for a query, then bring up the query menu which will
6764 list the matching responses. From the query menu, you can select
6765 addresses to create aliases, or to mail. You can tag multiple
6766 addressesto mail, start a new query, or have a new query appended to
6772 The other mechanism for accessing the query function is for address
6773 completion, similar to the alias completion. In any prompt for address
6774 entry, you can use the complete-query function (default: ˆT) to
6776 query based on the current address you have typed. Like aliases, mutt
6777 will look for what you have typed back to the last space or comma. If
6778 there is a single response for that query, mutt will expand the address
6779 in place. If there are multiple responses, mutt will activate the
6780 querymenu. At the query menu, you can select one or more addresses to
6782 added to the prompt.
6791 <sect1 id="mailbox-formats">
6792 <title>Mailbox Formats</title>
6795 Mutt-ng supports reading and writing of four different mailbox formats:
6796 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
6797 is no need to use a flag for different mailbox types. When creating
6798 newmailboxes, Mutt-ng uses the default specified with the <link linkend="mbox-type">
6805 <emphasis role="bold">mbox</emphasis>. This is the most widely used
6806 mailbox format for UNIX. All
6807 messages are stored in a single file. Each message has a line of the
6814 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</screen>
6819 to denote the start of a new message (this is often referred to as the
6820 ``From_'' line).
6824 <emphasis role="bold">MMDF</emphasis>. This is a variant of the <emphasis>
6827 format. Each message is
6828 surrounded by lines containing ``ˆAˆAˆAˆA'' (four
6833 <emphasis role="bold">MH</emphasis>. A radical departure from <emphasis>
6836 and <emphasis>MMDF</emphasis>, a mailbox
6837 consists of a directory and each message is stored in a separate file.
6838 The filename indicates the message number (however, this is may not
6839 correspond to the message number Mutt-ng displays). Deleted messages
6840 arerenamed with a comma (,) prepended to the filename. <emphasis role="bold">
6844 detects this type of mailbox by looking for either <literal>
6845 .mh_sequences
6847 or <literal>.xmhcache</literal> (needed to distinguish normal
6853 <emphasis role="bold">Maildir</emphasis>. The newest of the mailbox
6854 formats, used by the Qmail MTA (a
6855 replacement for sendmail). Similar to <emphasis>MH</emphasis>, except
6857 subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>
6861 for the messages are chosen in such a way they are unique, even when
6862 twoprograms are writing the mailbox over NFS, which means that no file
6873 <sect1 id="shortcuts">
6874 <title>Mailbox Shortcuts</title>
6877 There are a number of built in shortcuts which refer to specific
6879 These shortcuts can be used anywhere you are prompted for a file or
6890 ! -- refers to your <link linkend="spoolfile">spoolfile</link>
6897 > -- refers to your <link linkend="mbox">mbox</link> file
6903 < -- refers to your <link linkend="record">record</link> file
6909 ˆ -- refers to the current mailbox
6915 - or !! -- refers to the file you've last visited
6921 ˜ -- refers to your home directory
6927 = or + -- refers to your <link linkend="folder">folder</link>
6934 @<emphasis>alias</emphasis> -- refers to the <link linkend="save-hook">
6937 as determined by the address of the alias
6951 <sect1 id="using-lists">
6952 <title>Handling Mailing Lists</title>
6955 Mutt-ng has a few configuration options that make dealing with large
6956 amounts of mail easier. The first thing you must do is to let Mutt
6957 know what addresses you consider to be mailing lists (technically
6958 this does not have to be a mailing list, but that is what it is most
6959 often used for), and what lists you are subscribed to. This is
6960 accomplished through the use of the <link linkend="lists">lists</link>
6961 commands in your muttrc.
6965 Now that Mutt-ng knows what your mailing lists are, it can do several
6966 things, the first of which is the ability to show the name of a list
6967 through which you received a message (i.e., of a subscribed list) in
6968 the <emphasis>index</emphasis> menu display. This is useful to
6970 personal and list mail in the same mailbox. In the <link linkend="index-format">
6973 variable, the escape ``%L''
6974 will return the string ``To <list>'' when ``list'' appears in the
6975 ``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
6976 field (otherwise it returns the name of the author).
6980 Often times the ``To'' and ``Cc'' fields in mailing list messages
6981 tend to get quite large. Most people do not bother to remove the
6982 author of the message they are reply to from the list, resulting in
6983 two or more copies being sent to that person. The ``list-reply''
6984 function, which by default is bound to ``L'' in the <emphasis>index</emphasis> menu
6985 and <emphasis>pager</emphasis>, helps reduce the clutter by only
6987 known mailing list addresses instead of all recipients (except as
6988 specified by <literal>Mail-Followup-To</literal>, see below).
6992 Mutt-ng also supports the <literal>Mail-Followup-To</literal> header.
6994 a message to a list of recipients which includes one or several
6995 subscribed mailing lists, and if the <link linkend="followup-to">
6998 option is set, mutt will generate
6999 a Mail-Followup-To header which contains all the recipients to whom
7000 you send this message, but not your address. This indicates that
7001 group-replies or list-replies (also known as ``followups'') to this
7002 message should only be sent to the original recipients of the
7003 message, and not separately to you - you'll receive your copy through
7004 one of the mailing lists you are subscribed to.
7008 Conversely, when group-replying or list-replying to a message which
7009 has a <literal>Mail-Followup-To</literal> header, mutt will respect
7011 the <link linkend="honor-followup-to">honor-followup-to</link>
7013 variable is set. Using list-reply will in this case also make sure
7014 that the reply goes to the mailing list, even if it's not specified
7015 in the list of recipients in the <literal>Mail-Followup-To</literal>.
7019 Note that, when header editing is enabled, you can create a
7020 <literal>Mail-Followup-To</literal> header manually. Mutt-ng will only
7022 this header if it doesn't exist when you send the message.
7026 The other method some mailing list admins use is to generate a
7027 ``Reply-To'' field which points back to the mailing list address rather
7028 than the author of the message. This can create problems when trying
7029 to reply directly to the author in private, since most mail clients
7030 will automatically reply to the address given in the ``Reply-To''
7031 field. Mutt-ng uses the <link linkend="reply-to">reply-to</link>
7032 variable to help decide which address to use. If set to <emphasis>
7036 <emphasis>ask-no</emphasis>, you will be
7037 prompted as to whether or not you would like to use the address given
7038 inthe ``Reply-To'' field, or reply directly to the address given in the
7039 ``From'' field. When set to <emphasis>yes</emphasis>, the ``Reply-To''
7040 field will be used when
7045 The ``X-Label:'' header field can be used to further identify mailing
7046 lists or list subject matter (or just to annotate messages
7047 individually). The <link linkend="index-format">index-format</link>
7048 variable's ``%y'' and
7049 ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
7050 index, and Mutt-ng's pattern-matcher can match regular expressions to
7051 ``X-Label:'' fields with the ``˜y'' selector. ``X-Label:'' is
7053 standard message header field, but it can easily be inserted by
7054 procmailand other mail filtering agents.
7058 Lastly, Mutt-ng has the ability to <link linkend="sort">sort</link> the
7060 <link linkend="threads">threads</link>. A thread is a group of
7061 messages which all relate to the same
7062 subject. This is usually organized into a tree-like structure where a
7063 message and all of its replies are represented graphically. If you've
7065 used a threaded news client, this is the same concept. It makes
7066 dealingwith large volume mailing lists easier because you can easily
7068 uninteresting threads and quickly find topics of value.
7077 <sect1 id="editing-threads">
7078 <title>Editing threads</title>
7081 Mutt-ng has the ability to dynamically restructure threads that are
7083 either by misconfigured software or bad behavior from some
7084 correspondents. This allows to clean your mailboxes formats) from these
7085 annoyances which make it hard to follow a discussion.
7088 <sect2 id="editing-threads-link">
7089 <title>Linking threads</title>
7092 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
7093 "References:" headers when replying to a message. This results in
7095 discussions because Mutt-ng has not enough information to guess the
7098 You can fix this by tagging the reply, then moving to the parent
7100 and using the ``link-threads'' function (bound to & by default).
7102 reply will then be connected to this "parent" message.
7106 You can also connect multiple children at once, tagging them and
7108 tag-prefix command (';') or the auto_tag option.
7113 <sect2 id="editing-threads-break">
7114 <title>Breaking threads</title>
7117 On mailing lists, some people are in the bad habit of starting a new
7118 discussion by hitting "reply" to any message from the list and
7120 the subject to a totally unrelated one.
7121 You can fix such threads by using the ``break-thread'' function
7122 (boundby default to #), which will turn the subthread starting
7124 current message into a whole different thread.
7136 <title>Delivery Status Notification (DSN) Support</title>
7139 RFC1894 defines a set of MIME content types for relaying information
7140 about the status of electronic mail messages. These can be thought of
7142 ``return receipts.''
7146 Users can make use of it in one of the following two ways:
7155 Berkeley sendmail 8.8.x currently has some command line options
7156 in which the mail client can make requests as to what type of
7158 messages should be returned.
7164 The SMTP support via libESMTP supports it, too.
7173 To support this, there are two variables:
7182 <link linkend="dsn-notify">dsn-notify</link> is used
7183 to request receipts for different results (such as failed
7184 message,message delivered, etc.).
7191 <link linkend="dsn-return">dsn-return</link> requests
7192 how much of your message should be returned with the receipt
7193 (headers or full message).
7203 Please see the reference chapter for possible values.
7213 <title>POP3 Support (OPTIONAL)</title>
7216 If Mutt-ng was compiled with POP3 support (by running the <emphasis>
7219 script with the <emphasis>--enable-pop</emphasis> flag), it has the
7221 with mailboxes located on a remote POP3 server and fetch mail for local
7226 You can access the remote POP3 mailbox by selecting the folder
7227 <literal>pop://popserver/</literal>.
7231 You can select an alternative port by specifying it with the server,
7233 <literal>pop://popserver:port/</literal>.
7237 You can also specify different username for each folder, i.e.:
7238 <literal>pop://username@popserver[:port]/</literal>.
7242 Polling for new mail is more expensive over POP3 than locally. For this
7243 reason the frequency at which Mutt-ng will check for mail remotely can
7246 <link linkend="pop-mail-check">pop-mail-check</link>
7247 variable, which defaults to every 60 seconds.
7251 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7254 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7256 can be encrypted. This naturally requires that the server supports
7257 SSL encrypted connections. To access a folder with POP3/SSL, you should
7258 use pops: prefix, ie:
7259 <literal>pops://[username@]popserver[:port]/</literal>.
7263 Another way to access your POP3 mail is the <emphasis>fetch-mail</emphasis> function
7264 (default: G). It allows to connect to <link linkend="pop-host">
7267 ,fetch all your new mail and place it in the
7268 local <link linkend="spoolfile">spoolfile</link>. After this
7269 point, Mutt-ng runs exactly as if the mail had always been local.
7273 <emphasis role="bold">Note:</emphasis> If you only need to fetch all
7274 messages to local mailbox
7275 you should consider using a specialized program, such as
7277 URL="http://www.ccil.org/~esr/fetchmail">fetchmail</ulink>
7287 <title>IMAP Support (OPTIONAL)</title>
7290 If Mutt-ng was compiled with IMAP support (by running the <emphasis>
7293 script with the <emphasis>--enable-imap</emphasis> flag), it has the
7295 with folders located on a remote IMAP server.
7299 You can access the remote inbox by selecting the folder
7300 <literal>imap://imapserver/INBOX</literal>, where <literal>imapserver</literal> is the name of the
7301 IMAP server and <literal>INBOX</literal> is the special name for your
7303 the IMAP server. If you want to access another mail folder at the IMAP
7304 server, you should use <literal>imap://imapserver/path/to/folder</literal> where
7305 <literal>path/to/folder</literal> is the path of the folder you want to
7310 You can select an alternative port by specifying it with the server,
7312 <literal>imap://imapserver:port/INBOX</literal>.
7316 You can also specify different username for each folder, i.e.:
7317 <literal>imap://username@imapserver[:port]/INBOX</literal>.
7321 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7324 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7326 can be encrypted. This naturally requires that the server supports
7327 SSL encrypted connections. To access a folder with IMAP/SSL, you should
7328 use <literal>imaps://[username@]imapserver[:port]/path/to/folder</literal> as your
7333 Pine-compatible notation is also supported, i.e.
7334 <literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
7338 Note that not all servers use / as the hierarchy separator. Mutt-ng
7340 correctly notice which separator is being used by the server and
7341 convertpaths accordingly.
7345 When browsing folders on an IMAP server, you can toggle whether to look
7346 at only the folders you are subscribed to, or all folders with the
7347 <emphasis>toggle-subscribed</emphasis> command. See also the
7348 <link linkend="imap-list-subscribed">imap-list-subscribed</link>
7353 Polling for new mail on an IMAP server can cause noticeable delays. So,
7355 want to carefully tune the
7356 <link linkend="imap-mail-check">imap-mail-check</link>
7358 <link linkend="timeout">timeout</link>
7363 Note that if you are using mbox as the mail store on UW servers prior
7364 tov12.250, the server has been reported to disconnect a client if
7366 selects the same folder.
7369 <sect2 id="imap-browser">
7370 <title>The Folder Browser</title>
7373 As of version 1.2, mutt supports browsing mailboxes on an IMAP
7374 server. This is mostly the same as the local file browser, with the
7375 following differences:
7381 Instead of file permissions, mutt displays the string "IMAP",
7382 possibly followed by the symbol "+", indicating
7383 that the entry contains both messages and subfolders. On
7384 Cyrus-like servers folders will often contain both messages and
7391 For the case where an entry can contain both messages and
7392 subfolders, the selection key (bound to <literal>enter</literal> by default)
7393 will choose to descend into the subfolder view. If you wish to
7395 the messages in that folder, you must use <literal>view-file</literal> instead
7396 (bound to <literal>space</literal> by default).
7402 You can create, delete and rename mailboxes with the
7403 <literal>create-mailbox</literal>, <literal>delete-mailbox</literal>, and
7404 <literal>rename-mailbox</literal> commands (default bindings: <literal>
7408 <literal>d</literal> and <literal>r</literal>, respectively).
7410 <literal>subscribe</literal> and <literal>unsubscribe</literal>
7411 to mailboxes (normally
7412 these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
7422 <sect2 id="imap-auth">
7423 <title>Authentication</title>
7426 Mutt-ng supports four authentication methods with IMAP servers: SASL,
7427 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
7428 NTLM authentication for you poor exchange users out there, but it has
7429 yet to be integrated into the main tree). There is also support for
7430 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
7431 IMAP server without having an account. To use ANONYMOUS, simply make
7432 your username blank or "anonymous".
7436 SASL is a special super-authenticator, which selects among several
7438 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most
7440 method available on your host and the server. Using some of these
7442 (including DIGEST-MD5 and possibly GSSAPI), your entire session will
7444 encrypted and invisible to those teeming network snoops. It is the
7446 option if you have it. To use it, you must have the Cyrus SASL
7447 libraryinstalled on your system and compile mutt with the <emphasis>
7454 Mutt-ng will try whichever methods are compiled in and available on
7456 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
7460 There are a few variables which control authentication:
7466 <link linkend="imap-user">imap-user</link> - controls
7467 the username under which you request authentication on the IMAP
7469 for all authenticators. This is overridden by an explicit
7471 the mailbox path (i.e. by using a mailbox name of the form
7472 <literal>{user@host}</literal>).
7478 <link linkend="imap-pass">imap-pass</link> - a
7479 password which you may preset, used by all authentication
7481 a password is needed.
7487 <link linkend="imap-authenticators">imap-authenticators</link>
7488 - a colon-delimited list of IMAP
7489 authentication methods to try, in the order you wish to try
7491 specified, this overrides mutt's default (attempt everything,
7510 <title>NNTP Support (OPTIONAL)</title>
7513 If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
7514 a newsserver via NNTP. You can open a newsgroup with the
7515 ``change-newsgroup'' function from the index/pager which is by default
7516 bound to <literal>i</literal>.
7520 The Default newsserver can be obtained from the
7521 <literal>$NNTPSERVER</literal> environment variable. Like other
7523 info about subscribed newsgroups is saved in a file as specified by the
7524 <link linkend="nntp-newsrc">nntp-newsrc</link> variable.
7525 Article headers are cached and can be loaded from a file when a
7526 newsgroup is entered instead loading from newsserver; currently, this
7527 caching mechanism still is different from the header caching for
7531 <sect2 id="nntp-scoring">
7532 <title>Again: Scoring</title>
7535 Especially for Usenet, people often ask for advanced filtering
7536 and scoring functionality. Of course, mutt-ng has scoring and
7537 allows a killfile, too. How to use a killfile has been discussed
7538 in <link linkend="score-command">score-command</link>.
7542 What has not been discusses in detail is mutt-ng's built-in
7543 realname filter. For may newsreaders including those for
7544 ``advanced users'' like <emphasis>slrn</emphasis> or <emphasis>tin</emphasis>, there are frequent
7545 request for such functionality. The solutions offered often are
7546 complicated regular expressions.
7550 In mutt-ng this is as easy as
7556 score ~* =42</screen>
7561 This tells mutt-ng to apply a score of 42 to all messages whose
7562 sender specified a valid realname and a valid email address. Using
7568 score !~* =42</screen>
7573 on the contrary applies a score of 42 to all messages <emphasis>not</emphasis>
7574 matching those criteria which are very strict:
7583 Email addresses must be valid according to RFC 2822, see
7585 URL="ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt"><ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt>
7592 the name must consist of at least 2 fields whereby a field
7593 must not end in a dot. This means that ``Joe User'' and ``Joe
7594 A.User'' are valid while ``J. User'' and ``J. A. User'' aren't.
7601 it's assumed that users are interested in reading their
7602 own mail and mail from people who they have defined an alias
7603 forso that those 2 groups of messages are excluded from the
7627 <title>SMTP Support (OPTIONAL)</title>
7630 Mutt-ng can be built using a library called ``libESMTP'' which
7631 provides SMTP functionality. When <literal>configure</literal> was
7633 <literal>--with-libesmtp</literal> or the output <literal>muttng -v</literal> contains
7634 <literal>+USE_LIBESMTP</literal>, this will be or is the case
7636 support includes support for Delivery Status Notification (see <link linkend="dsn">
7640 handling the <literal>8BITMIME</literal> flag controlled via <link linkend="use-8bitmime">
7647 To enable sending mail directly via SMTP without an MTA such as
7648 Postfix or SSMTP and the like, simply set the <link linkend="smtp-host">
7651 variable pointing to your SMTP server.
7655 Authentication mechanisms are available via the <link linkend="smtp-user">
7658 and <link linkend="smtp-pass">smtp-pass</link> variables.
7662 Transport Encryption via the StartTLS command is also available. For
7663 this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
7664 Secondly, the <link linkend="smtp-use-tls">smtp-use-tls</link> variable
7666 to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
7667 the server supports it: for the second case, the connection will fail
7668 ifit doesn't while switching back to unencrypted communication for the
7673 Some mail providers require user's to set a particular envelope
7674 sender, i.e. they allow for only one value which may not be what the
7675 user wants to send as the <literal>From:</literal> header. In this
7677 <link linkend="smtp-envelope">smtp-envelope</link> may be used
7678 to set the envelope different from the <literal>From:</literal> header.
7683 <sect1 id="account-hook">
7684 <title>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)</title>
7687 If you happen to have accounts on multiple IMAP and/or POP servers,
7688 you may find managing all the authentication settings inconvenient and
7689 error-prone. The account-hook command may help. This hook works like
7690 folder-hook but is invoked whenever you access a remote mailbox
7691 (including inside the folder browser), not just when you open the
7702 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
7703 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
7704 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</screen>
7714 <sect1 id="urlview">
7715 <title>Start a WWW Browser on URLs (EXTERNAL)</title>
7718 If a message contains URLs (<emphasis>unified resource locator</emphasis> = address in the
7719 WWW space like <emphasis>http://www.mutt.org/</emphasis>), it is
7721 a menu with all the URLs and start a WWW browser on one of them. This
7722 functionality is provided by the external urlview program which can be
7723 retrieved at <ulink URL="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
7725 and the configuration commands:
7728 macro index \cb |urlview\n
7729 macro pager \cb |urlview\n</screen>
7739 <sect1 id="compressed-folders">
7740 <title>Compressed folders Support (OPTIONAL)</title>
7743 If Mutt-ng was compiled with compressed folders support (by running the
7744 <emphasis>configure</emphasis> script with the <emphasis>
7748 can open folders stored in an arbitrary format, provided that the user
7749 has a script to convert from/to this format to one of the accepted.
7753 The most common use is to open compressed archived folders e.g. with
7758 In addition, the user can provide a script that gets a folder in an
7759 accepted format and appends its context to the folder in the
7760 user-defined format, which may be faster than converting the entire
7761 folder to the accepted format, appending to it and converting back to
7762 the user-defined format.
7766 There are three hooks defined (<link linkend="open-hook">open-hook</link>,
7767 <link linkend="close-hook">close-hook</link> and <link linkend="append-hook">
7770 )which define commands to uncompress and compress
7771 a folder and to append messages to an existing compressed folder
7782 open-hook \\.gz$ "gzip -cd %f > %t"
7783 close-hook \\.gz$ "gzip -c %t > %f"
7784 append-hook \\.gz$ "gzip -c %t >> %f" </screen>
7789 You do not have to specify all of the commands. If you omit <link linkend="append-hook">
7792 ,the folder will be open and
7793 closed again each time you will add to it. If you omit <link linkend="close-hook">
7796 (or give empty command) , the
7797 folder will be open in the mode. If you specify <link linkend="append-hook">
7800 though you'll be able to append
7805 Note that Mutt-ng will only try to use hooks if the file is not in one
7807 the accepted formats. In particular, if the file is empty, mutt
7808 supposes it is not compressed. This is important because it allows the
7809 use of programs that do not have well defined extensions. Just use
7810 "." as a regexp. But this may be surprising if your
7811 compressing script produces empty files. In this situation, unset <link linkend="save-empty">
7814 ,so that the compressed file
7815 will be removed if you delete all of the messages.
7818 <sect2 id="open-hook">
7819 <title>Open a compressed mailbox for reading</title>
7823 Usage: <literal>open-hook</literal> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
7828 The <emphasis>command</emphasis> is the command that can be used for
7830 folders whose names match <emphasis>regexp</emphasis>.
7834 The <emphasis>command</emphasis> string is the printf-like format
7836 should accept two parameters: %f, which is replaced with the
7837 (compressed) folder name, and %t which is replaced with the
7838 name of the temporary folder to which to write.
7842 %f and %t can be repeated any number of times in the
7843 command string, and all of the entries are replaced with the
7844 appropriate folder name. In addition, %% is replaced by
7845 %, as in printf, and any other %anything is left as is.
7849 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the original compressed file.
7850 The <emphasis>command</emphasis> should return non-zero exit status
7852 mutt knows something's wrong.
7862 open-hook \\.gz$ "gzip -cd %f > %t"
7868 If the <emphasis>command</emphasis> is empty, this operation is
7869 disabled for this file
7875 <sect2 id="close-hook">
7876 <title>Write a compressed mailbox</title>
7880 Usage: <literal>close-hook</literal> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
7885 This is used to close the folder that was open with the <link linkend="open-hook">
7888 command after some changes were made to it.
7892 The <emphasis>command</emphasis> string is the command that can be
7893 used for closing the
7894 folders whose names match <emphasis>regexp</emphasis>. It has the
7896 the <link linkend="open-hook">open-hook</link> command. Temporary
7898 in this case is the folder previously produced by the <<link linkend="open-hook">
7905 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
7906 <emphasis>command</emphasis> should return non-zero exit status if it
7908 knows something's wrong.
7918 close-hook \\.gz$ "gzip -c %t > %f"</screen>
7923 If the <emphasis>command</emphasis> is empty, this operation is
7924 disabled for this file
7925 type, and the file can only be open in the readonly mode.
7929 <link linkend="close-hook">close-hook</link> is not called when you
7931 from the folder if the folder was not changed.
7936 <sect2 id="append-hook">
7937 <title>Append a message to a compressed mailbox</title>
7941 Usage: <literal>append-hook</literal> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
7946 This command is used for saving to an existing compressed folder.
7947 The <emphasis>command</emphasis> is the command that can be used for
7949 folders whose names match <emphasis>regexp</emphasis>. It has the
7951 the <link linkend="open-hook">open-hook</link> command.
7952 The temporary folder in this case contains the messages that are
7957 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
7958 <emphasis>command</emphasis> should return non-zero exit status if it
7960 knows something's wrong.
7970 append-hook \\.gz$ "gzip -c %t >> %f" </screen>
7975 When <link linkend="append-hook">append-hook</link> is used, the
7977 not opened, which saves time, but this means that we can not find out
7978 what the folder type is. Thus the default (<link linkend="mbox-type">
7981 )type is always supposed (i.e.
7982 this is the format used for the temporary folder).
7986 If the file does not exist when you save to it, <link linkend="close-hook">
7989 is called, and not <link linkend="append-hook">append-hook</link>. <link linkend="append-hook">
7993 for appending to existing folders.
7997 If the <emphasis>command</emphasis> is empty, this operation is
7998 disabled for this file
7999 type. In this case, the folder will be open and closed again (using
8000 <link linkend="open-hook">open-hook</link> and <link linkend="close-hook">
8003 respectively) each time you will add to it.
8008 <sect2 id="encrypted-folders">
8009 <title>Encrypted folders</title>
8012 The compressed folders support can also be used to handle encrypted
8013 folders. If you want to encrypt a folder with PGP, you may want to
8014 usethe following hooks:
8020 open-hook \\.pgp$ "pgp -f < %f > %t"
8021 close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
8027 Please note, that PGP does not support appending to an encrypted
8028 folder, so there is no append-hook defined.
8032 <emphasis role="bold">Note:</emphasis> the folder is temporary stored
8033 decrypted in the /tmp
8034 directory, where it can be read by your system administrator. So
8035 thinkabout the security aspects of this.
8053 <chapter id="mime-support"> <!--{{{-->
8054 <title>Mutt-ng's MIME Support</title>
8057 Quite a bit of effort has been made to make Mutt-ng the premier text-mode
8058 MIME MUA. Every effort has been made to provide the functionality that
8059 the discerning MIME user requires, and the conformance to the standards
8060 wherever possible. When configuring Mutt-ng for MIME, there are two
8061 extratypes of configuration files which Mutt-ng uses. One is the
8062 <literal>mime.types</literal> file, which contains the mapping of file
8064 IANA MIME types. The other is the <literal>mailcap</literal> file, which
8066 the external commands to use for handling specific MIME types.
8070 <title>Using MIME in Mutt</title>
8073 There are three areas/menus in Mutt-ng which deal with MIME, they are
8075 pager (while viewing a message), the attachment menu and the compose
8079 <sect2 id="mime-view">
8080 <title>Viewing MIME messages in the pager</title>
8083 When you select a message from the index and view it in the pager,
8085 decodes the message to a text representation. Mutt-ng internally
8087 a number of MIME types, including <literal>text/plain, text/enriched,
8088 message/rfc822, and message/news
8090 .In addition, the export
8091 controlled version of Mutt-ng recognizes a variety of PGP MIME types,
8092 including PGP/MIME and application/pgp.
8096 Mutt-ng will denote attachments with a couple lines describing them.
8097 These lines are of the form:
8100 [-- Attachment #1: Description --]
8101 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]</screen>
8103 Where the <literal>Description</literal> is the description or
8104 filename given for the
8105 attachment, and the <literal>Encoding</literal> is one of
8106 <literal>7bit/8bit/quoted-printable/base64/binary</literal>.
8110 If Mutt-ng cannot deal with a MIME type, it will display a message
8114 [-- image/gif is unsupported (use 'v' to view this part) --]</screen>
8120 <sect2 id="attach-menu">
8121 <title>The Attachment Menu</title>
8124 The default binding for <literal>view-attachments</literal> is `v',
8126 attachment menu for a message. The attachment menu displays a list
8127 ofthe attachments in a message. From the attachment menu, you can
8129 print, pipe, delete, and view attachments. You can apply these
8130 operations to a group of attachments at once, by tagging the
8132 and by using the ``tag-prefix'' operator. You can also reply to the
8133 current message from this menu, and only the current attachment (or
8135 attachments tagged) will be quoted in your reply. You can view
8136 attachments as text, or view them using the mailcap viewer
8141 Finally, you can apply the usual message-related functions (like
8142 <link linkend="resend-message">resend-message</link>, and the reply
8143 and forward functions) to attachments of type <literal>message/rfc822</literal>.
8147 See the help on the attachment menu for more information.
8152 <sect2 id="compose-menu">
8153 <title>The Compose Menu</title>
8156 The compose menu is the menu you see before you send a message. It
8157 allows you to edit the recipient list, the subject, and other aspects
8158 of your message. It also contains a list of the attachments of your
8159 message, including the main body. From this menu, you can print,
8161 filter, pipe, edit, compose, review, and rename an attachment or a
8162 list of tagged attachments. You can also modifying the attachment
8163 information, notably the type, encoding and description.
8167 Attachments appear as follows:
8170 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
8171 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description></screen>
8176 The '-' denotes that Mutt-ng will delete the file after sending (or
8177 postponing, or canceling) the message. It can be toggled with the
8178 <literal>toggle-unlink</literal> command (default: u). The next
8180 content-type, and can be changed with the <literal>edit-type</literal> command
8181 (default: ˆT). The next field is the encoding for the
8183 which allows a binary message to be encoded for transmission on 7bit
8184 links. It can be changed with the <literal>edit-encoding</literal>
8186 (default: ˆE). The next field is the size of the attachment,
8187 rounded to kilobytes or megabytes. The next field is the filename,
8188 which can be changed with the <literal>rename-file</literal> command
8190 The final field is the description of the attachment, and can be
8191 changed with the <literal>edit-description</literal> command
8203 <sect1 id="mime-types">
8205 MIME Type configuration with <literal>mime.types</literal>
8209 When you add an attachment to your mail message, Mutt-ng searches your
8210 personal mime.types file at <literal>
8211 ${HOME}/.mime.types
8214 the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
8215 <literal>/etc/mime.types</literal>
8219 The mime.types file consist of lines containing a MIME type and a space
8220 separated list of extensions. For example:
8223 application/postscript ps eps
8225 audio/x-aiff aif aifc aiff</screen>
8227 A sample <literal>mime.types</literal> file comes with the Mutt-ng
8229 should contain most of the MIME types you are likely to use.
8233 If Mutt-ng can not determine the mime type by the extension of the file
8235 attach, it will look at the file. If the file is free of binary
8236 information, Mutt-ng will assume that the file is plain text, and mark
8238 as <literal>text/plain</literal>. If the file contains binary
8239 information, then Mutt-ng will
8240 mark it as <literal>application/octet-stream</literal>. You can change
8242 type that Mutt-ng assigns to an attachment by using the <literal>
8245 command from the compose menu (default: ˆT). The MIME type is
8247 major mime type followed by the sub-type, separated by a '/'. 6 major
8248 types: application, text, image, video, audio, and model have been
8250 after various internet discussions. Mutt-ng recognises all of these if
8252 appropriate entry is found in the mime.types file. It also recognises
8254 major mime types, such as the chemical type that is widely used in the
8255 molecular modelling community to pass molecular data in various forms
8257 various molecular viewers. Non-recognised mime types should only be
8259 if the recipient of the message is likely to be expecting such
8269 <sect1 id="mime-mailcap">
8271 MIME Viewer configuration with <literal>mailcap</literal>
8275 Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix
8276 specific format specified in Appendix A of RFC 1524. This file format
8277 is commonly referred to as the mailcap format. Many MIME compliant
8278 programs utilize the mailcap format, allowing you to specify handling
8279 for all MIME types in one place for all programs. Programs known to
8280 use this format include Netscape, XMosaic, lynx and metamail.
8284 In order to handle various MIME types that Mutt-ng can not handle
8285 internally, Mutt-ng parses a series of external configuration files to
8286 find an external handler. The default search string for these files
8287 is a colon delimited list set to
8290 ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap</screen>
8292 where <literal>$HOME</literal> is your home directory.
8296 In particular, the metamail distribution will install a mailcap file,
8297 usually as <literal>/usr/local/etc/mailcap</literal>, which contains
8302 <sect2 id="mime-mailcap-basics">
8303 <title>The Basics of the mailcap file</title>
8306 A mailcap file consists of a series of lines which are comments,
8312 A comment line consists of a # character followed by anything you
8317 A blank line is blank.
8321 A definition line consists of a content type, a view command, and any
8322 number of optional fields. Each field of a definition line is
8323 dividedby a semicolon ';' character.
8327 The content type is specified in the MIME standard type/subtype
8330 <literal>text/plain, text/html, image/gif,</literal>
8331 etc. In addition, the mailcap format includes two formats for
8332 wildcards, one using the special '*' subtype, the other is the
8334 wild, where you only include the major type. For example, <literal>
8338 <literal>video,</literal> will match all image types and video types,
8343 The view command is a Unix command for viewing the type specified.
8345 are two different types of commands supported. The default is to send
8346 the body of the MIME message to the command on stdin. You can change
8347 this behavior by using %s as a parameter to your view command.
8348 This will cause Mutt-ng to save the body of the MIME message to a
8350 file, and then call the view command with the %s replaced by
8351 the name of the temporary file. In both cases, Mutt-ng will turn over
8353 terminal to the view program until the program quits, at which time
8355 will remove the temporary file if it exists.
8359 So, in the simplest form, you can send a text/plain message to the
8360 external pager more on stdin:
8363 text/plain; more</screen>
8365 Or, you could send the message as a file:
8368 text/plain; more %s</screen>
8370 Perhaps you would like to use lynx to interactively view a text/html
8374 text/html; lynx %s</screen>
8376 In this case, lynx does not support viewing a file from stdin, so you
8377 must use the %s syntax.
8378 <emphasis role="bold">Note:</emphasis> <emphasis>Some older versions
8379 of lynx contain a bug where they
8380 will check the mailcap file for a viewer for text/html. They will
8382 the line which calls lynx, and run it. This causes lynx to
8384 spawn itself to view the object.
8389 On the other hand, maybe you don't want to use lynx interactively,
8390 youjust want to have it convert the text/html to text/plain, then you
8395 text/html; lynx -dump %s | more</screen>
8400 Perhaps you wish to use lynx to view text/html files, and a pager on
8401 all other text formats, then you would use the following:
8405 text/*; more</screen>
8407 This is the simplest form of a mailcap file.
8412 <sect2 id="mime-mailcap-security">
8413 <title>Secure use of mailcap</title>
8416 The interpretation of shell meta-characters embedded in MIME
8418 can lead to security problems in general. Mutt-ng tries to quote
8420 in expansion of %s syntaxes properly, and avoids risky
8422 substituting them, see the <link linkend="mailcap-sanitize">
8429 Although mutt's procedures to invoke programs with mailcap seem to be
8430 safe, there are other applications parsing mailcap, maybe taking less
8432 of it. Therefore you should pay attention to the following rules:
8436 <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
8437 Don't quote them with single or double quotes. Mutt-ng does this for
8438 you, the right way, as should any other program which interprets
8439 mailcap. Don't put them into backtick expansions. Be highly careful
8440 with eval statements, and avoid them if possible at all. Trying to
8442 broken behaviour with quotes introduces new leaks - there is no
8443 alternative to correct quoting in the first place.
8447 If you have to use the %-expandos' values in context where you
8449 quoting or backtick expansions, put that value into a shell variable
8450 and reference the shell variable where necessary, as in the following
8451 example (using <literal>$charset</literal> inside the backtick
8453 since it is not itself subject to any further expansion):
8459 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
8460 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1</screen>
8466 <sect2 id="mime-mailcap-advanced">
8467 <title>Advanced mailcap Usage</title>
8469 <sect3 id="mime-mailcap-advanced-fields">
8470 <title>Optional Fields</title>
8473 In addition to the required content-type and view command fields,
8475 can add semi-colon ';' separated fields to set flags and other
8477 Mutt-ng recognizes the following optional fields:
8481 <term>copiousoutput</term>
8484 This flag tells Mutt-ng that the command passes possibly
8486 text on stdout. This causes Mutt-ng to invoke a pager
8487 (either the internal
8488 pager or the external pager defined by the pager variable)
8490 of the view command. Without this flag, Mutt-ng assumes
8492 is interactive. One could use this to replace the pipe to <literal>
8495 in the <literal>lynx -dump</literal> example in the Basic
8499 text/html; lynx -dump %s ; copiousoutput</screen>
8501 This will cause lynx to format the text/html output as
8503 and Mutt-ng will use your standard pager to display the
8509 <term>needsterminal</term>
8512 Mutt-ng uses this flag when viewing attachments with <link linkend="auto-view">
8515 ,in order to decide whether it should honor the setting
8516 of the <link linkend="wait-key">wait-key</link> variable or
8517 not. When an attachment is viewed using an interactive
8519 corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
8520 <link linkend="wait-key">wait-key</link> and the exit
8521 statusof the program to decide if it will ask you to press
8523 external program has exited. In all other situations it
8530 <term>compose=<command></term>
8533 This flag specifies the command to use to create a new
8535 specific MIME type. Mutt-ng supports this from the compose
8541 <term>composetyped=<command></term>
8544 This flag specifies the command to use to create a new
8546 specific MIME type. This command differs from the compose
8548 that mutt will expect standard MIME headers on the data.
8550 used to specify parameters, filename, description, etc. for
8552 attachment. Mutt-ng supports this from the compose menu.
8557 <term>print=<command></term>
8560 This flag specifies the command to use to print a specific
8562 Mutt-ng supports this from the attachment and compose
8568 <term>edit=<command></term>
8571 This flag specifies the command to use to edit a specific
8573 Mutt-ng supports this from the compose menu, and also uses
8575 new attachments. Mutt-ng will default to the defined
8582 <term>nametemplate=<template></term>
8585 This field specifies the format for the file denoted by
8587 command fields. Certain programs will require a certain
8589 for instance, to correctly view a file. For instance, lynx
8591 interpret a file as <literal>text/html</literal> if the
8592 file ends in <literal>.html</literal>.
8593 So, you would specify lynx as a <literal>text/html</literal> viewer with a line in
8594 the mailcap file like:
8597 text/html; lynx %s; nametemplate=%s.html</screen>
8603 <term>test=<command></term>
8606 This field specifies a command to run to test whether this
8608 entry should be used. The command is defined with the
8610 rules defined in the next section. If the command returns
8612 test passed, and Mutt-ng uses this entry. If the command
8614 then the test failed, and Mutt-ng continues searching for
8616 <emphasis role="bold">Note:</emphasis> <emphasis>the
8617 content-type must match before Mutt-ng performs the test.
8622 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8623 text/html; lynx %s</screen>
8625 In this example, Mutt-ng will run the program RunningX
8627 if the X Window manager is running, and non-zero if it
8629 RunningX returns 0, then Mutt-ng will call netscape to
8631 text/html object. If RunningX doesn't return 0, then
8633 to the next entry and use lynx to display the text/html
8643 <sect3 id="mime-mailcap-advanced-searchorder">
8644 <title>Search Order</title>
8647 When searching for an entry in the mailcap file, Mutt-ng will
8649 the most useful entry for its purpose. For instance, if you are
8650 attempting to print an <literal>image/gif</literal>, and you have
8652 entries in your mailcap file, Mutt-ng will search for an entry with
8658 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
8659 nametemplate=%s.gif</screen>
8661 Mutt-ng will skip the <literal>image/*</literal> entry and use the <literal>
8664 entry with the print command.
8668 In addition, you can use this with <link linkend="auto-view">
8671 to denote two commands for viewing an attachment, one to be viewed
8672 automatically, the other to be viewed interactively from the
8674 menu. In addition, you can then use the test feature to determine
8676 viewer to use interactively depending on your environment.
8679 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8680 text/html; lynx %s; nametemplate=%s.html
8681 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput</screen>
8683 For <link linkend="auto-view">auto-view</link>, Mutt-ng will choose
8685 entry because of the copiousoutput tag. For interactive viewing,
8687 will run the program RunningX to determine if it should use the
8689 entry. If the program returns non-zero, Mutt-ng will use the
8691 for interactive viewing.
8696 <sect3 id="mime-mailcap-advanced-expansion">
8697 <title>Command Expansion</title>
8700 The various commands defined in the mailcap files are passed to the
8701 <literal>/bin/sh</literal> shell using the system() function.
8703 command is passed to <literal>/bin/sh -c</literal>, it is parsed to
8705 various special parameters with information from Mutt-ng. The
8707 Mutt-ng expands are:
8711 <term>%s</term>
8714 As seen in the basic mailcap section, this variable is
8716 to a filename specified by the calling program. This file
8718 the body of the message to view/print/edit or where the
8720 program should place the results of composition. In
8722 use of this keyword causes Mutt-ng to not pass the body of
8724 to the view/print/edit program on stdin.
8729 <term>%t</term>
8732 Mutt-ng will expand %t to the text representation of
8734 type of the message in the same form as the first parameter
8736 mailcap definition line, ie <literal>text/html</literal> or
8737 <literal>image/gif</literal>.
8742 <term>%{<parameter>}</term>
8745 Mutt-ng will expand this to the value of the specified
8747 from the Content-Type: line of the mail message. For
8749 Your mail message contains:
8752 Content-Type: text/plain; charset=iso-8859-1</screen>
8754 then Mutt-ng will expand %{charset} to
8755 iso-8859-1. The default metamail
8756 mailcap file uses this feature to test the charset to spawn
8758 using the right charset to view the message.
8763 <term>\%</term>
8766 This will be replaced by a %
8771 Mutt-ng does not currently support the %F and %n
8773 specified in RFC 1524. The main purpose of these parameters is for
8774 multipart messages, which is handled internally by Mutt-ng.
8781 <sect2 id="mime-mailcap-examples">
8782 <title>Example mailcap files</title>
8785 This mailcap file is fairly simple and standard:
8788 # I'm always running X :)
8789 video/*; xanim %s > /dev/null
8790 image/*; xv %s > /dev/null
8792 # I'm always running netscape (if my computer had more memory, maybe)
8793 text/html; netscape -remote 'openURL(%s)'</screen>
8798 This mailcap file shows quite a number of examples:
8804 # Use xanim to view all videos Xanim produces a header on startup,
8805 # send that to /dev/null so I don't see it
8806 video/*; xanim %s > /dev/null
8808 # Send html to a running netscape by remote
8809 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
8810 # If I'm not running netscape but I am running X, start netscape on the
8812 text/html; netscape %s; test=RunningX
8814 # Else use lynx to view it as text
8817 # This version would convert the text/html to text/plain
8818 text/html; lynx -dump %s; copiousoutput
8820 # I use enscript to print text in two columns to a page
8821 text/*; more %s; print=enscript -2Gr %s
8823 # Netscape adds a flag to tell itself to view jpegs internally
8824 image/jpeg;xv %s; x-mozilla-flags=internal
8826 # Use xv to view images if I'm running X
8827 # In addition, this uses the \ to extend the line and set my editor
8829 image/*;xv %s; test=RunningX; edit=xpaint %s
8831 # Convert images to text using the netpbm tools
8832 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
8833 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
8835 # Send excel spreadsheets to my NT box
8836 application/ms-excel; open.pl %s</screen>
8848 <sect1 id="auto-view">
8849 <title>MIME Autoview</title>
8852 In addition to explicitly telling Mutt-ng to view an attachment with
8853 theMIME viewer defined in the mailcap file, Mutt-ng has support for
8854 automatically viewing MIME attachments while in the pager.
8858 To work, you must define a viewer in the mailcap file which uses the
8859 <literal>copiousoutput</literal> option to denote that it is
8861 Usually, you also use the entry to convert the attachment to a text
8862 representation which you can view in the pager.
8866 You then use the <literal>auto_view</literal> muttrc command to
8868 content-types that you wish to view automatically.
8872 For instance, if you set auto_view to:
8875 auto_view text/html application/x-gunzip application/postscript
8876 image/gif application/x-tar-gz</screen>
8881 Mutt-ng could use the following mailcap entries to automatically view
8882 attachments of these types.
8885 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
8886 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
8887 application/x-gunzip; gzcat; copiousoutput
8888 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
8889 application/postscript; ps2ascii %s; copiousoutput</screen>
8894 ``unauto_view'' can be used to remove previous entries from the
8896 This can be used with message-hook to autoview messages based on size,
8898 ``unauto_view *'' will remove all previous entries.
8907 <sect1 id="alternative-order">
8908 <title>MIME Multipart/Alternative</title>
8911 Mutt-ng has some heuristics for determining which attachment of a
8912 multipart/alternative type to display. First, mutt will check the
8913 alternative_order list to determine if one of the available
8914 typesis preferred. The alternative_order list consists of a
8916 MIME types in order, including support for implicit and explicit
8917 wildcards, for example:
8920 alternative_order text/enriched text/plain text
8921 application/postscript image/*</screen>
8926 Next, mutt will check if any of the types have a defined
8927 <link linkend="auto-view">auto-view</link>, and use that. Failing
8928 that, Mutt-ng will look for any text type. As a last attempt, mutt
8929 willlook for any type it knows how to handle.
8933 To remove a MIME type from the <literal>alternative_order</literal> list, use the
8934 <literal>unalternative_order</literal> command.
8943 <sect1 id="mime-lookup">
8944 <title>MIME Lookup</title>
8947 Mutt-ng's mime_lookup list specifies a list of mime-types that
8949 be treated according to their mailcap entry. This option is designed
8950 todeal with binary types such as application/octet-stream. When an
8952 mime-type is listed in mime_lookup, then the extension of the
8954 be compared to the list of extensions in the mime.types file. The
8956 associated with this extension will then be used to process the
8958 according to the rules in the mailcap file and according to any other
8960 options (such as auto_view) specified. Common usage would be:
8963 mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
8968 In addition, the unmime_lookup command may be used to disable
8970 for any particular mime-type if it had been set, for example, in a
8988 <chapter id="security"> <!--{{{-->
8989 <title>Security Considerations</title>
8992 First of all, mutt-ng contains no security holes included by
8993 intention but may contain unknown security holes. As a consequence,
8994 please run mutt-ng only with as few permissions as possible.
8998 Please do not run mutt-ng as the super user.
9002 When configuring mutt-ng, there're some points to note about secure
9007 In practice, mutt-ng can be easily made as vulnerable as even the
9008 most insecure mail user agents (in their default configuration) just
9009 by changing mutt-ng's configuration files: it then can execute
9010 arbitrary programs and scripts attached to messages, send out private
9011 data on its own, etc. Although this is not believed to the common type
9012 of setup, please read this chapter carefully.
9015 <sect1 id="security-passwords">
9016 <title>Passwords</title>
9019 Although mutt-ng can be told the various passwords for accounts,
9020 please never store passwords in configuration files. Besides the
9021 fact that the system's operator can always read them, you could
9022 forget to replace the actual password with asterisks when reporting
9023 a bug or asking for help via, for example, a mailing list so that
9024 your mail including your password could be archived by internet
9025 search engines, etc. Please never store passwords on disk.
9030 <sect1 id="security-tempfiles">
9031 <title>Temporary Files</title>
9034 Mutt-ng uses many temporary files for viewing messages, verifying
9035 digital signatures, etc. The <link linkend="umask">umask</link>
9036 variable can be used to change the default permissions of these
9037 files. Please only change it if you really know what you are doing.
9038 Also, a different location for these files may be desired which can
9039 be changed via the <link linkend="tmpdir">tmpdir</link> variable.
9044 <sect1 id="security-leaks">
9045 <title>Information Leaks</title>
9047 <sect2 id="security-leaks-mid">
9048 <title>Message-ID: headers</title>
9051 In the default configuration, mutt-ng will leak some information
9052 to the outside world when sending messages: the generation of
9053 <literal>Message-ID:</literal> headers includes a step counter which
9055 (and rotated) with every message sent. If you'd like to hide this
9056 information probably telling others how many mail you sent in which
9057 time, you at least need to remove the <literal>%P</literal>
9059 default setting of the <link linkend="msgid-format">msgid-format</link> variable. Please make sure that
9060 you really know how local parts of these <literal>Message-ID:</literal> headers
9066 <sect2 id="security-leaks-mailto">
9067 <title>mailto:-style links</title>
9070 As mutt-ng be can be set up to be the mail client to handle
9071 <literal>mailto:</literal> style links in websites, there're security
9072 considerations, too. To keep the old behavior by default, mutt-ng
9073 will be strict in interpreting them which means that arbitrary
9074 header fields can be embedded in these links which could override
9075 existing header fields or attach arbitrary files. This may be
9076 problematic if the <link linkend="edit-headers">edit-headers</link>
9077 variable is <emphasis>unset</emphasis>, i.e. the
9078 user doesn't want to see header fields while editing the message.
9082 For example, following a link like
9088 mailto:joe@host?Attach=~/.gnupg/secring.gpg</screen>
9093 will send out the user's private gnupg keyring to <literal>joe@host</literal> if
9094 the user doesn't follow the information on screen carefully
9099 When <emphasis>unsetting</emphasis> the <link linkend="strict-mailto">
9102 variable, mutt-ng will
9111 be less strict when interpreting these links by
9112 prepending a <literal>X-Mailto-</literal> string to all header
9114 embedded in such a link <emphasis>and</emphasis>
9121 turn on the <link linkend="edit-headers">edit-headers</link>
9123 force to let the user see all the headers
9124 (because they still may leak information.)
9137 <sect1 id="security-external">
9138 <title>External applications</title>
9141 Mutt-ng in many places has to rely on external applications or
9142 for convenience supports mechanisms involving external
9146 <sect2 id="security-external-mailcap">
9147 <title>mailcap</title>
9150 One of these is the <literal>mailcap</literal> mechanism as defined
9152 1524. Mutt-ng can be set up to <emphasis>automatically</emphasis>
9154 given utility as listed in one of the mailcap files (see the
9155 <link linkend="mailcap-path">mailcap-path</link>
9156 variable for details.)
9160 These utilities may have a variety of security vulnerabilities,
9161 including overwriting of arbitrary files, information leaks or
9162 other exploitable bugs. These vulnerabilities may go unnoticed by
9163 the user, especially when they are called automatically (and
9164 without interactive prompting) from the mailcap file(s). When
9165 using mutt-ng's autoview mechanism in combination with mailcap
9166 files, please be sure to...
9175 manually select trustworth applications with a reasonable
9183 periodically check the contents of mailcap files,
9184 especially after software installations or upgrades
9191 keep the software packages referenced in the mailcap file up to
9199 leave the <link linkend="mailcap-sanitize">mailcap-sanitize</link> variable in its default
9200 state to restrict mailcap expandos to a safe set of characters
9211 <sect2 id="security-external-other">
9212 <title>Other</title>
9215 Besides the mailcap mechanism, mutt-ng uses a number of other
9216 external utilities for operation.
9220 The same security considerations apply for these as for tools
9221 involved via mailcap (for example, mutt-ng is vulnerable to Denial
9222 of Service Attacks with compressed folders support if the
9223 uncompressed mailbox is too large for the disk it is saved to.)
9227 As already noted, most of these problems are not built in but
9228 caused by wrong configuration, so please check your configuration.
9238 <chapter id="reference"> <!--{{{-->
9239 <title>Reference</title>
9241 <sect1 id="commandline">
9242 <title>Command line options</title>
9245 Running <literal>mutt</literal> with no arguments will make Mutt-ng
9246 attempt to read your spool
9247 mailbox. However, it is possible to read other mailboxes and
9248 to send messages from the command line as well.
9254 <title>Mutt-NG Command Line Options</title>
9255 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9258 <entry>Option</entry>
9259 <entry>Description</entry>
9263 <row><entry><literal>-A </literal></entry><entry>expand an alias</entry></row>
9264 <row><entry><literal>-a </literal></entry><entry>attach a file to a message</entry></row>
9265 <row><entry><literal>-b </literal></entry><entry>specify a blind carbon-copy (BCC) address</entry></row>
9266 <row><entry><literal>-c </literal></entry><entry>specify a carbon-copy (Cc) address</entry></row>
9267 <row><entry><literal>-e </literal></entry><entry>specify a config command to be run after initialization files are read</entry></row>
9268 <row><entry><literal>-f </literal></entry><entry>specify a mailbox to load</entry></row>
9269 <row><entry><literal>-F </literal></entry><entry>specify an alternate file to read initialization commands</entry></row>
9270 <row><entry><literal>-h </literal></entry><entry>print help on command line options</entry></row>
9271 <row><entry><literal>-H </literal></entry><entry>specify a draft file from which to read a header and body</entry></row>
9272 <row><entry><literal>-i </literal></entry><entry>specify a file to include in a message composition</entry></row>
9273 <row><entry><literal>-m </literal></entry><entry>specify a default mailbox type</entry></row>
9274 <row><entry><literal>-n </literal></entry><entry>do not read the system Muttngrc</entry></row>
9275 <row><entry><literal>-p </literal></entry><entry>recall a postponed message</entry></row>
9276 <row><entry><literal>-Q </literal></entry><entry>query a configuration variable</entry></row>
9277 <row><entry><literal>-R </literal></entry><entry>open mailbox in read-only mode</entry></row>
9278 <row><entry><literal>-s </literal></entry><entry>specify a subject (enclose in quotes if it contains spaces)</entry></row>
9279 <row><entry><literal>-t </literal></entry><entry>dump the value of all variables to stdout</entry></row>
9280 <row><entry><literal>-T </literal></entry><entry>dump the value of all changed variables to stdout</entry></row>
9281 <row><entry><literal>-v </literal></entry><entry>show version number and compile-time definitions</entry></row>
9282 <row><entry><literal>-x </literal></entry><entry>simulate the mailx(1) compose mode</entry></row>
9283 <row><entry><literal>-y </literal></entry><entry>show a menu containing the files specified by the mailboxes command</entry></row>
9284 <row><entry><literal>-z </literal></entry><entry>exit immediately if there are no messages in the mailbox</entry></row>
9285 <row><entry><literal>-Z </literal></entry><entry>open the first folder with new message,exit immediately if none</entry></row>
9293 To read messages in a mailbox
9297 <literal>mutt</literal> [ -nz ] [ -F <emphasis>muttrc</emphasis> ] [ -m <emphasis>
9300 ] [ -f <emphasis>mailbox</emphasis> ]
9304 To compose a new message
9308 <literal>mutt</literal> [ -n ] [ -F <emphasis>muttrc</emphasis> ] [ -a <emphasis>
9311 ] [ -c <emphasis>address</emphasis> ] [ -i <emphasis>
9314 ] [ -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> [ <emphasis>
9321 Mutt-ng also supports a ``batch'' mode to send prepared messages.
9323 input from the file you wish to send. For example,
9327 <literal>mutt -s "data set for run #2"
9328 professor@bigschool.edu
9329 < ˜/run2.dat
9334 This command will send a message to ``professor@bigschool.edu'' with a
9336 of ``data set for run #2''. In the body of the message will be the
9338 of the file ``˜/run2.dat''.
9347 <sect1 id="patterns">
9348 <title>Patterns</title>
9352 <table id="tab-patterns">
9353 <title>Patterns</title>
9354 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9357 <entry>Pattern Modifier</entry>
9358 <entry>Argument</entry>
9359 <entry>Description</entry>
9363 <row><entry><literal>~A </literal></entry><entry><literal></literal></entry><entry>all messages</entry></row>
9364 <row><entry><literal>~b </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the message body</entry></row>
9365 <row><entry><literal>~B </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the whole message</entry></row>
9366 <row><entry><literal>~c </literal></entry><entry><literal>EXPR </literal></entry><entry>messages carbon-copied to EXPR</entry></row>
9367 <row><entry><literal>~C </literal></entry><entry><literal>EXPR </literal></entry><entry>message is either to: or cc: EXPR</entry></row>
9368 <row><entry><literal>~D </literal></entry><entry><literal></literal></entry><entry>deleted messages</entry></row>
9369 <row><entry><literal>~d </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with ``date-sent'' in a Date range</entry></row>
9370 <row><entry><literal>~E </literal></entry><entry><literal></literal></entry><entry>expired messages</entry></row>
9371 <row><entry><literal>~e </literal></entry><entry><literal>EXPR </literal></entry><entry>message which contains EXPR in the ``Sender'' field</entry></row>
9372 <row><entry><literal>~F </literal></entry><entry><literal></literal></entry><entry>flagged messages</entry></row>
9373 <row><entry><literal>~f </literal></entry><entry><literal>EXPR </literal></entry><entry>messages originating from EXPR</entry></row>
9374 <row><entry><literal>~g </literal></entry><entry><literal></literal></entry><entry>cryptographically signed messages</entry></row>
9375 <row><entry><literal>~G </literal></entry><entry><literal></literal></entry><entry>cryptographically encrypted messages</entry></row>
9376 <row><entry><literal>~H </literal></entry><entry><literal>EXPR </literal></entry><entry>messages with a spam attribute matching EXPR</entry></row>
9377 <row><entry><literal>~h </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the message header</entry></row>
9378 <row><entry><literal>~k </literal></entry><entry><literal></literal></entry><entry>message contains PGP key material</entry></row>
9379 <row><entry><literal>~i </literal></entry><entry><literal>EXPR </literal></entry><entry>message which match ID in the ``Message-ID'' field</entry></row>
9380 <row><entry><literal>~L </literal></entry><entry><literal>EXPR </literal></entry><entry>message is either originated or received by EXPR</entry></row>
9381 <row><entry><literal>~l </literal></entry><entry><literal></literal></entry><entry>message is addressed to a known mailing list</entry></row>
9382 <row><entry><literal>~m </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>message in the range MIN to MAX *)</entry></row>
9383 <row><entry><literal>~M </literal></entry><entry><literal></literal></entry><entry>multipart messages</entry></row>
9384 <row><entry><literal>~n </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with a score in the range MIN to MAX *)</entry></row>
9385 <row><entry><literal>~N </literal></entry><entry><literal></literal></entry><entry>new messages</entry></row>
9386 <row><entry><literal>~O </literal></entry><entry><literal></literal></entry><entry>old messages</entry></row>
9387 <row><entry><literal>~p </literal></entry><entry><literal></literal></entry><entry>message is addressed to you (consults alternates)</entry></row>
9388 <row><entry><literal>~P </literal></entry><entry><literal></literal></entry><entry>message is from you (consults alternates)</entry></row>
9389 <row><entry><literal>~Q </literal></entry><entry><literal></literal></entry><entry>messages which have been replied to</entry></row>
9390 <row><entry><literal>~R </literal></entry><entry><literal></literal></entry><entry>read messages</entry></row>
9391 <row><entry><literal>~r </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with ``date-received'' in a Date range</entry></row>
9392 <row><entry><literal>~S </literal></entry><entry><literal></literal></entry><entry>superseded messages</entry></row>
9393 <row><entry><literal>~s </literal></entry><entry><literal>EXPR </literal></entry><entry>messages having EXPR in the ``Subject'' field.</entry></row>
9394 <row><entry><literal>~T </literal></entry><entry><literal></literal></entry><entry>tagged messages</entry></row>
9395 <row><entry><literal>~t </literal></entry><entry><literal>EXPR </literal></entry><entry>messages addressed to EXPR</entry></row>
9396 <row><entry><literal>~U </literal></entry><entry><literal></literal></entry><entry>unread messages</entry></row>
9397 <row><entry><literal>~u </literal></entry><entry><literal></literal></entry><entry>message is addressed to a subscribed mailing list</entry></row>
9398 <row><entry><literal>~v </literal></entry><entry><literal></literal></entry><entry>message is part of a collapsed thread.</entry></row>
9399 <row><entry><literal>~V </literal></entry><entry><literal></literal></entry><entry>cryptographically verified messages</entry></row>
9400 <row><entry><literal>~w </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry></row>
9401 <row><entry><literal>~x </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the `References' field</entry></row>
9402 <row><entry><literal>~y </literal></entry><entry><literal>EXPR </literal></entry><entry>messages which contain EXPR in the `X-Label' field</entry></row>
9403 <row><entry><literal>~z </literal></entry><entry><literal>[MIN]-[MAX] </literal></entry><entry>messages with a size in the range MIN to MAX *)</entry></row>
9404 <row><entry><literal>~= </literal></entry><entry><literal></literal></entry><entry>duplicated messages (see $duplicate_threads)</entry></row>
9405 <row><entry><literal>~$ </literal></entry><entry><literal></literal></entry><entry>unreferenced messages (requires threaded view)</entry></row>
9406 <row><entry><literal>~* </literal></entry><entry><literal></literal></entry><entry>``From'' contains realname and (syntactically) valid address (excluded are addresses matching against alternates or any alias)</entry></row>
9414 <link linkend="advanced-regexp">regexp</link>. Special attention has to be
9415 made when using regular expressions inside of patterns. Specifically,
9416 Mutt-ng's parser for these patterns will strip one level of backslash
9418 which is normally used for quoting. If it is your intention to use a
9419 backslash in the regular expression, you will need to use two
9425 *) The forms <literal><[MAX]</literal>, <literal>
9429 <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
9439 <sect1 id="commands">
9440 <title>Configuration Commands</title>
9443 The following are the commands understood by mutt.
9453 <link linkend="account-hook">account-hook</link>
9455 <emphasis>pattern</emphasis> <emphasis>command</emphasis>
9462 <link linkend="alias">alias</link>
9464 <emphasis>key</emphasis> <emphasis>address</emphasis> [ , <emphasis>
9474 <link linkend="alias">alias</link>
9476 [ * | <emphasis>key</emphasis> ... ]
9483 <link linkend="alternates">alternates</link>
9485 <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
9493 <link linkend="alternates">alternates</link>
9495 [ * | <emphasis>regexp</emphasis> ... ]
9502 <link linkend="alternative-order">alternative-order</link>
9504 <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9511 <link linkend="alternative-order">alternative-order</link>
9513 <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9520 <link linkend="append-hook">append-hook</link>
9522 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
9529 <link linkend="auto-view">auto-view</link>
9531 <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9538 <link linkend="auto-view">auto-view</link>
9540 <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9547 <link linkend="bind">bind</link>
9549 <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>
9558 <link linkend="charset-hook">charset-hook</link>
9560 <emphasis>alias</emphasis> <emphasis>charset</emphasis>
9567 <link linkend="close-hook">close-hook</link>
9569 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
9576 <link linkend="color">color</link>
9578 <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>
9581 [ <emphasis>regexp</emphasis> ]
9588 <link linkend="color">color</link>
9590 <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>
9600 <link linkend="exec">exec</link>
9602 <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
9609 <link linkend="fcc-hook">fcc-hook</link>
9611 <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
9618 <link linkend="fcc-save-hook">fcc-save-hook</link>
9620 <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
9627 <link linkend="folder-hook">folder-hook</link>
9629 <emphasis>pattern</emphasis> <emphasis>command</emphasis>
9636 <link linkend="hdr-order">hdr-order</link>
9638 <emphasis>header</emphasis> [ <emphasis>header</emphasis>
9646 <link linkend="hdr-order">hdr-order</link>
9648 <emphasis>header</emphasis> [ <emphasis>header</emphasis>
9656 <link linkend="charset-hook">charset-hook</link>
9658 <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
9665 <link linkend="ignore">ignore</link>
9667 <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
9675 <link linkend="ignore">ignore</link>
9677 <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
9685 <link linkend="lists">lists</link>
9687 <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
9695 <link linkend="lists">lists</link>
9697 <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
9705 <link linkend="macro">macro</link>
9707 <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>
9710 [ <emphasis>description</emphasis> ]
9717 <link linkend="mailboxes">mailboxes</link>
9719 <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
9726 <link linkend="mbox-hook">mbox-hook</link>
9728 <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
9735 <link linkend="message-hook">message-hook</link>
9737 <emphasis>pattern</emphasis> <emphasis>command</emphasis>
9744 <link linkend="mime-lookup">mime-lookup</link>
9746 <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9753 <link linkend="mime-lookup">mime-lookup</link>
9755 <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9762 <link linkend="color">color</link>
9764 <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
9771 <link linkend="color">color</link>
9773 <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>
9783 <link linkend="my-hdr">my-hdr</link>
9785 <emphasis>string</emphasis>
9792 <link linkend="my-hdr">my-hdr</link>
9794 <emphasis>field</emphasis> [ <emphasis>field</emphasis> ...
9802 <link linkend="open-hook">open-hook</link>
9804 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
9811 <link linkend="crypt-hook">crypt-hook</link>
9813 <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
9820 <link linkend="push">push</link>
9822 <emphasis>string</emphasis>
9829 <link linkend="set">set</link>
9831 <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
9839 <link linkend="save-hook">save-hook</link>
9841 <emphasis>regexp</emphasis> <emphasis>filename</emphasis>
9848 <link linkend="score-command">score-command</link>
9850 <emphasis>pattern</emphasis> <emphasis>value</emphasis>
9857 <link linkend="score-command">score-command</link>
9859 <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis>
9867 <link linkend="send-hook">send-hook</link>
9869 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
9876 <link linkend="reply-hook">reply-hook</link>
9878 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
9885 <link linkend="set">set</link>
9887 [no|inv]<emphasis>variable</emphasis>[=<emphasis>
9890 ] [ <emphasis>variable</emphasis> ... ]
9897 <link linkend="set">set</link>
9899 <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
9907 <link linkend="source">source</link>
9909 <emphasis>filename</emphasis>
9916 <link linkend="spam">spam</link>
9918 <emphasis>pattern</emphasis> <emphasis>format</emphasis>
9925 <link linkend="spam">spam</link>
9927 <emphasis>pattern</emphasis>
9934 <link linkend="lists">lists</link>
9936 <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
9944 <link linkend="lists">lists</link>
9946 <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis>
9954 <link linkend="set">set</link>
9956 <emphasis>variable</emphasis> [<emphasis>variable</emphasis>
9964 <link linkend="unhook">unhook</link>
9966 <emphasis>hook-type</emphasis>
9976 <sect1 id="variables">
9977 <title>Configuration variables</title>
9980 The following list contains all variables which, in the process of
9981 providing more consistency, have been renamed and are partially even
9982 removed already. The left column contains the old synonym variables,
9983 the right column the full/new name:
9987 <anchor id="sect-obsolete"/>
9990 <title>Obsolete Variables</title>
9991 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9994 <entry>Old Name</entry>
9995 <entry>New Name</entry>
9999 <row><entry><literal>edit_hdrs</literal></entry><entry><literal>edit_headers</literal></entry></row>
10000 <row><entry><literal>forw_decode</literal></entry><entry><literal>forward_decode</literal></entry></row>
10001 <row><entry><literal>forw_format</literal></entry><entry><literal>forward_format</literal></entry></row>
10002 <row><entry><literal>forw_quote</literal></entry><entry><literal>forward_quote</literal></entry></row>
10003 <row><entry><literal>hdr_format</literal></entry><entry><literal>index_format</literal></entry></row>
10004 <row><entry><literal>indent_str</literal></entry><entry><literal>indent_string</literal></entry></row>
10005 <row><entry><literal>mime_fwd</literal></entry><entry><literal>mime_forward</literal></entry></row>
10006 <row><entry><literal>msg_format</literal></entry><entry><literal>message_format</literal></entry></row>
10007 <row><entry><literal>pgp_autosign</literal></entry><entry><literal>crypt_autosign</literal></entry></row>
10008 <row><entry><literal>pgp_autoencrypt</literal></entry><entry><literal>crypt_autoencrypt</literal></entry></row>
10009 <row><entry><literal>pgp_replyencrypt</literal></entry><entry><literal>crypt_replyencrypt</literal></entry></row>
10010 <row><entry><literal>pgp_replysign</literal></entry><entry><literal>crypt_replysign</literal></entry></row>
10011 <row><entry><literal>pgp_replysignencrypted</literal></entry><entry><literal>crypt_replysignencrypted</literal></entry></row>
10012 <row><entry><literal>pgp_verify_sig</literal></entry><entry><literal>crypt_verify_sig</literal></entry></row>
10013 <row><entry><literal>pgp_create_traditional</literal></entry><entry><literal>pgp_autoinline</literal></entry></row>
10014 <row><entry><literal>pgp_auto_traditional</literal></entry><entry><literal>pgp_replyinline</literal></entry></row>
10015 <row><entry><literal>forw_decrypt</literal></entry><entry><literal>forward_decrypt</literal></entry></row>
10016 <row><entry><literal>smime_sign_as</literal></entry><entry><literal>smime_default_key</literal></entry></row>
10017 <row><entry><literal>post_indent_str</literal></entry><entry><literal>post_indent_string</literal></entry></row>
10018 <row><entry><literal>print_cmd</literal></entry><entry><literal>print_command</literal></entry></row>
10019 <row><entry><literal>shorten_hierarchy</literal></entry><entry><literal>sidebar_shorten_hierarchy</literal></entry></row>
10020 <row><entry><literal>ask_followup_to</literal></entry><entry><literal>nntp_ask_followup_to</literal></entry></row>
10021 <row><entry><literal>ask_x_comment_to</literal></entry><entry><literal>nntp_ask_x_comment_to</literal></entry></row>
10022 <row><entry><literal>catchup_newsgroup</literal></entry><entry><literal>nntp_catchup</literal></entry></row>
10023 <row><entry><literal>followup_to_poster</literal></entry><entry><literal>nntp_followup_to_poster</literal></entry></row>
10024 <row><entry><literal>group_index_format</literal></entry><entry><literal>nntp_group_index_format</literal></entry></row>
10025 <row><entry><literal>inews</literal></entry><entry><literal>nntp_inews</literal></entry></row>
10026 <row><entry><literal>mime_subject</literal></entry><entry><literal>nntp_mime_subject</literal></entry></row>
10027 <row><entry><literal>news_cache_dir</literal></entry><entry><literal>nntp_cache_dir</literal></entry></row>
10028 <row><entry><literal>news_server</literal></entry><entry><literal>nntp_host</literal></entry></row>
10029 <row><entry><literal>newsrc</literal></entry><entry><literal>nntp_newsrc</literal></entry></row>
10030 <row><entry><literal>nntp_poll</literal></entry><entry><literal>nntp_mail_check</literal></entry></row>
10031 <row><entry><literal>pop_checkinterval</literal></entry><entry><literal>pop_mail_check</literal></entry></row>
10032 <row><entry><literal>post_moderated</literal></entry><entry><literal>nntp_post_moderated</literal></entry></row>
10033 <row><entry><literal>save_unsubscribed</literal></entry><entry><literal>nntp_save_unsubscribed</literal></entry></row>
10034 <row><entry><literal>show_new_news</literal></entry><entry><literal>nntp_show_new_news</literal></entry></row>
10035 <row><entry><literal>show_only_unread</literal></entry><entry><literal>nntp_show_only_unread</literal></entry></row>
10036 <row><entry><literal>x_comment_to</literal></entry><entry><literal>nntp_x_comment_to</literal></entry></row>
10037 <row><entry><literal>smtp_auth_username</literal></entry><entry><literal>smtp_user</literal></entry></row>
10038 <row><entry><literal>smtp_auth_password</literal></entry><entry><literal>smtp_pass</literal></entry></row>
10039 <row><entry><literal>user_agent</literal></entry><entry><literal>agent_string</literal></entry></row>
10047 The <literal>contrib</literal> subdirectory contains a script named
10048 <literal>update-config.pl</literal> which eases migration.
10052 A complete list of current variables follows.