1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- THIS FILE IST NOT VALID DOCBOOK ! DTD REMOVED -->
3 <!-- Please don't use html entities like [, ] ^ -->
4 <!-- etc. they don't work with xml! -->
5 <book xmlns:muttng-doc="http://mutt-ng.berlios.de/doc/#NS">
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 @VERSION@</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 <muttng-doc:web url="http://www.muttng.org/"/>
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 <muttng-doc:web url="http://mutt-ng.berlios.de/snapshots/"/>
123 Visit channel <emphasis>#muttng</emphasis> on <ulink
124 url="http://www.freenode.net/">irc.freenode.net
125 (www.freenode.net) </ulink> to chat with other people
126 interested in Mutt-ng.
132 <title>Weblog</title>
135 If you want to read fresh news about the latest development in
136 Mutt-ng, and get informed about stuff like interesting,
137 Mutt-ng-related articles and packages for your favorite
138 distribution, you can read and/or subscribe to our <ulink
139 url="http://mutt-ng.supersized.org/">Mutt-ng development
145 <sect1 id="copyright">
146 <title>Copyright</title>
149 Mutt is Copyright (C) 1996-2000 Michael R. Elkins
150 <me@cs.hmc.edu> and others
154 This program is free software; you can redistribute it and/or modify
155 it under the terms of the GNU General Public License as published by
156 the Free Software Foundation; either version 2 of the License, or
157 (at your option) any later version.
161 This program is distributed in the hope that it will be useful,
162 but WITHOUT ANY WARRANTY; without even the implied warranty of
163 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
164 GNU General Public License for more details.
168 You should have received a copy of the GNU General Public License
169 along with this program; if not, write to the Free Software
170 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
175 <sect1 id="conventions">
176 <title>Manual Conventions</title>
179 This manual contains several (hopefully consistent) conventions to
180 specially layout different items in different fashions.
186 <para>Configuration and environment variables will be printed
187 in a typewriter font and both prefixed with a dollar sign as
188 it's common for UNIX-like environments. Configuration
189 variables are lower-case only while environment variables
190 are upper-case only. <muttng-doc:varref
191 name="imap-mail-check"/> is a configuration variable while
192 <muttng-doc:envvar name="EDITOR"/> is an environment
196 <para>Muttng-specific functions are enclosed in
197 <literal><></literal> and printed in a typewriter font,
198 too, as in <muttng-doc:funcref name="sync-mailbox"/>.</para>
201 <para>As common for UNIX-like environments, references to
202 manual pages are printed with the section enclosed in
203 braces, as in <muttng-doc:man name="vi"/> or <muttng-doc:man
204 name="muttngrc" sect="5"/>. Execute <literal>man [section]
205 [name]</literal> to view the manual page.</para>
208 <para>Keys are presented in the following way: ordinary keys
209 are just given as-is, e.g.
210 <muttng-doc:key>q</muttng-doc:key>. Control characters are
211 prefixed with <literal>C-</literal> (e.g. the screen can be
212 redraw by pressing <muttng-doc:key
213 mod="C">L</muttng-doc:key>) and <literal>E-</literal> for
214 Escape, e.g. a folder can be opened read-only with
215 <muttng-doc:key mod="E">c</muttng-doc:key>.
222 If, while reading this fine manual, you find any inconsistencies
223 of whatever kind, please contact the developers via
224 <email>mutt-ng-devel@lists.berlios.de</email> to report it.
232 <chapter id="getting-started"> <!--{{{-->
233 <title>Getting Started</title>
235 <sect1 id="basic-concepts"> <!--{{{-->
236 <title>Basic Concepts</title>
238 <sect2 id="concept-screens-and-menus"> <!--{{{-->
239 <title>Screens and Menus</title>
242 mutt-ng offers different screens of which every has its special
252 The <emphasis>index</emphasis> displays the contents of the
261 The <emphasis>pager</emphasis> is responsible for displaying
263 is, the header, the body and all attached parts.
270 The <emphasis>file browser</emphasis> offers operations on and
272 information of all folders mutt-ng should watch for mail.
279 The <emphasis>sidebar</emphasis> offers a permanent view of
281 contain how many total, new and/or flagged mails.
288 The <emphasis>help screen</emphasis> lists for all currently
290 commands how to invoke them as well as a short description.
297 The <emphasis>compose</emphasis> menu is a comfortable
299 actions before sending mail: change subjects, attach files,
308 The <emphasis>attachement</emphasis> menu gives a summary and
310 structure of the attachements of the current message.
317 The <emphasis>alias</emphasis> menu lists all or a fraction of
326 The <emphasis>key</emphasis> menu used in connection with
328 users choose the right key to encrypt with.
338 When mutt-ng is started without any further options, it'll open
339 the users default mailbox and display the index.
349 <sect2 id="concept-configuration"> <!--{{{-->
350 <title>Configuration</title>
353 Mutt-ng does <emphasis>not</emphasis> feature an internal
355 interface or menu due to the simple fact that this would be too
356 complex to handle (currently there are several <emphasis>hundred</emphasis>
357 variables which fine-tune the behaviour.)
361 Mutt-ng is configured using configuration files which allow
362 users to add comments or manage them via version control systems
367 Also, mutt-ng comes with a shell script named <literal>grml-muttng</literal>
368 kindly contributed by users which really helps and eases the
369 creation of a user's configuration file. When downloading the
370 source code via a snapshot or via subversion, it can be found in
371 the <literal>contrib</literal> directory.
381 <sect2 id="concept-functions"> <!--{{{-->
382 <title>Functions</title>
385 Mutt-ng offers great flexibility due to the use of functions:
386 internally, every action a user can make mutt-ng perform is named
387 ``function.'' Those functions are assigned to keys (or even key
388 sequences) and may be completely adjusted to user's needs. The
389 basic idea is that the impatient users get a very intuitive
390 interface to start off with and advanced users virtually get no
391 limits to adjustments.
401 <sect2 id="concept-interaction"> <!--{{{-->
402 <title>Interaction</title>
405 Mutt-ng has two basic concepts of user interaction:
414 There is one dedicated line on the screen used to query
415 the user for input, issue any command, query variables and
416 display error and informational messages. As for every type of
417 user input, this requires manual action leading to the need of
425 The automatized interface for interaction are the so
426 called <emphasis>hooks</emphasis>. Hooks specify actions the
428 performed at well-defined situations: what to do when entering
429 which folder, what to do when displaying or replying to what
430 kind of message, etc. These are optional, i.e. a user doesn't
431 need to specify them but can do so.
447 <sect2 id="concept-modularization"> <!--{{{-->
448 <title>Modularization</title>
451 Although mutt-ng has many functionality built-in, many
452 features can be delegated to external tools to increase
453 flexibility: users can define programs to filter a message through
454 before displaying, users can use any program they want for
455 displaying a message, message types (such as PDF or PostScript)
456 for which mutt-ng doesn't have a built-in filter can be rendered
457 by arbitrary tools and so forth. Although mutt-ng has an alias
458 mechanism built-in, it features using external tools to query for
459 nearly every type of addresses from sources like LDAP, databases
460 or just the list of locally known users.
470 <sect2 id="concept-patterns"> <!--{{{-->
471 <title>Patterns</title>
474 Mutt-ng has a built-in pattern matching ``language'' which is
475 as widely used as possible to present a consistent interface to
476 users. The same ``pattern terms'' can be used for searching,
477 scoring, message selection and much more.
495 <sect1 id="screens-and-menus"> <!--{{{-->
496 <title>Screens and Menus</title>
498 <sect2 id="intro-index">
502 The index is the screen that you usually see first when you
503 start mutt-ng. It gives an overview over your emails in the
504 currently opened mailbox. By default, this is your system mailbox.
505 The information you see in the index is a list of emails, each with
506 its number on the left, its flags (new email, important email,
507 email that has been forwarded or replied to, tagged email, ...),
508 the date when email was sent, its sender, the email size, and the
509 subject. Additionally, the index also shows thread hierarchies:
510 when you reply to an email, and the other person replies back, you
511 can see the other's person email in a "sub-tree" below. This is
512 especially useful for personal email between a group of people or
513 when you've subscribed to mailing lists.
522 <sect2 id="intro-pager">
526 The pager is responsible for showing the email content. On the
527 top of the pager you have an overview over the most important email
528 headers like the sender, the recipient, the subject, and much more
529 information. How much information you actually see depends on your
530 configuration, which we'll describe below.
534 Below the headers, you see the email body which usually contains
535 the message. If the email contains any attachments, you will see
536 more information about them below the email body, or, if the
537 attachments are text files, you can view them directly in the
542 To give the user a good overview, it is possible to configure
543 mutt-ng to show different things in the pager with different
544 colors. Virtually everything that can be described with a regular
545 expression can be colored, e.g. URLs, email addresses or smileys.
554 <sect2 id="intro-browser">
555 <title>File Browser</title>
558 The file browser is the interface to the local or remote
559 file system. When selecting a mailbox to open, the browser allows
560 custom sorting of items, limiting the items shown by a regular
561 expression and a freely adjustable format of what to display in
562 which way. It also allows for easy navigation through the
563 file system when selecting file(s) to attach to a message, select
564 multiple files to attach and many more.
573 <sect2 id="intro-sidebar">
574 <title>Sidebar</title>
577 The sidebar comes in handy to manage mails which are spread
578 over different folders. All folders users setup mutt-ng to watch
579 for new mail will be listed. The listing includes not only the
580 name but also the number of total messages, the number of new and
581 flagged messages. Items with new mail may be colored different
582 from those with flagged mail, items may be shortened or compress
583 if they're they to long to be printed in full form so that by
584 abbreviated names, user still now what the name stands for.
593 <sect2 id="intro-help">
597 The help screen is meant to offer a quick help to the user. It
598 lists the current configuration of key bindings and their
599 associated commands including a short description, and currently
600 unbound functions that still need to be associated with a key
601 binding (or alternatively, they can be called via the mutt-ng
611 <sect2 id="intro-compose">
612 <title>Compose Menu</title>
615 The compose menu features a split screen containing the
616 information which really matter before actually sending a
617 message by mail or posting an article to a newsgroup: who gets
618 the message as what (recipient, newsgroup, who gets what kind of
619 copy). Additionally, users may set security options like
620 deciding whether to sign, encrypt or sign and encrypt a message
625 Also, it's used to attach messages, news articles or files to
626 a message, to re-edit any attachment including the message
636 <sect2 id="intro-alias">
637 <title>Alias Menu</title>
640 The alias menu is used to help users finding the recipients
641 of messages. For users who need to contact many people, there's
642 no need to remember addresses or names completely because it
643 allows for searching, too. The alias mechanism and thus the
644 alias menu also features grouping several addresses by a shorter
645 nickname, the actual alias, so that users don't have to select
646 each single recipient manually.
655 <sect2 id="intro-attach">
656 <title>Attachment Menu</title>
659 As will be later discussed in detail, mutt-ng features a good
660 and stable MIME implementation, that is, is greatly supports
661 sending and receiving messages of arbitrary type. The
662 attachment menu displays a message's structure in detail: what
663 content parts are attached to which parent part (which gives a
664 true tree structure), which type is of what type and what size.
665 Single parts may saved, deleted or modified to offer great and
666 easy access to message's internals.
675 <sect2 id="intro-keysel">
676 <title>Key Menu</title>
679 <literal>FIXME</literal>
695 <sect1 id="moving"> <!--{{{-->
696 <title>Moving Around in Menus</title>
699 Information is presented in menus, very similar to ELM. Here is a
700 tableshowing the common keys used to navigate menus in Mutt-ng.
705 <table frame="none" rowsep="1" texstr="l|l|l">
706 <title>Most commonly used movement bindings</title>
707 <tgroup cols="3" align="left" colsep="1" rowsep="1">
711 <entry>Function</entry>
712 <entry>Description</entry>
717 <entry><muttng-doc:key>j</muttng-doc:key> or <muttng-doc:key>Down</muttng-doc:key></entry>
718 <entry><muttng-doc:funcref name="next-entry"/></entry>
719 <entry>move to the next entry</entry>
722 <entry><muttng-doc:key>k</muttng-doc:key> or <muttng-doc:key>Up</muttng-doc:key></entry>
723 <entry><muttng-doc:funcref name="previous-entry"/></entry>
724 <entry>move to the previous entry</entry>
727 <entry><muttng-doc:key>z</muttng-doc:key> or <muttng-doc:key>PageDn</muttng-doc:key></entry>
728 <entry><muttng-doc:funcref name="page-down"/></entry>
729 <entry>go to the next page</entry>
732 <entry><muttng-doc:key>Z</muttng-doc:key> or <muttng-doc:key>PageUp</muttng-doc:key></entry>
733 <entry><muttng-doc:funcref name="page-up"/></entry>
734 <entry>go to the previous page</entry>
737 <entry><muttng-doc:key>=</muttng-doc:key> or <muttng-doc:key>Home</muttng-doc:key></entry>
738 <entry><muttng-doc:funcref name="first-entry"/></entry>
739 <entry>jump to the first entry</entry>
742 <entry><muttng-doc:key>*</muttng-doc:key> or <muttng-doc:key>End</muttng-doc:key></entry>
743 <entry><muttng-doc:funcref name="last-entry"/></entry>
744 <entry>jump to the last entry</entry>
747 <entry><muttng-doc:key>q</muttng-doc:key></entry>
748 <entry><muttng-doc:funcref name="quit"/></entry>
749 <entry>exit the current menu</entry>
752 <entry><muttng-doc:key>?</muttng-doc:key></entry>
753 <entry><muttng-doc:funcref name="help"/></entry>
754 <entry>list all key bindings for the current menu</entry>
770 <sect1 id="editing"> <!--{{{-->
771 <title>Editing Input Fields</title>
774 Mutt-ng has a builtin line editor which is used as the primary way to
776 textual data such as email addresses or filenames. The keys used to
778 around while editing are very similar to those of Emacs.
783 <table frame="none" rowsep="1" texstr="l|l|l">
784 <title>Line Editor Functions</title>
785 <tgroup cols="3" align="left" colsep="1" rowsep="1">
789 <entry>Function</entry>
790 <entry>Description</entry>
795 <entry><muttng-doc:key mod="C">A</muttng-doc:key> or <muttng-doc:key>Home</muttng-doc:key></entry>
796 <entry><muttng-doc:funcref name="bol"/></entry>
797 <entry>move to the start of the line</entry>
800 <entry><muttng-doc:key mod="C">B</muttng-doc:key> or <muttng-doc:key>Left</muttng-doc:key></entry>
801 <entry><muttng-doc:funcref name="backward-char"/>
802 </entry><entry>move back one char</entry>
805 <entry><muttng-doc:key mod="E">B</muttng-doc:key></entry>
806 <entry><muttng-doc:funcref name="backward-word"/></entry>
807 <entry>move back one word</entry>
810 <entry><muttng-doc:key mod="C">D</muttng-doc:key> or <muttng-doc:key>Delete</muttng-doc:key></entry>
811 <entry><muttng-doc:funcref name="delete-char"/></entry>
812 <entry>delete the char under the cursor</entry>
815 <entry><muttng-doc:key mod="C">E</muttng-doc:key> or <muttng-doc:key>End</muttng-doc:key></entry>
816 <entry><muttng-doc:funcref name="eol"/></entry>
817 <entry>move to the end of the line</entry>
820 <entry><muttng-doc:key mod="C">F</muttng-doc:key> or <muttng-doc:key>Right</muttng-doc:key></entry>
821 <entry><muttng-doc:funcref name="forward-char"/></entry>
822 <entry>move forward one char</entry>
825 <entry><muttng-doc:key mod="E">F</muttng-doc:key></entry>
826 <entry><muttng-doc:funcref name="forward-word"/></entry>
827 <entry>move forward one word</entry>
830 <entry><muttng-doc:key>Tab</muttng-doc:key></entry>
831 <entry><muttng-doc:funcref name="complete"/></entry>
832 <entry>complete filename or alias</entry>
835 <entry><muttng-doc:key mod="C">T</muttng-doc:key></entry>
836 <entry><muttng-doc:funcref name="complete-query"/></entry>
837 <entry>complete address with query</entry>
840 <entry><muttng-doc:key mod="C">K</muttng-doc:key></entry>
841 <entry><muttng-doc:funcref name="kill-eol"/></entry>
842 <entry>delete to the end of the line</entry>
845 <entry><muttng-doc:key mod="E">d</muttng-doc:key></entry>
846 <entry><muttng-doc:funcref name="kill-eow"/></entry>
847 <entry>delete to the end of the word</entry>
850 <entry><muttng-doc:key mod="C">W</muttng-doc:key></entry>
851 <entry><muttng-doc:funcref name="kill-word"/></entry>
852 <entry>kill the word in front of the cursor</entry>
855 <entry><muttng-doc:key mod="C">U</muttng-doc:key></entry>
856 <entry><muttng-doc:funcref name="kill-line"/></entry>
857 <entry>delete entire line</entry>
860 <entry><muttng-doc:key mod="C">V</muttng-doc:key></entry>
861 <entry><muttng-doc:funcref name="quote-char"/></entry>
862 <entry>quote the next typed key</entry>
865 <entry><muttng-doc:key>Up</muttng-doc:key></entry>
866 <entry><muttng-doc:funcref name="history-up"/></entry>
867 <entry>recall previous string from history</entry>
870 <entry><muttng-doc:key>Down</muttng-doc:key></entry>
871 <entry><muttng-doc:funcref name="history-down"/></entry>
872 <entry>recall next string from history</entry>
875 <entry><muttng-doc:key>BackSpace</muttng-doc:key></entry>
876 <entry><muttng-doc:funcref name="backspace"/></entry>
877 <entry>kill the char in front of the cursor</entry>
880 <entry><muttng-doc:key mod="E">u</muttng-doc:key></entry>
881 <entry><muttng-doc:funcref name="upcase-word"/></entry>
882 <entry>convert word to upper case</entry>
885 <entry><muttng-doc:key mod="E">l</muttng-doc:key></entry>
886 <entry><muttng-doc:funcref name="downcase-word"/></entry>
887 <entry>convert word to lower case</entry>
890 <entry><muttng-doc:key mod="E">c</muttng-doc:key></entry>
891 <entry><muttng-doc:funcref name="capitalize-word"/></entry>
892 <entry>capitalize the word</entry>
895 <entry><muttng-doc:key mod="C">G</muttng-doc:key></entry>
900 <entry><muttng-doc:key>Return</muttng-doc:key></entry>
902 <entry>finish editing</entry>
911 You can remap the <emphasis>editor</emphasis> functions using the
912 <muttng-doc:cmdref name="bind"/> command. For example, to make
913 the <emphasis>Delete</emphasis> key delete the character in front
914 of the cursor rather than under, you could use
918 <literal>bind editor <delete> backspace</literal>
924 <sect1 id="reading"> <!--{{{-->
925 <title>Reading Mail - The Index and Pager</title>
928 Similar to many other mail clients, there are two modes in which mail
929 isread in Mutt-ng. The first is the index of messages in the mailbox,
931 called the ``index'' in Mutt-ng. The second mode is the display of the
932 message contents. This is called the ``pager.''
936 The next few sections describe the functions provided in each of these
940 <sect2 id="reading-index">
941 <title>The Message Index</title>
945 <table frame="none" rowsep="1" texstr="l|l|l">
946 <title>Most commonly used Index Bindings</title>
947 <tgroup cols="3" align="left" colsep="1" rowsep="1">
951 <entry>Function</entry>
952 <entry>Description</entry>
957 <entry><muttng-doc:key>c</muttng-doc:key></entry>
958 <entry><literal></literal></entry>
959 <entry>change to a different mailbox</entry>
962 <entry><muttng-doc:key mod="E">c</muttng-doc:key></entry>
963 <entry><literal></literal></entry>
964 <entry>change to a folder in read-only mode</entry>
967 <entry><muttng-doc:key>C</muttng-doc:key></entry>
968 <entry><literal></literal></entry>
969 <entry>copy the current message to another mailbox</entry>
972 <entry><muttng-doc:key mod="E">C</muttng-doc:key></entry>
973 <entry><literal></literal></entry>
974 <entry>decode a message and copy it to a folder</entry>
977 <entry><muttng-doc:key mod="E">s</muttng-doc:key></entry>
978 <entry><literal></literal></entry>
979 <entry>decode a message and save it to a folder</entry>
982 <entry><muttng-doc:key>D</muttng-doc:key></entry>
983 <entry><literal></literal></entry>
984 <entry>delete messages matching a pattern</entry>
987 <entry><muttng-doc:key>d</muttng-doc:key></entry>
988 <entry><literal></literal></entry>
989 <entry>delete the current message</entry>
992 <entry><muttng-doc:key>F</muttng-doc:key></entry>
993 <entry><literal></literal></entry>
994 <entry>mark as important</entry>
997 <entry><muttng-doc:key>l</muttng-doc:key></entry>
998 <entry><literal></literal></entry>
999 <entry>show messages matching a pattern</entry>
1002 <entry><muttng-doc:key>N</muttng-doc:key></entry>
1003 <entry><literal></literal></entry>
1004 <entry>mark message as new</entry>
1007 <entry><muttng-doc:key>o</muttng-doc:key></entry>
1008 <entry><literal></literal></entry>
1009 <entry>change the current sort method</entry>
1012 <entry><muttng-doc:key>O</muttng-doc:key></entry>
1013 <entry><literal></literal></entry>
1014 <entry>reverse sort the mailbox</entry>
1017 <entry><muttng-doc:key>q</muttng-doc:key></entry>
1018 <entry><literal></literal></entry>
1019 <entry>save changes and exit</entry>
1022 <entry><muttng-doc:key>s</muttng-doc:key></entry>
1023 <entry><literal></literal></entry>
1024 <entry>save-message</entry>
1027 <entry><muttng-doc:key>T</muttng-doc:key></entry>
1028 <entry><literal></literal></entry>
1029 <entry>tag messages matching a pattern</entry>
1032 <entry><muttng-doc:key>t</muttng-doc:key></entry>
1033 <entry><literal></literal></entry>
1034 <entry>toggle the tag on a message</entry>
1037 <entry><muttng-doc:key mod="E">t</muttng-doc:key></entry>
1038 <entry><literal></literal></entry>
1039 <entry>toggle tag on entire message thread</entry>
1042 <entry><muttng-doc:key>U</muttng-doc:key></entry>
1043 <entry><literal></literal></entry>
1044 <entry>undelete messages matching a pattern</entry>
1047 <entry><muttng-doc:key>u</muttng-doc:key></entry>
1048 <entry><literal></literal></entry>
1049 <entry>undelete-message</entry>
1052 <entry><muttng-doc:key>v</muttng-doc:key></entry>
1053 <entry><literal></literal></entry>
1054 <entry>view-attachments</entry>
1057 <entry><muttng-doc:key>x</muttng-doc:key></entry>
1058 <entry><literal></literal></entry>
1059 <entry>abort changes and exit</entry>
1062 <entry><muttng-doc:key>Return</muttng-doc:key></entry>
1063 <entry><literal></literal></entry>
1064 <entry>display-message</entry>
1067 <entry><muttng-doc:key>Tab</muttng-doc:key></entry>
1068 <entry><literal></literal></entry>
1069 <entry>jump to the next new or unread message</entry>
1072 <entry><muttng-doc:key>@</muttng-doc:key></entry>
1073 <entry><literal></literal></entry>
1074 <entry>show the author's full e-mail address</entry>
1077 <entry><muttng-doc:key>$</muttng-doc:key></entry>
1078 <entry><literal></literal></entry>
1079 <entry>save changes to mailbox</entry>
1082 <entry><muttng-doc:key>/</muttng-doc:key></entry>
1083 <entry><literal></literal></entry>
1084 <entry>search</entry>
1087 <entry><muttng-doc:key mod="E">/</muttng-doc:key></entry>
1088 <entry><literal></literal></entry>
1089 <entry>search-reverse</entry>
1092 <entry><muttng-doc:key mod="C">L</muttng-doc:key></entry>
1093 <entry><literal></literal></entry>
1094 <entry>clear and redraw the screen</entry>
1097 <entry><muttng-doc:key mod="C">T</muttng-doc:key></entry>
1098 <entry><literal></literal></entry>
1099 <entry>untag messages matching a pattern</entry>
1108 <title>Status Flags</title> <!--{{{-->
1111 In addition to who sent the message and the subject, a short
1113 the disposition of each message is printed beside the message
1115 Zero or more of the following ``flags'' may appear, which mean:
1126 message is deleted (is marked for deletion)
1134 message have attachments marked for deletion
1142 contains a PGP public key
1166 message is PGP encrypted
1174 message has been replied to
1182 message has one or more attachments.
1191 message is signed, and the signature is succesfully
1224 Some of the status flags can be turned on or off using
1230 <emphasis role="bold">set-flag</emphasis> (default: w)
1236 <emphasis role="bold">clear-flag</emphasis> (default: W)
1245 Furthermore, the following flags reflect who the message is
1247 to. They can be customized with the
1248 <muttng-doc:varref name="to-chars"/> variable.
1258 message is to you and you only
1266 message is to you, but also to or cc'ed to others
1274 message is cc'ed to you
1290 message is sent to a subscribed mailing list
1301 <sect2 id="reading-pager">
1302 <title>The Pager</title>
1305 By default, Mutt-ng uses its builtin pager to display the body of
1307 The pager is very similar to the Unix program <emphasis>less</emphasis> though not nearly as
1313 <table frame="none" rowsep="1" texstr="l|l|l">
1314 <title>Most commonly used Pager Bindings</title>
1315 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1319 <entry>Function</entry>
1320 <entry>Description</entry>
1325 <entry><muttng-doc:key>Return</muttng-doc:key></entry>
1326 <entry><literal></literal></entry>
1327 <entry>go down one line</entry>
1330 <entry><muttng-doc:key>Space</muttng-doc:key></entry>
1331 <entry><literal></literal></entry>
1332 <entry>display the next page (or next message if at the end of a message)</entry>
1335 <entry><muttng-doc:key>-</muttng-doc:key></entry>
1336 <entry><literal></literal></entry>
1337 <entry>go back to the previous page</entry>
1340 <entry><muttng-doc:key>n</muttng-doc:key></entry>
1341 <entry><literal></literal></entry>
1342 <entry>search for next match</entry>
1345 <entry><muttng-doc:key>S</muttng-doc:key></entry>
1346 <entry><literal></literal></entry>
1347 <entry>skip beyond quoted text</entry>
1350 <entry><muttng-doc:key>T</muttng-doc:key></entry>
1351 <entry><literal></literal></entry>
1352 <entry>toggle display of quoted text</entry>
1355 <entry><muttng-doc:key>?</muttng-doc:key></entry>
1356 <entry><literal></literal></entry>
1357 <entry>show key bindings</entry>
1360 <entry><muttng-doc:key>/</muttng-doc:key></entry>
1361 <entry><literal></literal></entry>
1362 <entry>search for a regular expression (pattern)</entry>
1365 <entry><muttng-doc:key mod="E">/</muttng-doc:key></entry>
1366 <entry><literal></literal></entry>
1367 <entry>search backwards for a regular expression</entry>
1370 <entry><muttng-doc:key>\</muttng-doc:key></entry>
1371 <entry><literal></literal></entry>
1372 <entry>toggle search pattern coloring</entry>
1375 <entry><muttng-doc:key>^</muttng-doc:key></entry>
1376 <entry><literal></literal></entry>
1377 <entry>jump to the top of the message</entry>
1387 In addition, many of the functions from the <emphasis>index</emphasis> are available in
1388 the pager, such as <emphasis>delete-message</emphasis> or <emphasis>
1392 advantage over using an external pager to view messages).
1396 Also, the internal pager supports a couple other advanced
1397 features. For one, it will accept and translate the
1398 ``standard'' nroff sequences forbold and underline. These
1399 sequences are a series of either the letter, backspace
1400 (<muttng-doc:key mod="C">H</muttng-doc:key>), the letter again for bold
1401 or the letter, backspace, <muttng-doc:key>_</muttng-doc:key> for denoting
1402 underline. Mutt-ng will attempt to display these in bold and
1403 underline respectively if your terminal supports them. If not,
1404 you can use the bold and underline <muttng-doc:cmdref
1405 name="color"/> objects to specify a color or mono attribute
1410 Additionally, the internal pager supports the ANSI escape
1411 sequences for character attributes. Mutt-ng translates them
1412 into the correct color and character settings. The sequences
1413 Mutt-ng supports are: <literal>ESC [ Ps;Ps;Ps;...;Ps
1414 m</literal> (see table below for possible values for
1415 <literal>Ps</literal>).
1420 <table frame="none" rowsep="1" texstr="l|l">
1421 <title>ANSI Escape Sequences</title>
1422 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1425 <entry>Value</entry>
1426 <entry>Attribute</entry>
1431 <entry><literal>0</literal></entry>
1432 <entry>All Attributes Off</entry>
1435 <entry><literal>1</literal></entry>
1436 <entry>Bold on</entry>
1439 <entry><literal>4</literal></entry>
1440 <entry>Underline on</entry>
1443 <entry><literal>5</literal></entry>
1444 <entry>Blink on</entry>
1447 <entry><literal>7</literal></entry>
1448 <entry>Reverse video on</entry>
1451 <entry><literal>3x</literal></entry>
1452 <entry>Foreground color is x (see table below)</entry>
1455 <entry><literal>4x</literal></entry>
1456 <entry>Background color is x (see table below)</entry>
1463 <table frame="none" rowsep="1" texstr="l|l">
1464 <title>ANSI Colors</title>
1465 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1468 <entry>Number</entry>
1469 <entry>Color</entry>
1474 <entry><literal>0</literal></entry>
1475 <entry>black</entry>
1478 <entry><literal>1</literal></entry>
1482 <entry><literal>2</literal></entry>
1483 <entry>green</entry>
1486 <entry><literal>3</literal></entry>
1487 <entry>yellow</entry>
1490 <entry><literal>4</literal></entry>
1494 <entry><literal>5</literal></entry>
1495 <entry>magenta</entry>
1498 <entry><literal>6</literal></entry>
1502 <entry><literal>7</literal></entry>
1503 <entry>white</entry>
1513 Mutt-ng uses these attributes for handling text/enriched messages,
1515 can also be used by an external <muttng-doc:cmdref name="auto_view"/>
1516 script for highlighting purposes. <emphasis role="bold">Note:</emphasis> If you change the colors for your
1517 display, for example by changing the color associated with color2 for
1518 your xterm, then that color will be used instead of green.
1523 <sect2 id="threads">
1524 <title>Threaded Mode</title>
1527 When the mailbox is <link linkend="sort">sorted</link> by <emphasis>
1531 a few additional functions available in the <emphasis>index</emphasis> and <emphasis>
1539 <table frame="none" rowsep="1" texstr="l|l|l">
1540 <title>Most commonly used thread-related bindings</title>
1541 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1545 <entry>Function</entry>
1546 <entry>Description</entry>
1551 <entry><muttng-doc:key mod="C">D</muttng-doc:key></entry>
1552 <entry><muttng-doc:funcref name="delete-thread"/></entry>
1553 <entry>delete all messages in the current thread</entry>
1556 <entry><muttng-doc:key mod="C">U</muttng-doc:key></entry>
1557 <entry><muttng-doc:funcref name="undelete-thread"/></entry>
1558 <entry>undelete all messages in the current thread</entry>
1561 <entry><muttng-doc:key mod="C">N</muttng-doc:key></entry>
1562 <entry><muttng-doc:funcref name="next-thread"/></entry>
1563 <entry>jump to the start of the next thread</entry>
1566 <entry><muttng-doc:key mod="C">P</muttng-doc:key></entry>
1567 <entry><muttng-doc:funcref name="previous-thread"/></entry>
1568 <entry>jump to the start of the previous thread</entry>
1571 <entry><muttng-doc:key mod="C">R</muttng-doc:key></entry>
1572 <entry><muttng-doc:funcref name="read-thread"/></entry>
1573 <entry>mark the current thread as read</entry>
1576 <entry><muttng-doc:key mod="E">d</muttng-doc:key></entry>
1577 <entry><muttng-doc:funcref name="delete-subthread"/></entry>
1578 <entry>delete all messages in the current subthread</entry>
1581 <entry><muttng-doc:key mod="E">u</muttng-doc:key></entry>
1582 <entry><muttng-doc:funcref name="undelete-subthread"/></entry>
1583 <entry>undelete all messages in the current subthread</entry>
1586 <entry><muttng-doc:key mod="E">n</muttng-doc:key></entry>
1587 <entry><muttng-doc:funcref name="next-subthread"/></entry>
1588 <entry>jump to the start of the next subthread</entry>
1591 <entry><muttng-doc:key mod="E">p</muttng-doc:key></entry>
1592 <entry><muttng-doc:funcref name="previous-subthread"/></entry>
1593 <entry>jump to the start of the previous subthread</entry>
1596 <entry><muttng-doc:key mod="E">r</muttng-doc:key></entry>
1597 <entry><muttng-doc:funcref name="read-subthread"/></entry>
1598 <entry>mark the current subthread as read </entry>
1601 <entry><muttng-doc:key mod="E">t</muttng-doc:key></entry>
1602 <entry><muttng-doc:funcref name="tag-thread"/></entry>
1603 <entry>toggle the tag on the current thread</entry>
1606 <entry><muttng-doc:key mod="E">v</muttng-doc:key></entry>
1607 <entry><muttng-doc:funcref name="collapse-thread"/></entry>
1608 <entry>toggle collapse for the current thread</entry>
1611 <entry><muttng-doc:key mod="E">V</muttng-doc:key></entry>
1612 <entry><muttng-doc:funcref name="collapse-all"/></entry>
1613 <entry>toggle collapse for all threads</entry>
1616 <entry><muttng-doc:key>P</muttng-doc:key></entry>
1617 <entry><muttng-doc:funcref name="parent-message"/></entry>
1618 <entry>jump to parent message in thread</entry>
1628 <emphasis role="bold">Note:</emphasis> Collapsing a thread displays
1629 only the first message
1630 in the thread and hides the others. This is useful when threads
1631 contain so many messages that you can only see a handful of threads
1632 onthe screen. See <literal>%M</literal> in
1633 <muttng-doc:varref name="index-format"/>.
1637 For example, you could use
1638 <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index-format"/>
1640 display the number of hidden messages if the thread is collapsed.
1644 See also the <muttng-doc:varref name="strict-threads"/> variable.
1649 <sect2 id="pager-functions">
1650 <title>Miscellaneous Functions</title>
1653 <muttng-doc:funcdef name="create-alias"><muttng-doc:key>a</muttng-doc:key></muttng-doc:funcdef>
1657 Creates a new alias based upon the current message (or prompts for a
1658 new one). Once editing is complete, an <muttng-doc:cmdref name="alias"/>
1659 command is added to the file specified by the <muttng-doc:varref name="alias-file"/>
1660 variable for future use. <emphasis role="bold">Note:</emphasis>
1661 Specifying an <muttng-doc:varref name="alias-file"/>
1662 does not add the aliases specified there-in, you must also <muttng-doc:cmdref name="source"/>
1667 <muttng-doc:funcdef name="check-traditional-pgp"><muttng-doc:key mod="E">P</muttng-doc:key></muttng-doc:funcdef>
1671 This function will search the current message for content signed or
1672 encrypted with PGP the "traditional" way, that is, without proper
1673 MIME tagging. Technically, this function will temporarily change
1674 the MIME content types of the body parts containing PGP data; this
1675 is similar to the <muttng-doc:funcref name="edit-type"/>
1681 <muttng-doc:funcdef name="display-toggle-weed"><muttng-doc:key>h</muttng-doc:key></muttng-doc:funcdef>
1685 Toggles the weeding of message header fields specified by <muttng-doc:cmdref name="ignore"/>
1690 <muttng-doc:funcdef name="edit"><muttng-doc:key>e</muttng-doc:key></muttng-doc:funcdef>
1694 This command (available in the ``index'' and ``pager'') allows you to
1695 edit the raw current message as it's present in the mail folder.
1696 After you have finished editing, the changed message will be
1697 appended to the current folder, and the original message will be
1698 marked for deletion.
1702 <muttng-doc:funcdef name="edit-type"/>
1703 (default: <muttng-doc:key mod="C">E</muttng-doc:key> on the attachment menu, and in the pager and index
1704 menus; <muttng-doc:key mod="C">T</muttng-doc:key> on the compose menu)
1708 This command is used to temporarily edit an attachment's content
1709 type to fix, for instance, bogus character set parameters. When
1710 invoked from the index or from the pager, you'll have the
1711 opportunity to edit the top-level attachment's content type. On the
1712 <link linkend="attach-menu">attach-menu</link>, you can change any
1713 attachment's content type. These changes are not persistent, and get
1714 lost upon changing folders.
1718 Note that this command is also available on the <link linkend="compose-menu">compose-menu</link>
1719 .There, it's used to
1720 fine-tune the properties of attachments you are going to send.
1724 <muttng-doc:funcdef name="enter-command"><muttng-doc:key>:</muttng-doc:key></muttng-doc:funcdef>
1728 This command is used to execute any command you would normally put in
1730 configuration file. A common use is to check the settings of
1732 in conjunction with <muttng-doc:cmdref name="macro"/> to change
1738 <muttng-doc:funcdef name="extract-keys"><muttng-doc:key mod="C">K</muttng-doc:key></muttng-doc:funcdef>
1742 This command extracts PGP public keys from the current or tagged
1743 message(s) and adds them to your PGP public key ring.
1747 <muttng-doc:funcdef name="forget-passphrase"><muttng-doc:key mod="C">F</muttng-doc:key></muttng-doc:funcdef>
1751 This command wipes the passphrase(s) from memory. It is useful, if
1752 you misspelled the passphrase.
1756 <muttng-doc:funcdef name="list-reply"><muttng-doc:key>L</muttng-doc:key></muttng-doc:funcdef>
1760 Reply to the current or tagged message(s) by extracting any addresses
1762 match the regular expressions given by the <muttng-doc:cmdref name="lists"/>
1763 commands, but also honor any <literal>Mail-Followup-To</literal>
1765 <muttng-doc:varref name="honor-followup-to"/>
1766 configuration variable is set. Using this when replying to messages
1768 to mailing lists helps avoid duplicate copies being sent to the
1770 the message you are replying to.
1774 <muttng-doc:funcdef name="pipe-message" default="|"/>
1778 Asks for an external Unix command and pipes the current or
1779 tagged message(s) to it. The variables
1780 <muttng-doc:varref name="pipe-decode"/>,
1781 <muttng-doc:varref name="pipe-split"/>,
1782 <muttng-doc:varref name="pipe-decode"/> and
1783 <muttng-doc:varref name="wait-key"/>
1784 control the exact behavior of this function.
1788 <muttng-doc:funcdef name="resend-message"><muttng-doc:key mod="E">e</muttng-doc:key></muttng-doc:funcdef>
1792 With resend-message, mutt takes the current message as a template for
1794 new message. This function is best described as "recall from
1796 folders". It can conveniently be used to forward MIME messages while
1797 preserving the original mail structure. Note that the amount of
1799 included here depends on the value of the <muttng-doc:varref name="weed"/>
1804 This function is also available from the attachment menu. You can use
1806 to easily resend a message which was included with a bounce message
1807 as a message/rfc822 body part.
1811 <muttng-doc:funcdef name="shell-escape"><muttng-doc:key>!</muttng-doc:key></muttng-doc:funcdef>
1815 Asks for an external Unix command and executes it. The
1816 <muttng-doc:varref name="wait-key"/>
1817 can be used to control
1818 whether Mutt-ng will wait for a key to be pressed when the command
1820 (presumably to let the user read the output of the command), based on
1821 the return status of the named command.
1825 <muttng-doc:funcdef name="toggle-quoted"><muttng-doc:key>T</muttng-doc:key></muttng-doc:funcdef>
1829 The <emphasis>pager</emphasis> uses the
1830 <muttng-doc:varref name="quote-regexp"/>
1831 variable to detect quoted text when
1832 displaying the body of the message. This function toggles the
1833 displayof the quoted material in the message. It is particularly
1835 are interested in just the response and there is a large amount of
1836 quoted text in the way.
1840 <muttng-doc:funcdef name="skip-quoted"><muttng-doc:key>S</muttng-doc:key></muttng-doc:funcdef>
1844 This function will go to the next line of non-quoted text which come
1845 after a line of quoted text in the internal pager.
1857 <sect1 id="sending"> <!--{{{-->
1858 <title>Sending Mail</title>
1861 The following bindings are available in the <emphasis>index</emphasis>
1868 <table frame="none" rowsep="1" texstr="l|l|l">
1869 <title>Most commonly used Mail Composition Bindings</title>
1870 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1874 <entry>Function</entry>
1875 <entry>Description</entry>
1880 <entry><muttng-doc:key>m</muttng-doc:key></entry>
1881 <entry><muttng-doc:funcref name="compose"/></entry>
1882 <entry>compose a new message</entry>
1885 <entry><muttng-doc:key>r</muttng-doc:key></entry>
1886 <entry><muttng-doc:funcref name="reply"/></entry>
1887 <entry>reply to sender</entry>
1890 <entry><muttng-doc:key>g</muttng-doc:key></entry>
1891 <entry><muttng-doc:funcref name="group-reply"/></entry>
1892 <entry>reply to all recipients</entry>
1895 <entry><muttng-doc:key>L</muttng-doc:key></entry>
1896 <entry><muttng-doc:funcref name="list-reply"/></entry>
1897 <entry>reply to mailing list address</entry>
1900 <entry><muttng-doc:key>f</muttng-doc:key></entry>
1901 <entry><muttng-doc:funcref name="forward"/></entry>
1902 <entry>forward message</entry>
1905 <entry><muttng-doc:key>b</muttng-doc:key></entry>
1906 <entry><muttng-doc:funcref name="bounce"/></entry>
1907 <entry>bounce (remail) message</entry>
1910 <entry><muttng-doc:key mod="E">k</muttng-doc:key></entry>
1911 <entry><muttng-doc:funcref name="mail-key"/></entry>
1912 <entry>mail a PGP public key to someone</entry>
1921 Bouncing a message sends the message as is to the recipient you
1922 specify. Forwarding a message allows you to add comments or
1923 modify the message you are forwarding. These items are discussed
1924 in greater detail in the next chapter <link linkend="forwarding-mail">forwarding-mail</link>.
1927 <sect2 id="sending-compose">
1928 <title>Composing new messages</title>
1931 When you want to send an email using mutt-ng, simply press <muttng-doc:key>m</muttng-doc:key> on
1932 your keyboard. Then, mutt-ng asks for the recipient via a prompt in
1938 <muttng-doc:lstmail>
1939 To:</muttng-doc:lstmail>
1944 After you've finished entering the recipient(s), press return. If you
1945 want to send an email to more than one recipient, separate the email
1946 addresses using the comma "<literal>,</literal>". Mutt-ng then asks
1948 subject. Again, press return after you've entered it. After that,
1950 got the most important information from you, and starts up an editor
1951 where you can then enter your email.
1955 The editor that is called is selected in the following way: you
1956 can e.g. set it in the mutt-ng configuration:
1961 <muttng-doc:lstconf>
1962 set editor = "vim +/^$/ -c ':set tw=72'"
1964 set editor = "emacs"</muttng-doc:lstconf>
1969 If you don't set your preferred editor in your configuration, mutt-ng
1970 first looks whether the environment variable <muttng-doc:envvar name="VISUAL"/> is set, and if
1971 so, it takes its value as editor command. Otherwise, it has a look
1972 at <muttng-doc:envvar name="EDITOR"/> and takes its value if it is set. If no
1974 can be found, mutt-ng simply assumes <muttng-doc:man name="vi"/> to be the
1976 since it's the most widespread editor in the Unix world and it's
1978 safe to assume that it is installed and available.
1982 When you've finished entering your message, save it and quit your
1983 editor. Mutt-ng will then present you with a summary screen, the
1985 On the top, you see a summary of the most important available key
1987 Below that, you see the sender, the recipient(s), Cc and/or Bcc
1988 recipient(s), the subject, the reply-to address, and optionally
1989 information where the sent email will be stored and whether it should
1990 be digitally signed and/or encrypted.
1994 Below that, you see a list of "attachments". The mail you've just
1995 entered before is also an attachment, but due to its special type
1996 (it's plain text), it will be displayed as the normal message on
1997 the receiver's side.
2001 At this point, you can add more attachments, pressing <muttng-doc:key>a</muttng-doc:key>, you
2002 can edit the recipient addresses, pressing <muttng-doc:key>t</muttng-doc:key> for
2004 <muttng-doc:key>c</muttng-doc:key> for the "Cc:" field, and <muttng-doc:key>b</muttng-doc:key>
2005 for the "Bcc: field. You can
2006 also edit the subject the subject by simply pressing <muttng-doc:key>s</muttng-doc:key> or the
2007 email message that you've entered before by pressing <muttng-doc:key>e</muttng-doc:key>. You will
2008 then again return to the editor. You can even edit the sender, by
2010 <literal><esc>f</literal>, but this shall only be used with
2015 Alternatively, you can configure mutt-ng in a way that most of the
2016 above settings can be edited using the editor. Therefore, you only
2017 need to add the following to your configuration:
2022 <muttng-doc:lstconf>
2023 set edit_headers</muttng-doc:lstconf>
2028 Once you have finished editing the body of your mail message, you are
2029 returned to the <emphasis>compose</emphasis> menu. The following
2030 options are available:
2035 <table frame="none" rowsep="1" texstr="l|l|l">
2036 <title>Most commonly used Compose Menu Bindings</title>
2037 <tgroup cols="3" align="left" colsep="1" rowsep="1">
2041 <entry>Function</entry>
2042 <entry>Description</entry>
2047 <entry><muttng-doc:key>a</muttng-doc:key></entry>
2048 <entry><muttng-doc:funcref name="attach-file"/></entry>
2049 <entry>attach a file</entry>
2052 <entry><muttng-doc:key>A</muttng-doc:key></entry>
2053 <entry><muttng-doc:funcref name="attach-message"/></entry>
2054 <entry>attach message(s) to the message</entry>
2057 <entry><muttng-doc:key mod="E">k</muttng-doc:key></entry>
2058 <entry><muttng-doc:funcref name="attach-key"/></entry>
2059 <entry>attach a PGP public key</entry>
2062 <entry><muttng-doc:key>d</muttng-doc:key></entry>
2063 <entry><muttng-doc:funcref name="edit-description"/></entry>
2064 <entry>edit description on attachment</entry>
2067 <entry><muttng-doc:key>D</muttng-doc:key></entry>
2068 <entry><muttng-doc:funcref name="detach-file"/></entry>
2069 <entry>detach a file</entry>
2072 <entry><muttng-doc:key>t</muttng-doc:key></entry>
2073 <entry><muttng-doc:funcref name="edit-to"/></entry>
2074 <entry>edit the To field</entry>
2077 <entry><muttng-doc:key mod="E">f</muttng-doc:key></entry>
2078 <entry><muttng-doc:funcref name="edit-from"/></entry>
2079 <entry>edit the From field</entry>
2082 <entry><muttng-doc:key>r</muttng-doc:key></entry>
2083 <entry><muttng-doc:funcref name="edit-reply-to"/></entry>
2084 <entry>edit the Reply-To field</entry>
2087 <entry><muttng-doc:key>c</muttng-doc:key></entry>
2088 <entry><muttng-doc:funcref name="edit-cc"/></entry>
2089 <entry>edit the Cc field</entry>
2092 <entry><muttng-doc:key>b</muttng-doc:key></entry>
2093 <entry><muttng-doc:funcref name="edit-bcc"/></entry>
2094 <entry>edit the Bcc field</entry>
2097 <entry><muttng-doc:key>y</muttng-doc:key></entry>
2098 <entry><muttng-doc:funcref name="send-message"/></entry>
2099 <entry>send the message</entry>
2102 <entry><muttng-doc:key>s</muttng-doc:key></entry>
2103 <entry><muttng-doc:funcref name="edit-subject"/></entry>
2104 <entry>edit the Subject</entry>
2107 <entry><muttng-doc:key>S</muttng-doc:key></entry>
2108 <entry><muttng-doc:funcref name="smime-menu"/></entry>
2109 <entry>select S/MIME options</entry>
2112 <entry><muttng-doc:key>f</muttng-doc:key></entry>
2113 <entry><muttng-doc:funcref name="edit-fcc"/></entry>
2114 <entry>specify an ``Fcc'' mailbox</entry>
2117 <entry><muttng-doc:key>p</muttng-doc:key></entry>
2118 <entry><muttng-doc:funcref name="pgp-menu"/></entry>
2119 <entry>select PGP options</entry>
2122 <entry><muttng-doc:key>P</muttng-doc:key></entry>
2123 <entry><muttng-doc:funcref name="postpone-message"/></entry>
2124 <entry>postpone this message until later</entry>
2127 <entry><muttng-doc:key>q</muttng-doc:key></entry>
2128 <entry><muttng-doc:funcref name="quit"/></entry>
2129 <entry>quit (abort) sending the message</entry>
2132 <entry><muttng-doc:key>w</muttng-doc:key></entry>
2133 <entry><muttng-doc:funcref name="write-fcc"/></entry>
2134 <entry>write the message to a folder</entry>
2137 <entry><muttng-doc:key>i</muttng-doc:key></entry>
2138 <entry><muttng-doc:funcref name="ispell"/></entry>
2139 <entry>check spelling (if available on your system)</entry>
2142 <entry><muttng-doc:key mod="C">F</muttng-doc:key></entry>
2143 <entry><muttng-doc:funcref name="forget-passphrase"/></entry>
2144 <entry>wipe passphrase(s) from memory</entry>
2153 <emphasis role="bold">Note:</emphasis> The attach-message function
2154 will prompt you for a folder to
2155 attach messages from. You can now tag messages in that folder and
2156 theywill be attached to the message you are sending. Note that
2157 certainoperations like composing a new mail, replying, forwarding,
2159 not permitted when you are in that folder. The <literal>%r</literal>
2160 in <muttng-doc:varref name="status-format"/>
2162 a 'A' to indicate that you are in attach-message mode.
2171 <sect2 id="sending-reply">
2172 <title>Replying</title>
2174 <sect3 id="sending-simple-reply">
2175 <title>Simple Replies</title>
2178 When you want to reply to an email message, select it in the index
2179 menu and then press <muttng-doc:key>r</muttng-doc:key>. Mutt-ng's behaviour is
2181 behaviour when you compose a message: first, you will be asked for
2182 the recipient, then for the subject, and then, mutt-ng will start
2183 the editor with the quote attribution and the quoted message. This
2184 can e.g. look like the example below.
2189 <muttng-doc:lstmail>
2190 On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
2191 > Bill, can you please send last month's progress report to Mr.
2192 > Morgan? We also urgently need the cost estimation for the new
2193 > production server that we want to set up before our customer's
2194 > project will go live.</muttng-doc:lstmail>
2199 You can start editing the email message. It is strongly
2200 recommended to put your answer <emphasis>below</emphasis> the
2202 only quote what is really necessary and that you refer to. Putting
2203 your answer on top of the quoted message, is, although very
2204 widespread, very often not considered to be a polite way to answer
2209 The quote attribution is configurable, by default it is set to
2211 <muttng-doc:lstconf>
2212 set attribution = "On %d, %n wrote:"</muttng-doc:lstconf>
2217 It can also be set to something more compact, e.g.
2219 <muttng-doc:lstconf>
2220 set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</muttng-doc:lstconf>
2225 The example above results in the following attribution:
2227 <muttng-doc:lstmail>
2228 * Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
2229 > Bill, can you please send last month's progress report to Mr.
2230 > Morgan? We also urgently need the cost estimation for the new
2231 > production server that we want to set up before our customer's
2232 > project will go live.</muttng-doc:lstmail>
2237 Generally, try to keep your attribution short yet
2238 information-rich. It is <emphasis>not</emphasis> the right place
2240 long "attribution" novels or anything like that: the right place
2241 for such things is - if at all - the email signature at the very
2242 bottom of the message.
2246 When you're done with writing your message, save and quit the
2247 editor. As before, you will return to the compose menu, which is
2248 used in the same way as before.
2257 <sect3 id="sending-group-reply">
2258 <title>Group Replies</title>
2261 In the situation where a group of people uses email as a
2262 discussion, most of the emails will have one or more recipients,
2263 and probably several "Cc:" recipients. The group reply
2264 functionalityensures that when you press <muttng-doc:key>g</muttng-doc:key>
2265 instead of <muttng-doc:key>r</muttng-doc:key> to do a reply,
2266 each and every recipient that is contained in the original message
2267 will receive a copy of the message, either as normal recipient or
2277 <sect3 id="sending-list-reply">
2278 <title>List Replies</title>
2281 When you use mailing lists, it's generally better to send your
2282 reply to a message only to the list instead of the list and the
2283 original author. To make this easy to use, mutt-ng features list
2288 To do a list reply, simply press <muttng-doc:key>L</muttng-doc:key>. If the email
2290 a <literal>Mail-Followup-To:</literal> header, its value will be
2292 address. Otherwise, mutt-ng searches through all mail addresses in
2293 the original message and tries to match them a list of regular
2294 expressions which can be specified using the <literal>lists</literal> command.
2295 If any of the regular expression matches, a mailing
2296 list address has been found, and it will be used as reply address.
2301 <muttng-doc:lstconf>
2302 lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</muttng-doc:lstconf>
2307 Nowadays, most mailing list software like GNU Mailman adds a
2308 <literal>Mail-Followup-To:</literal> header to their emails anyway,
2310 <literal>lists</literal> is hardly ever necessary in practice.
2325 <sect2 id="sending-edit-header">
2326 <title>Editing the message header</title>
2329 When editing the header of your outgoing message, there are a couple
2331 special features available.
2337 <literal>Fcc:</literal> <emphasis>filename</emphasis>
2339 Mutt-ng will pick up <emphasis>filename</emphasis>
2340 just as if you had used the <emphasis>edit-fcc</emphasis> function in
2341 the <emphasis>compose</emphasis> menu.
2345 You can also attach files to your message by specifying
2347 <muttng-doc:lstmail>
2348 Attach: filename [description]</muttng-doc:lstmail>
2350 where <emphasis>filename</emphasis> is the file to attach and <emphasis>
2354 optional string to use as the description of the attached file.
2358 When replying to messages, if you remove the <emphasis>In-Reply-To:</emphasis> field from
2359 the header field, Mutt-ng will not generate a <emphasis>References:</emphasis> field, which
2360 allows you to create a new message thread.
2364 Also see the <muttng-doc:varref name="edit-headers"/> and
2365 <muttng-doc:varref name="editor-headers"/> variables
2374 <sect2 id="sending-crypto">
2375 <title>Using Mutt-ng with PGP</title>
2378 If you want to use PGP, you can specify
2380 <muttng-doc:lstmail>
2381 Pgp: [E | S | S id]</muttng-doc:lstmail>
2383 ``E'' encrypts, ``S'' signs and
2384 ``S<id>'' signs with the given key, setting
2385 <muttng-doc:varref name="pgp-sign-as"/>
2390 If you have told mutt to PGP encrypt a message, it will guide you
2391 through a key selection process when you try to send the message.
2392 Mutt-ng will not ask you any questions about keys which have a
2393 certified user ID matching one of the message recipients' mail
2394 addresses. However, there may be situations in which there are
2395 several keys, weakly certified user ID fields, or where no matching
2400 In these cases, you are dropped into a menu with a list of keys from
2401 which you can select one. When you quit this menu, or mutt can't
2402 find any matching keys, you are prompted for a user ID. You can, as
2403 usually, abort this prompt using <muttng-doc:key mod="C">G</muttng-doc:key>. When
2404 you do so, mutt will
2405 return to the compose screen.
2409 Once you have successfully finished the key selection, the message
2410 will be encrypted using the selected public keys, and sent out.
2414 Most fields of the entries in the key selection menu (see also
2415 <muttng-doc:varref name="pgp-entry-format"/>)
2416 have obvious meanings. But some explanations on the capabilities,
2418 and validity fields are in order.
2422 The flags sequence (%f) will expand to one of the following
2426 <table frame="none" rowsep="1" texstr="l|l">
2427 <title>PGP Key Menu Flags</title>
2428 <tgroup cols="2" align="left" colsep="1" rowsep="1">
2432 <entry>Description</entry>
2437 <entry><literal>R</literal></entry>
2438 <entry>The key has been revoked and can't be used.</entry>
2441 <entry><literal>X</literal></entry>
2442 <entry>The key is expired and can't be used.</entry>
2445 <entry><literal>d</literal></entry>
2446 <entry>You have marked the key as disabled.</entry>
2449 <entry><literal>c</literal></entry>
2450 <entry>There are unknown critical self-signature packets.</entry>
2459 The capabilities field (%c) expands to a two-character
2460 sequencerepresenting a key's capabilities. The first character gives
2461 the key's encryption capabilities: A minus sign (<emphasis role="bold">
2465 that the key cannot be used for encryption. A dot (<emphasis role="bold">
2469 it's marked as a signature key in one of the user IDs, but may
2470 also be used for encryption. The letter <emphasis role="bold">e</emphasis> indicates that
2471 this key can be used for encryption.
2475 The second character indicates the key's signing capabilities. Once
2476 again, a ``<emphasis role="bold">-</emphasis>'' implies ``not for
2477 signing'', ``<emphasis role="bold">.</emphasis>'' implies
2478 that the key is marked as an encryption key in one of the user-ids,
2480 ``<emphasis role="bold">s</emphasis>'' denotes a key which can be
2485 Finally, the validity field (%t) indicates how well-certified
2487 is. A question mark (<emphasis role="bold">?</emphasis>) indicates
2488 undefined validity, a minus
2489 character (<emphasis role="bold">-</emphasis>) marks an untrusted
2490 association, a space character
2491 means a partially trusted association, and a plus character (<emphasis role="bold">
2495 indicates complete validity.
2504 <sect2 id="sending-mixmaster">
2505 <title>Sending anonymous messages via mixmaster</title>
2508 You may also have configured mutt to co-operate with Mixmaster, an
2509 anonymous remailer. Mixmaster permits you to send your messages
2510 anonymously using a chain of remailers. Mixmaster support in mutt is
2512 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
2513 It does not support earlier versions or the later so-called version 3
2515 of which the latest appears to be called 2.9b23.
2519 To use it, you'll have to obey certain restrictions. Most
2520 important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell
2521 Mutt-ng to use mixmaster, you have to select a remailer chain, using
2522 the mix function on the compose menu.
2526 The chain selection screen is divided into two parts. In the
2527 (larger) upper part, you get a list of remailers you may use. In
2528 the lower part, you see the currently selected chain of remailers.
2532 You can navigate in the chain using the <literal>chain-prev</literal>
2534 <literal>chain-next</literal> functions, which are by default bound
2536 and right arrows and to the <muttng-doc:key>h</muttng-doc:key> and <muttng-doc:key>l</muttng-doc:key> keys (think vi
2537 keyboard bindings). To insert a remailer at the current chain
2538 position, use the <literal>insert</literal> function. To append a
2540 the current chain position, use <literal>select-entry</literal> or <literal>
2544 You can also delete entries from the chain, using the corresponding
2545 function. Finally, to abandon your changes, leave the menu, or
2546 <literal>accept</literal> them pressing (by default) the <literal>
2553 Note that different remailers do have different capabilities,
2554 indicated in the <literal>%c</literal> entry of the remailer menu lines (see
2555 <muttng-doc:varref name="mix-entry-format"/>).
2557 the ``middleman'' capability, indicated by a capital ``M'': This
2558 means that the remailer in question cannot be used as the final
2559 element of a chain, but will only forward messages to other
2560 mixmaster remailers. For details on the other capabilities, please
2561 have a look at the mixmaster documentation.
2576 <sect1 id="forwarding-mail">
2577 <title>Forwarding and Bouncing Mail</title>
2580 Often, it is necessary to forward mails to other people.
2581 Therefore, mutt-ng supports forwarding messages in two different
2586 The first one is regular forwarding, as you probably know it from
2587 other mail clients. You simply press <muttng-doc:key>f</muttng-doc:key>, enter the
2589 email address, the subject of the forwarded email, and then you can
2590 edit the message to be forwarded in the editor. The forwarded
2591 message is separated from the rest of the message via the two
2597 <muttng-doc:lstmail>
2598 ----- Forwarded message from Lucas User <luser@example.com> -----
2600 From: Lucas User <luser@example.com>
2601 Date: Thu, 02 Dec 2004 03:08:34 +0100
2602 To: Michael Random <mrandom@example.com>
2603 Subject: Re: blackmail
2605 Pay me EUR 50,000.- cash or your favorite stuffed animal will die
2608 ----- End forwarded message -----</muttng-doc:lstmail>
2613 When you're done with editing the mail, save and quit the editor,
2614 and you will return to the compose menu, the same menu you also
2615 encounter when composing or replying to mails.
2619 The second mode of forwarding emails with mutt-ng is the
2620 so-called <emphasis>bouncing</emphasis>: when you bounce an email to
2622 address, it will be sent in practically the same format you send it
2623 (except for headers that are created during transporting the
2624 message). To bounce a message, press <muttng-doc:key>b</muttng-doc:key> and enter the
2626 email address. By default, you are then asked whether you really
2627 want to bounce the message to the specified recipient. If you answer
2628 with yes, the message will then be bounced.
2632 To the recipient, the bounced email will look as if he got it
2633 like a regular email where he was <literal>Bcc:</literal> recipient.
2635 possibility to find out whether it was a bounced email is to
2636 carefully study the email headers and to find out which host really
2646 <sect1 id="postponing-mail">
2647 <title>Postponing Mail</title>
2650 At times it is desirable to delay sending a message that you have
2651 already begun to compose. When the <emphasis>postpone-message</emphasis> function is
2652 used in the <emphasis>compose</emphasis> menu, the body of your message
2654 are stored in the mailbox specified by the
2655 <muttng-doc:varref name="postponed"/> variable. This means that you can recall the
2656 message even if you exit Mutt-ng and then restart it at a later time.
2660 Once a message is postponed, there are several ways to resume it. From
2662 command line you can use the ``-p'' option, or if you <emphasis>compose</emphasis> a new
2663 message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed
2664 messages exist. If multiple messages are currently postponed, the
2665 <emphasis>postponed</emphasis> menu will pop up and you can select
2666 which message you would
2671 <emphasis role="bold">Note:</emphasis> If you postpone a reply to a
2672 message, the reply setting of
2673 the message is only updated when you actually finish the message and
2674 send it. Also, you must be in the same folder with the message you
2675 replied to for the status of the message to be updated.
2679 See also the <muttng-doc:varref name="postpone"/> quad-option.
2697 <chapter id="configuration"> <!--{{{-->
2698 <title>Configuration</title>
2700 <sect1 id="configuration-files">
2701 <title>Locations of Configuration Files</title>
2704 While the default configuration (or ``preferences'') make Mutt-ng
2706 of the box, it is often desirable to tailor Mutt-ng to suit your own
2708 Mutt-ng is first invoked, it will attempt to read the ``system''
2710 file (defaults set by your local system administrator), unless the
2711 ``-n'' <link linkend="commandline">commandline</link> option is
2712 specified. This file is
2713 typically <literal>/usr/local/share/muttng/Muttngrc</literal> or <literal>
2717 Mutt-ng users will find this file in <literal>
2718 /usr/local/share/muttng/Muttrc
2721 <literal>/etc/Muttngrc</literal>. Mutt will next look for a file named <literal>
2724 in your home directory, Mutt-ng will look for <literal>.muttngrc</literal>. If this file
2725 does not exist and your home directory has a subdirectory named <literal>
2729 mutt try to load a file named <literal>.muttng/muttngrc</literal>.
2733 <literal>.muttrc</literal> (or <literal>.muttngrc</literal> for
2734 Mutt-ng) is the file where you will
2735 usually place your <link linkend="commands">commands</link> to
2745 <sect1 id="configuration-syntax">
2746 <title>Basic Syntax of Initialization Files</title>
2749 An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands.
2750 When multiple commands are used, they must be separated by a semicolon
2753 <muttng-doc:lstconf>
2754 set realname='Mutt-ng user' ; ignore x-</muttng-doc:lstconf>
2756 The hash mark, or pound sign
2757 (``#''), is used as a ``comment'' character. You can use it to
2758 annotate your initialization file. All text after the comment character
2759 to the end of the line is ignored. For example,
2764 <muttng-doc:lstconf>
2765 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</muttng-doc:lstconf>
2770 Single quotes (') and double quotes (") can be used to quote
2772 which contain spaces or other special characters. The difference
2774 the two types of quotes is similar to that of many popular shell
2776 namely that a single quote is used to specify a literal string (one
2778 not interpreted for shell variables or quoting with a backslash
2780 next paragraph), while double quotes indicate a string for which
2781 should be evaluated. For example, backtics are evaluated inside of
2783 quotes, but <emphasis role="bold">not</emphasis> for single quotes.
2787 \ quotes the next character, just as in shells such as bash and
2789 For example, if want to put quotes ``"'' inside of a string, you
2791 ``\'' to force the next character to be a literal instead of
2795 <muttng-doc:lstconf>
2796 set realname="Michael \"MuttDude\" Elkins"</muttng-doc:lstconf>
2801 ``\\'' means to insert a literal ``\'' into the line.
2802 ``\n'' and ``\r'' have their usual C meanings of linefeed and
2803 carriage-return, respectively.
2807 A \ at the end of a line can be used to split commands over
2808 multiple lines, provided that the split points don't appear in the
2809 middle of command names.
2813 Please note that, unlike the various shells, mutt-ng interprets a
2815 at the end of a line also in comments. This allows you to disable a
2817 split over multiple lines with only one ``#''.
2822 <muttng-doc:lstconf>
2824 set realname="Michael \"MuttDude\" Elkins"</muttng-doc:lstconf>
2829 When testing your config files, beware the following caveat. The
2831 at the end of the commented line extends the current line with the next
2833 - then referred to as a ``continuation line''. As the first line is
2834 commented with a hash (#) all following continuation lines are also
2835 part of a comment and therefore are ignored, too. So take care of
2837 when continuation lines are involved within your setup files!
2846 <muttng-doc:lstconf>
2851 line5</muttng-doc:lstconf>
2856 line1 ``continues'' until line4. however, the part after the # is a
2857 comment which includes line3 and line4. line5 is a new line of its own
2859 thus is interpreted again.
2863 The commands understood by mutt are explained in the next paragraphs.
2864 For a complete list, see the <link linkend="commands">commands</link>.
2873 <sect1 id="configuration-expansion">
2874 <title>Expansion within variables</title>
2877 Besides just assign static content to variables, there's plenty of
2878 ways of adding external and more or less dynamic content.
2881 <sect2 id="configuration-expansion-commands">
2882 <title>Commands' Output</title>
2885 It is possible to substitute the output of a Unix command in an
2886 initialization file. This is accomplished by enclosing the command
2887 in backquotes (``) as in, for example:
2892 <muttng-doc:lstconf>
2893 my_hdr X-Operating-System: `uname -a`</muttng-doc:lstconf>
2898 The output of the Unix command ``uname -a'' will be substituted
2899 before the line is parsed. Note that since initialization files are
2900 line oriented, only the first line of output from the Unix command
2901 will be substituted.
2906 <sect2 id="configuration-expansion-environment">
2907 <title>Environment Variables</title>
2910 UNIX environments can be accessed like the way it is done in
2911 shells like sh and bash: Prepend the name of the environment by a
2912 ``$'' sign. For example,
2917 <muttng-doc:lstconf>
2918 set record=+sent_on_$HOSTNAME</muttng-doc:lstconf>
2923 sets the <muttng-doc:varref name="record"/> variable to the
2924 string <emphasis>+sent_on_</emphasis> and appends the
2925 value of the evironment
2926 variable <muttng-doc:envvar name="HOSTNAME"/>.
2930 <emphasis role="bold">Note:</emphasis> There will be no warning if an
2931 environment variable
2932 is not defined. The result will of the expansion will then be empty.
2937 <sect2 id="configuration-expansion-config">
2938 <title>Configuration Variables</title>
2941 As for environment variables, the values of all configuration
2942 variables as string can be used in the same way, too. For example,
2947 <muttng-doc:lstconf>
2948 set imap_home_namespace = $folder</muttng-doc:lstconf>
2953 would set the value of <muttng-doc:varref name="imap-home-namespace"/>
2954 to the value to which <muttng-doc:varref name="folder"/>
2955 is <emphasis>currently</emphasis> set to.
2959 <emphasis role="bold">Note:</emphasis> There're no logical links
2960 established in such cases so
2961 that the the value for <muttng-doc:varref name="imap-home-namespace"/>
2963 if <muttng-doc:varref name="folder"/> gets changed.
2967 <emphasis role="bold">Note:</emphasis> There will be no warning if a
2968 configuration variable
2969 is not defined or is empty. The result will of the expansion will
2975 <sect2 id="configuration-expansion-self">
2976 <title>Self-Defined Variables</title>
2979 Mutt-ng flexibly allows users to define their own variables. To
2980 avoid conflicts with the standard set and to prevent misleading
2981 error messages, there's a reserved namespace for them: all
2982 user-defined variables must be prefixed with <literal>user_</literal> and can be
2983 used just like any ordinary configuration or environment
2988 For example, to view the manual, users can either define two
2989 macros like the following
2994 <muttng-doc:lstconf>
2995 macro generic <F1> "!less -r /path/to/manual" "Show manual"
2996 macro pager <F1> "!less -r /path/to/manual" "Show manual"</muttng-doc:lstconf>
3001 for <literal>generic</literal>, <literal>pager</literal> and <literal>
3004 .The alternative is to
3005 define a custom variable like so:
3010 <muttng-doc:lstconf>
3011 set user_manualcmd = "!less -r /path/to_manual"
3012 macro generic <F1> "$user_manualcmd<enter>" "Show manual"
3013 macro pager <F1> "$user_manualcmd<enter>" "Show manual"
3014 macro index <F1> "$user_manualcmd<enter>" "Show manual"</muttng-doc:lstconf>
3019 to re-use the command sequence as in:
3024 <muttng-doc:lstconf>
3025 macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</muttng-doc:lstconf>
3030 Using this feature, arbitrary sequences can be defined once and
3031 recalled and reused where necessary. More advanced scenarios could
3032 include to save a variable's value at the beginning of macro
3033 sequence and restore it at end.
3037 When the variable is first defined, the first value it gets
3038 assigned is also the initial value to which it can be reset using
3039 the <literal>reset</literal> command.
3043 The complete removal is done via the <literal>unset</literal>
3048 After the following sequence:
3053 <muttng-doc:lstconf>
3055 set user_foo = 666</muttng-doc:lstconf>
3060 the variable <literal>$user_foo</literal> has a current value
3062 initial of 42. The query
3067 <muttng-doc:lstconf>
3068 set ?user_foo</muttng-doc:lstconf>
3073 will show 666. After doing the reset via
3078 <muttng-doc:lstconf>
3079 reset user_foo</muttng-doc:lstconf>
3084 a following query will give 42 as the result. After unsetting it
3090 <muttng-doc:lstconf>
3091 unset user_foo</muttng-doc:lstconf>
3096 any query or operation (except the noted expansion within other
3097 statements) will lead to an error message.
3102 <sect2 id="configuration-expansion-predef">
3103 <title>Pre-Defined Variables</title>
3106 In order to allow users to share one setup over a number of
3107 different machines without having to change its contents, there's a
3108 number of pre-defined variables. These are prefixed with
3109 <literal>muttng_</literal> and are read-only, i.e. they cannot
3111 reset. The reference chapter lists all available variables.
3115 <emphasis> Please consult the local copy of your manual for their
3116 values as they may differ from different manual sources.
3119 the manual is installed in can be queried (already using such a
3120 variable) by running:
3125 <muttng-doc:lstshell>
3126 $ muttng -Q muttng_docdir</muttng-doc:lstshell>
3131 To extend the example for viewing the manual via self-defined
3132 variables, it can be made more readable and more portable by
3133 changing the real path in:
3138 <muttng-doc:lstconf>
3139 set user_manualcmd = '!less -r /path/to_manual'</muttng-doc:lstconf>
3149 <muttng-doc:lstconf>
3150 set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</muttng-doc:lstconf>
3155 which works everywhere if a manual is installed.
3159 Please note that by the type of quoting, muttng determines when
3160 to expand these values: when it finds double quotes, the value will
3161 be expanded during reading the setup files but when it finds single
3162 quotes, it'll expand it at runtime as needed.
3166 For example, the statement
3171 <muttng-doc:lstconf>
3172 folder-hook . "set user_current_folder = $muttng_folder_name"</muttng-doc:lstconf>
3177 will be already be translated to the following when reading the
3183 <muttng-doc:lstconf>
3184 folder-hook . "set user_current_folder = some_folder"</muttng-doc:lstconf>
3189 with <literal>some_folder</literal> being the name of the
3191 opens. On the contrary,
3196 <muttng-doc:lstconf>
3197 folder-hook . 'set user_current_folder = $muttng_folder_name'</muttng-doc:lstconf>
3202 will be executed at runtime because of the single quotes so that
3203 <literal>user_current_folder</literal> will always have
3204 the value of the currently
3209 A more practical example is:
3214 <muttng-doc:lstconf>
3215 folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</muttng-doc:lstconf>
3220 which can be used to source files containing score commands
3221 depending on the folder the user enters.
3226 <sect2 id="configuration-expansion-typeconv">
3227 <title>Type Conversions</title>
3230 A note about variable's types during conversion: internally
3231 values are stored in internal types but for any dump/query or set
3232 operation they're converted to and from string. That means that
3233 there's no need to worry about types when referencing any variable.
3234 As an example, the following can be used without harm (besides
3235 makeing muttng very likely behave strange):
3240 <muttng-doc:lstconf>
3242 set folder = $read_inc
3243 set read_inc = $folder
3244 set user_magic_number = 42
3245 set folder = $user_magic_number</muttng-doc:lstconf>
3254 <title>Defining/Using aliases</title>
3257 <muttng-doc:cmddef name="alias">
3258 key address [, address,...]
3259 </muttng-doc:cmddef>
3263 It's usually very cumbersome to remember or type out the address of
3265 you are communicating with. Mutt-ng allows you to create ``aliases''
3267 a short string to a full address.
3271 <emphasis role="bold">Note:</emphasis> if you want to create an alias
3272 for a group (by specifying more than
3273 one address), you <emphasis role="bold">must</emphasis> separate the
3274 addresses with a comma (``,'').
3278 To remove an alias or aliases (``*'' means all aliases):
3282 <muttng-doc:cmddef name="unalias">
3284 </muttng-doc:cmddef>
3289 <muttng-doc:lstconf>
3290 alias muttdude me@cs.hmc.edu (Michael Elkins)
3291 alias theguys manny, moe, jack</muttng-doc:lstconf>
3296 Unlike other mailers, Mutt-ng doesn't require aliases to be defined
3297 in a special file. The <literal>alias</literal> command can appear
3299 a configuration file, as long as this file is <muttng-doc:cmdref name="source"/>.
3300 Consequently, you can have multiple alias files, or
3301 you can have all aliases defined in your muttrc.
3305 On the other hand, the <muttng-doc:funcref name="create-alias"/>
3306 function can use only one file, the one pointed to by the
3307 <muttng-doc:varref name="alias-file"/>
3309 <literal>~/.muttrc</literal> by default). This file is not
3311 in the sense that Mutt-ng will happily append aliases to any file, but
3313 order for the new aliases to take effect you need to explicitly <muttng-doc:cmdref name="source"/>
3323 <muttng-doc:lstconf>
3324 source /usr/local/share/Mutt-ng.aliases
3325 source ~/.mail_aliases
3326 set alias_file=~/.mail_aliases</muttng-doc:lstconf>
3331 To use aliases, you merely use the alias at any place in mutt where
3332 muttprompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>
3336 also enter aliases in your editor at the appropriate headers if you
3338 <muttng-doc:varref name="editor-headers"/>
3343 In addition, at the various address prompts, you can use the tab
3345 to expand a partial alias to the full alias. If there are multiple
3347 mutt will bring up a menu with the matching aliases. In order to be
3348 presented with the full list of aliases, you must hit tab with out a
3350 alias, such as at the beginning of the prompt or after a comma denoting
3355 In the alias menu, you can select as many aliases as you want with the
3356 <emphasis>select-entry</emphasis> key (default: RET), and use the <emphasis>
3360 (default: q) to return to the address prompt.
3370 <title>Changing the default key bindings</title>
3373 <muttng-doc:cmddef name="bind">
3375 </muttng-doc:cmddef>
3379 This command allows you to change the default key bindings (operation
3380 invoked when pressing a key).
3384 <emphasis>map</emphasis> specifies in which menu the binding belongs.
3386 be specified by separating them with commas (no additional whitespace
3387 isallowed). The currently defined maps are:
3395 <term>generic</term>
3398 This is not a real menu, but is used as a fallback for all of
3400 menus except for the pager and editor modes. If a key is not
3402 another menu, Mutt-ng will look for a binding to use in this
3404 you to bind a key to a certain function in multiple menus
3406 multiple bind statements to accomplish the same task.
3414 The alias menu is the list of your personal aliases as defined
3416 muttrc. It is the mapping from a short alias name to the full
3418 address(es) of the recipient(s).
3426 The attachment menu is used to access the attachments on
3432 <term>browser</term>
3435 The browser is used for both browsing the local directory
3437 listing all of your incoming mailboxes.
3445 The editor is the line-based editor the user enters text data.
3453 The index is the list of messages contained in a mailbox.
3458 <term>compose</term>
3461 The compose menu is the screen used when sending a new message.
3469 The pager is the mode used to display message/attachment data,
3479 The pgp menu is used to select the OpenPGP keys used for
3486 <term>postpone</term>
3489 The postpone menu is similar to the index menu, except is used
3491 recalling a message the user was composing, but saved until
3500 <emphasis>key</emphasis> is the key (or key sequence) you wish to bind.
3502 control character, use the sequence <emphasis>\Cx</emphasis>,
3503 where <emphasis>x</emphasis> is the
3504 letter of the control character (for example, to specify control-A use
3505 ``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
3506 <emphasis>\C</emphasis> is
3507 ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
3510 and <emphasis>\ca</emphasis> are all
3511 equivalent. An alternative form is to specify the key as a three digit
3512 octal number prefixed with a ``\'' (for example <emphasis>
3516 equivalent to <emphasis>\c?</emphasis>).
3520 In addition, <emphasis>key</emphasis> may consist of:
3525 <table frame="none" rowsep="1" texstr="l|l">
3526 <title>Alternative Key Names</title>
3527 <tgroup cols="2" align="left" colsep="1" rowsep="1">
3530 <entry>Sequence</entry>
3531 <entry>Description</entry>
3536 <entry><literal>\t</literal></entry>
3540 <entry><literal><tab></literal></entry>
3544 <entry><literal><backtab></literal></entry>
3545 <entry>backtab / shift-tab</entry>
3548 <entry><literal>\r</literal></entry>
3549 <entry>carriage return</entry>
3552 <entry><literal>\n</literal></entry>
3553 <entry>newline</entry>
3556 <entry><literal>\e</literal></entry>
3557 <entry>escape</entry>
3560 <entry><literal><esc></literal></entry>
3561 <entry>escape</entry>
3564 <entry><literal><up></literal></entry>
3565 <entry>up arrow</entry>
3568 <entry><literal><down></literal></entry>
3569 <entry>down arrow</entry>
3572 <entry><literal><left></literal></entry>
3573 <entry>left arrow</entry>
3576 <entry><literal><right></literal></entry>
3577 <entry>right arrow</entry>
3580 <entry><literal><pageup></literal></entry>
3581 <entry>Page Up</entry>
3584 <entry><literal><pagedown></literal></entry>
3585 <entry>Page Down</entry>
3588 <entry><literal><backspace></literal></entry>
3589 <entry>Backspace</entry>
3592 <entry><literal><delete></literal></entry>
3593 <entry>Delete</entry>
3596 <entry><literal><insert></literal></entry>
3597 <entry>Insert</entry>
3600 <entry><literal><enter></literal></entry>
3601 <entry>Enter</entry>
3604 <entry><literal><return></literal></entry>
3605 <entry>Return</entry>
3608 <entry><literal><home></literal></entry>
3612 <entry><literal><end></literal></entry>
3616 <entry><literal><space></literal></entry>
3617 <entry>Space bar</entry>
3620 <entry><literal><f1></literal></entry>
3621 <entry>function key 1</entry>
3624 <entry><literal><f10></literal></entry>
3625 <entry>function key 10</entry>
3634 <emphasis>key</emphasis> does not need to be enclosed in quotes unless
3640 <emphasis>function</emphasis> specifies which action to take when <emphasis>
3644 For a complete list of functions, see the <link linkend="functions">functions</link>.
3645 The special function <literal>noop</literal> unbinds the specified key
3655 <sect1 id="charset-hook">
3656 <title>Defining aliases for character sets</title>
3658 <anchor id="iconv-hook"/>
3660 Usage: <muttng-doc:hook name="charset"/> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
3663 Usage: <muttng-doc:hook name="iconv"/> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
3667 The <muttng-doc:hook name="charset"/> command defines an alias for a
3669 This is useful to properly display messages which are tagged with a
3670 character set name not known to mutt.
3674 The <muttng-doc:hook name="iconv"/> command defines a system-specific
3676 character set. This is helpful when your systems character
3677 conversion library insists on using strange, system-specific names
3687 <sect1 id="folder-hook">
3688 <title>Setting variables based upon mailbox</title>
3691 Usage: <muttng-doc:hook name="folder"/> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
3695 It is often desirable to change settings based on which mailbox you are
3696 reading. The <muttng-doc:hook name="folder"/> command provides a method by which you can
3698 any configuration command. <emphasis>regexp</emphasis> is a regular
3699 expression specifying
3700 in which mailboxes to execute <emphasis>command</emphasis> before
3701 loading. If a mailbox
3702 matches multiple <muttng-doc:hook name="folder"/>'s, they are executed in the order given in
3708 <emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut
3709 for <muttng-doc:varref name="spoolfile"/> at the beginning of the
3710 pattern, you must place it
3711 inside of double or single quotes in order to distinguish it from the
3712 logical <emphasis>not</emphasis> operator for the expression.
3716 Note that the settings are <emphasis>not</emphasis> restored when you
3718 For example, a command action to perform is to change the sorting
3719 methodbased upon the mailbox being read:
3724 <muttng-doc:lstconf>
3725 folder-hook mutt set sort=threads</muttng-doc:lstconf>
3730 However, the sorting method is not restored to its previous value when
3731 reading a different mailbox. To specify a <emphasis>default</emphasis>
3738 <muttng-doc:lstconf>
3739 folder-hook . set sort=date-sent</muttng-doc:lstconf>
3750 <title>Keyboard macros</title>
3753 <muttng-doc:cmddef name="macro">
3754 menu key sequence [description]
3755 </muttng-doc:cmddef>
3759 Macros are useful when you would like a single key to perform a series
3761 actions. When you press <emphasis>key</emphasis> in menu <emphasis>
3764 ,Mutt-ng will behave as if
3765 you had typed <emphasis>sequence</emphasis>. So if you have a common
3766 sequence of commands
3767 you type, you can create a macro to execute those commands with a
3772 <emphasis>menu</emphasis> is the <link linkend="maps">maps</link> which
3773 the macro will be bound.
3774 Multiple maps may be specified by separating multiple menu arguments by
3775 commas. Whitespace may not be used in between the menu arguments and
3776 thecommas separating them.
3780 <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are
3781 expanded by the same rules as the <muttng-doc:cmdref
3782 name="bind"/>. There are some additions however. The first
3783 is that control characters in <emphasis>sequence</emphasis> can
3784 also be specified as <literal>^x</literal>. In order to get a
3785 caret (`^'') you need to specify it twice. Secondly,
3786 to specify a certain key such as <emphasis>up</emphasis> or to
3787 invoke a function directly, you can use the format
3788 <emphasis><key name></emphasis> and <emphasis><function
3789 name> </emphasis> .For a listing of key names see the
3790 section on <muttng-doc:cmdref name="bind"/>. Functions are
3791 listed in the <link linkend="functions">functions</link>.
3795 The advantage with using function names directly is that the macros
3796 willwork regardless of the current key bindings, so they are not
3798 the user having particular key definitions. This makes them more
3799 robustand portable, and also facilitates defining of macros in files
3801 than one user (eg. the system Muttngrc).
3805 Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
3806 which is shown in the help screens.
3810 <emphasis role="bold">Note:</emphasis> Macro definitions (if any)
3811 listed in the help screen(s), are
3812 silently truncated at the screen width, and are not wrapped.
3822 <title>Using color and mono video attributes</title>
3825 <muttng-doc:cmddef name="color">object foreground background [regexp]</muttng-doc:cmddef>
3828 <muttng-doc:cmddef name="color" noanchor="1">index foreground pattern</muttng-doc:cmddef>
3831 <muttng-doc:cmddef name="uncolor">index pattern [pattern ...]</muttng-doc:cmddef>
3835 If your terminal supports color, you can spice up Mutt-ng by creating
3837 color scheme. To define the color of an object (type of information),
3839 must specify both a foreground color <emphasis role="bold">and</emphasis> a background color (it is not
3840 possible to only specify one or the other).
3844 <emphasis>object</emphasis> can be one of:
3859 body (match <emphasis>regexp</emphasis> in the body of messages)
3865 bold (highlighting bold patterns in the body of messages)
3871 error (error messages printed by Mutt-ng)
3877 header (match <emphasis>regexp</emphasis> in the message header)
3883 hdrdefault (default color of the message header in the pager)
3889 index (match <emphasis>pattern</emphasis> in the message index)
3895 indicator (arrow or bar used to indicate the current item in a
3902 markers (the ``+'' markers at the beginning of wrapped lines in
3909 message (informational messages)
3921 quoted (text matching <muttng-doc:varref name="quote-regexp"/> in the body of a message)
3927 quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis>
3928 (higher levels of quoting)
3934 search (highlighting of words in the pager)
3946 status (mode lines used to display info about the mailbox or
3953 tilde (the ``~'' used to pad blank lines in the pager)
3959 tree (thread tree drawn in the message index and attachment menu)
3965 underline (highlighting underlined patterns in the body of
3975 <emphasis>foreground</emphasis> and <emphasis>background</emphasis> can
3976 be one of the following:
4039 color<emphasis>x</emphasis>
4048 <emphasis>foreground</emphasis> can optionally be prefixed with the
4049 keyword <literal>bright</literal> to make
4050 the foreground color boldfaced (e.g., <literal>brightred</literal>).
4054 If your terminal supports it, the special keyword <emphasis>default</emphasis> can be
4055 used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
4056 If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library,
4057 you also need to set
4058 the <muttng-doc:envvar name="COLORFGBG"/> environment variable to the default
4060 terminal for this to work; for example (for Bourne-like shells):
4065 <muttng-doc:lstshell>
4066 set COLORFGBG="green;black"
4067 export COLORFGBG</muttng-doc:lstshell>
4072 <emphasis role="bold">Note:</emphasis> The <emphasis>S-Lang</emphasis>
4073 library requires you to use the <emphasis>lightgray</emphasis>
4074 and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>
4078 setting this variable.
4082 <emphasis role="bold">Note:</emphasis> The uncolor command can be
4083 applied to the index object only. It
4084 removes entries from the list. You <emphasis role="bold">must</emphasis> specify the same pattern
4085 specified in the color command for it to be removed. The pattern ``*''
4087 a special token which means to clear the color index list of all
4092 Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
4096 <emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">
4099 being the number of colors supported
4100 by your terminal). This is useful when you remap the colors for your
4101 display (for example by changing the color associated with <emphasis>
4104 for your xterm), since color names may then lose their normal meaning.
4108 If your terminal does not support color, it is still possible change
4110 attributes through the use of the ``mono'' command:
4114 <muttng-doc:cmddef name="mono">object attribute [regexp]</muttng-doc:cmddef>
4117 <muttng-doc:cmddef name="mono" noanchor="1">index attribute pattern</muttng-doc:cmddef>
4120 <muttng-doc:cmddef name="unmono">index pattern [pattern ...]</muttng-doc:cmddef>
4124 where <emphasis>attribute</emphasis> is one of the following:
4172 <title>Ignoring (weeding) unwanted message headers</title>
4175 <muttng-doc:cmddef name="ignore">pattern [pattern ...]</muttng-doc:cmddef>
4179 <muttng-doc:cmddef name="unignore">pattern [pattern ...]</muttng-doc:cmddef>
4183 Messages often have many header fields added by automatic processing
4185 or which may not seem useful to display on the screen. This command
4187 you to specify header fields which you don't normally want to see.
4191 You do not need to specify the full header field name. For example,
4192 ``ignore content-'' will ignore all header fields that begin with the
4194 ``content-''. ``ignore *'' will ignore all headers.
4198 To remove a previously added token from the list, use the ``unignore''
4200 The ``unignore'' command will make Mutt-ng display headers with the
4202 For example, if you do ``ignore x-'' it is possible to ``unignore
4207 ``unignore *'' will remove all tokens from the ignore list.
4213 <muttng-doc:lstconf>
4214 # Sven's draconian header weeding
4216 unignore from date subject to cc
4217 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
4218 unignore posted-to:</muttng-doc:lstconf>
4229 <title>Alternative addresses</title>
4232 <muttng-doc:cmddef name="alternates">regexp [regexp ...]</muttng-doc:cmddef>
4236 <muttng-doc:cmddef name="unalternates">regexp [regexp ...]</muttng-doc:cmddef>
4240 With various functions, mutt will treat messages differently,
4241 depending on whether you sent them or whether you received them from
4242 someone else. For instance, when replying to a message that you
4243 sent to a different party, mutt will automatically suggest to send
4244 the response to the original message's recipients--responding to
4245 yourself won't make much sense in many cases.
4246 (See <muttng-doc:varref name="reply-to"/>.)
4250 Many users receive e-mail under a number of different addresses. To
4251 fully use mutt's features here, the program must be able to
4252 recognize what e-mail addresses you receive mail under. That's the
4253 purpose of the <literal>alternates</literal> command: It takes a list
4255 expressions, each of which can identify an address under which you
4260 The <literal>unalternates</literal> command can be used to write
4262 <literal>alternates</literal> patterns. If an address matches something
4264 <literal>alternates</literal> command, but you nonetheless do not think
4266 from you, you can list a more precise pattern under an <literal>
4273 To remove a regular expression from the <literal>alternates</literal>
4275 <literal>unalternates</literal> command with exactly the same <emphasis>
4279 Likewise, if the <emphasis>regexp</emphasis> for a <literal>alternates</literal> command matches
4280 an entry on the <literal>unalternates</literal> list, that <literal>
4283 entry will be removed. If the <emphasis>regexp</emphasis> for <literal>
4286 is ``*'', <emphasis>all entries</emphasis> on <literal>alternates</literal> will be removed.
4295 <sect1 id="format-flowed">
4296 <title>Format = Flowed</title>
4298 <sect2 id="format-flowed-intro">
4299 <title>Introduction</title>
4302 Mutt-ng contains support for so-called <literal>format=flowed</literal> messages.
4303 In the beginning of email, each message had a fixed line width, and
4304 it was enough for displaying them on fixed-size terminals. But times
4305 changed, and nowadays hardly anybody still uses fixed-size terminals:
4306 more people nowaydays use graphical user interfaces, with dynamically
4307 resizable windows. This led to the demand of a new email format that
4308 makes it possible for the email client to make the email look nice
4309 in a resizable window without breaking quoting levels and creating
4310 an incompatible email format that can also be displayed nicely on
4311 old fixed-size terminals.
4315 For introductory information on <literal>format=flowed</literal>
4317 <muttng-doc:web url="http://www.joeclark.org/ffaq.html"/>.
4322 <sect2 id="format-flowed-display">
4323 <title>Receiving: Display Setup</title>
4326 When you receive emails that are marked as <literal>format=flowed</literal>
4327 messages, and is formatted correctly, mutt-ng will try to reformat
4328 the message to optimally fit on your terminal. If you want a fixed
4329 margin on the right side of your terminal, you can set the
4335 <muttng-doc:lstconf>
4336 set wrapmargin = 10</muttng-doc:lstconf>
4341 The code above makes the line break 10 columns before the right
4342 side of the terminal.
4346 If your terminal is so wide that the lines are embarrassingly long,
4347 you can also set a maximum line length:
4352 <muttng-doc:lstconf>
4353 set max_line_length = 120</muttng-doc:lstconf>
4358 The example above will give you lines not longer than 120
4363 When you view at <literal>format=flowed</literal> messages, you will
4365 the quoting hierarchy like in the following example:
4370 <muttng-doc:lstmail>
4371 >Bill, can you please send last month's progress report to Mr.
4372 >Morgan? We also urgently need the cost estimation for the new
4373 >production server that we want to set up before our customer's
4374 >project will go live.</muttng-doc:lstmail>
4379 This obviously doesn't look very nice, and it makes it very
4380 hard to differentiate between text and quoting character. The
4381 solution is to configure mutt-ng to "stuff" the quoting:
4386 <muttng-doc:lstconf>
4387 set stuff_quoted</muttng-doc:lstconf>
4392 This will lead to a nicer result that is easier to read:
4397 <muttng-doc:lstmail>
4398 > Bill, can you please send last month's progress report to Mr.
4399 > Morgan? We also urgently need the cost estimation for the new
4400 > production server that we want to set up before our customer's
4401 > project will go live.</muttng-doc:lstmail>
4407 <sect2 id="format-flowed-send">
4408 <title>Sending</title>
4411 If you want mutt-ng to send emails with <literal>format=flowed</literal> set, you
4412 need to explicitly set it:
4417 <muttng-doc:lstconf>
4418 set text_flowed</muttng-doc:lstconf>
4423 Additionally, you have to use an editor which supports writing
4424 <literal>format=flowed</literal>-conforming emails. For <muttng-doc:man name="vim"/>, this is
4426 adding <literal>w</literal> to the formatoptions (see <literal>:h
4430 <literal>:h fo-table</literal>) when writing emails.
4434 Also note that <emphasis>format=flowed</emphasis> knows about
4436 that is, when sending messages, some kinds of lines have to be
4437 indented with a single space on the sending side. On the receiving
4438 side, the first space (if any) is removed. As a consequence and in
4439 addition to the above simple setting, please keep this in mind when
4440 making manual formattings within the editor. Also note that mutt-ng
4441 currently violates the standard (<muttng-doc:rfc num="3676"/>) as it does not
4442 space-stuff lines starting with:
4450 <literal>></literal> This is <emphasis>not</emphasis> the
4451 quote character but a right
4452 angle used for other reasons
4461 Please make sure that you manually prepend a space to each of them.
4466 <sect2 id="format-flowed-notes">
4467 <title>Additional Notes</title>
4470 For completeness, the <muttng-doc:varref name="delete-space"/> variable provides the mechanism
4471 to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
4475 According to the standard, clients receiving a <literal>format=flowed</literal>
4476 messages should delete the last space of a flowed line but still
4477 interpret the line as flowed. Because flowed lines usually contain
4478 only one space at the end, this parameter would make the receiving
4479 client concatenate the last word of the previous with the first of
4480 the current line <emphasis>without</emphasis> a space. This makes
4482 unreadable and is intended for languages rarely using spaces. So
4483 please use this setting only if you're sure what you're doing.
4495 <title>Mailing lists</title>
4498 <muttng-doc:cmddef name="lists">regexp [regexp ...]</muttng-doc:cmddef>
4501 <muttng-doc:cmddef name="unlists">regexp [regexp ...]</muttng-doc:cmddef>
4504 <muttng-doc:cmddef name="subscribe">regexp [regexp ...]</muttng-doc:cmddef>
4507 <muttng-doc:cmddef name="unsubscribe">regexp [regexp ...]</muttng-doc:cmddef>
4511 Mutt-ng has a few nice features for <link linkend="using-lists">using-lists</link>.
4512 In order to take advantage of them, you must
4513 specify which addresses belong to mailing lists, and which mailing
4514 lists you are subscribed to. Once you have done this, the
4515 <link linkend="func-list-reply">list-reply</link>
4516 function will work for all known lists.
4517 Additionally, when you send a message to a subscribed list, mutt will
4518 add a Mail-Followup-To header to tell other users' mail user agents
4519 not to send copies of replies to your personal address. Note that
4520 the Mail-Followup-To header is a non-standard extension which is not
4521 supported by all mail user agents. Adding it is not bullet-proof
4523 receiving personal CCs of list messages. Also note that the generation
4524 of the Mail-Followup-To header is controlled by the
4525 <muttng-doc:varref name="followup-to"/>
4526 configuration variable.
4530 More precisely, Mutt-ng maintains lists of patterns for the addresses
4531 of known and subscribed mailing lists. Every subscribed mailing
4532 list is known. To mark a mailing list as known, use the ``lists''
4533 command. To mark it as subscribed, use ``subscribe''.
4537 You can use regular expressions with both commands. To mark all
4538 messages sent to a specific bug report's address on mutt's bug
4539 tracking system as list mail, for instance, you could say
4540 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
4541 give a portion of the list's e-mail address.
4545 Specify as much of the address as you need to to remove ambiguity. For
4546 example, if you've subscribed to the Mutt-ng mailing list, you will
4548 addressed to <emphasis>mutt-users@mutt.org</emphasis>. So, to tell
4549 Mutt-ng that this is a
4550 mailing list, you could add ``lists mutt-users'' to your
4551 initialization file. To tell mutt that you are subscribed to it,
4552 add ``subscribe mutt-users'' to your initialization file instead.
4553 If you also happen to get mail from someone whose address is
4554 <emphasis>mutt-users@example.com</emphasis>, you could use ``lists
4555 mutt-users@mutt\\.org''
4556 or ``subscribe mutt-users@mutt\\.org'' to
4557 match only mail from the actual list.
4561 The ``unlists'' command is used to remove a token from the list of
4562 known and subscribed mailing-lists. Use ``unlists *'' to remove all
4567 To remove a mailing list from the list of subscribed mailing lists,
4568 but keep it on the list of known mailing lists, use ``unsubscribe''.
4577 <sect1 id="mbox-hook">
4578 <title>Using Multiple spool mailboxes</title>
4581 Usage: <muttng-doc:hook name="mbox"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4585 This command is used to move read messages from a specified mailbox to
4586 adifferent mailbox automatically when you quit or change folders.
4587 <emphasis>pattern</emphasis> is a regular expression specifying the
4588 mailbox to treat as a
4589 ``spool'' mailbox and <emphasis>mailbox</emphasis> specifies where mail
4590 should be saved when
4595 Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>
4599 pattern is used (it is not possible to save read mail in more than a
4611 <title>Defining mailboxes which receive mail</title>
4614 <muttng-doc:cmddef name="mailboxes"> [!]filename [filename ... ]</muttng-doc:cmddef>
4617 <muttng-doc:cmddef name="unmailboxes"> [!]filename [filename ... ]</muttng-doc:cmddef>
4621 This command specifies folders which can receive mail and
4622 which will be checked for new messages. By default, the
4623 main menu status bar displays how many of these folders have
4628 When changing folders, pressing <emphasis>space</emphasis> will cycle
4629 through folders with new mail.
4633 Pressing TAB in the directory browser will bring up a menu showing the
4635 specified by the <literal>mailboxes</literal> command, and indicate
4637 messages. Mutt-ng will automatically enter this mode when invoked from
4639 command line with the <literal>-y</literal> option.
4643 The ``unmailboxes'' command is used to remove a token from the list
4644 of folders which receive mail. Use ``unmailboxes *'' to remove all
4649 <emphasis role="bold">Note:</emphasis> new mail is detected by
4650 comparing the last modification time to
4651 the last access time. Utilities like <literal>biff</literal> or <literal>
4655 program which accesses the mailbox might cause Mutt-ng to never detect
4657 for that mailbox if they do not properly reset the access time. Backup
4658 tools are another common reason for updated access times.
4662 <emphasis role="bold">Note:</emphasis> the filenames in the <literal>
4665 command are resolved when
4666 the command is executed, so if these names contain <link linkend="shortcuts">shortcuts</link>
4667 (such as ``='' and ``!''), any variable
4668 definition that affect these characters (like <muttng-doc:varref name="folder"/>
4669 and <muttng-doc:varref name="spoolfile"/>)
4670 should be executed before the <literal>mailboxes</literal> command.
4680 <title>User defined headers</title>
4683 <muttng-doc:cmddef name="my_hdr">string</muttng-doc:cmddef>
4686 <muttng-doc:cmddef name="unmy_hdr">field [field ...]</muttng-doc:cmddef>
4690 The ``my_hdr'' command allows you to create your own header
4691 fields which will be added to every message you send.
4695 For example, if you would like to add an ``Organization:'' header field
4697 all of your outgoing messages, you can put the command
4701 <muttng-doc:lstconf>
4702 my_hdr Organization: A Really Big Company, Anytown, USA</muttng-doc:lstconf>
4706 in your <literal>.muttrc</literal>.
4710 <emphasis role="bold">Note:</emphasis> space characters are <emphasis>
4713 allowed between the keyword and
4714 the colon (``:''). The standard for electronic mail (<muttng-doc:rfc num="822"/>) says that
4715 space is illegal there, so Mutt-ng enforces the rule.
4719 If you would like to add a header field to a single message, you should
4720 either set the <muttng-doc:varref name="edit-headers"/>
4722 or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
4724 that you can edit the header of your message along with the body.
4728 To remove user defined header fields, use the ``unmy_hdr''
4729 command. You may specify an asterisk (``*'') to remove all header
4730 fields, or the fields to remove. For example, to remove all ``To'' and
4731 ``Cc'' header fields, you could use:
4735 <muttng-doc:lstconf>
4736 unmy_hdr to cc</muttng-doc:lstconf>
4746 <title>Defining the order of headers when viewing messages</title>
4749 <muttng-doc:cmddef name="hdr_order">header header [header ...]</muttng-doc:cmddef>
4753 <muttng-doc:cmddef name="unhdr_order">[ * | header header ...]</muttng-doc:cmddef>
4757 With this command, you can specify an order in which mutt will attempt
4758 to present headers to you when viewing messages.
4762 ``unhdr_order *'' will clear all previous headers from the order
4764 thus removing the header order effects set by the system-wide startup
4770 <muttng-doc:lstconf>
4771 hdr_order From Date: From: To: Cc: Subject:</muttng-doc:lstconf>
4781 <sect1 id="save-hook">
4782 <title>Specify default save filename</title>
4785 Usage: <muttng-doc:hook name="save"/> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
4789 This command is used to override the default filename used when saving
4790 messages. <emphasis>filename</emphasis> will be used as the default
4791 filename if the message is
4792 <emphasis>From:</emphasis> an address matching <emphasis>regexp</emphasis> or if you are the author and the
4793 message is addressed <emphasis>to:</emphasis> something matching <emphasis>
4800 See <muttng-doc:hook name="pattern"/> for information on
4801 the exact format of <emphasis>pattern</emphasis>.
4810 <muttng-doc:lstconf>
4811 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
4812 save-hook aol\\.com$ +spam</muttng-doc:lstconf>
4817 Also see the <muttng-doc:hook name="fcc-save"/>
4827 <sect1 id="fcc-hook">
4828 <title>Specify default Fcc: mailbox when composing</title>
4831 Usage: <muttng-doc:hook name="fcc"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4835 This command is used to save outgoing mail in a mailbox other than
4836 <muttng-doc:varref name="record"/>. Mutt-ng searches the initial
4838 message recipients for the first matching <emphasis>regexp</emphasis>
4839 and uses <emphasis>mailbox</emphasis>
4840 as the default Fcc: mailbox. If no match is found the message will be
4842 to <muttng-doc:varref name="record"/> mailbox.
4846 See <muttng-doc:hook name="pattern"/> for information on
4847 the exact format of <emphasis>pattern</emphasis>.
4855 <muttng-doc:lstconf>
4856 fcc-hook [@.]aol\\.com$ +spammers</muttng-doc:lstconf>
4860 The above will save a copy of all messages going to the aol.com
4861 domain to the `+spammers' mailbox by default. Also see the
4862 <muttng-doc:hook name="fcc-save"/> command.
4871 <sect1 id="fcc-save-hook">
4872 <title>Specify default save filename and default Fcc: mailbox at once</title>
4875 Usage: <literal><muttng-doc:hook name="fcc-save"/></literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4879 This command is a shortcut, equivalent to doing both a <muttng-doc:hook name="fcc"/>
4880 and a <muttng-doc:hook name="save"/> with its arguments.
4889 <sect1 id="send-hook">
4890 <title>Change settings based upon message recipients</title>
4892 <anchor id="reply-hook"/>
4893 <anchor id="send2-hook"/>
4895 Usage: <muttng-doc:hook name="reply"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4898 Usage: <muttng-doc:hook name="send"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4901 Usage: <muttng-doc:hook name="send2"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4905 These commands can be used to execute arbitrary configuration commands
4907 upon recipients of the message. <emphasis>pattern</emphasis> is a
4909 matching the desired address. <emphasis>command</emphasis> is executed
4910 when <emphasis>regexp</emphasis>
4911 matches recipients of the message.
4915 <muttng-doc:hook name="reply"/> is matched against the message you are <emphasis>
4918 <emphasis role="bold">to</emphasis>, instead of the message you are <emphasis>
4921 .<muttng-doc:hook name="send"/> is
4922 matched against all messages, both <emphasis>new</emphasis> and <emphasis>
4925 .<emphasis role="bold">Note:</emphasis>
4926 <muttng-doc:hook name="reply"/>s are matched <emphasis role="bold">before</emphasis> the
4927 <muttng-doc:hook name="send"/>, <emphasis role="bold">regardless</emphasis>
4928 of the order specified in the users's configuration file.
4932 <muttng-doc:hook name="send2"/> is matched every time a message is
4934 by editing it, or by using the compose menu to change its recipients
4935 or subject. <muttng-doc:hook name="send2"/> is executed after <muttng-doc:hook name="send"/>
4937 can, e.g., be used to set parameters such as the <muttng-doc:varref name="sendmail"/>
4938 variable depending on the message's sender
4943 For each type of <muttng-doc:hook name="send"/> or <muttng-doc:hook name="reply"/>, when multiple matches
4944 occur, commands are executed in the order they are specified in the
4946 (for that type of hook).
4950 See <muttng-doc:hook name="pattern"/> for information on
4951 the exact format of <emphasis>pattern</emphasis>.
4955 Example: <literal>send-hook mutt "set mime_forward
4961 Another typical use for this command is to change the values of the
4962 <muttng-doc:varref name="attribution"/>,
4963 <muttng-doc:varref name="signature"/> and <muttng-doc:varref
4965 variables in order to change the language of the attributions and
4966 signatures based upon the recipients.
4970 <emphasis role="bold">Note:</emphasis> the <muttng-doc:hook name="send"/>'s are only
4971 executed ONCE after getting the initial
4972 list of recipients. Adding a recipient after replying or editing the
4973 message will NOT cause any <muttng-doc:hook name="send"/> to be executed. Also note that
4974 my_hdr commands which modify recipient headers, or the message's
4975 subject, don't have any effect on the current message when executed
4976 from a <muttng-doc:hook name="send"/>.
4985 <sect1 id="message-hook">
4986 <title>Change settings before formatting a message</title>
4989 Usage: <muttng-doc:hook name="message"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4993 This command can be used to execute arbitrary configuration commands
4994 before viewing or formatting a message based upon information about the
4996 <emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be
4997 displayed. When multiple matches occur, commands are executed in the
4999 they are specified in the muttrc.
5003 See <muttng-doc:hook name="pattern"/> for
5004 information on the exact format of <emphasis>pattern</emphasis>.
5010 <muttng-doc:lstconf>
5011 message-hook ~A 'set pager=builtin'
5012 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</muttng-doc:lstconf>
5022 <sect1 id="crypt-hook">
5023 <title>Choosing the cryptographic key of the recipient</title>
5026 Usage: <muttng-doc:hook name="crypt"/> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
5030 When encrypting messages with PGP or OpenSSL, you may want to associate
5032 key with a given e-mail address automatically, either because the
5033 recipient's public key can't be deduced from the destination address,
5034 or because, for some reasons, you need to override the key Mutt-ng
5035 wouldnormally use. The <muttng-doc:hook name="crypt"/> command provides a method by which
5037 specify the ID of the public key to be used when encrypting messages to
5038 a certain recipient.
5042 The meaning of "key id" is to be taken broadly in this context: You
5043 can either put a numerical key ID here, an e-mail address, or even
5054 <title>Adding key sequences to the keyboard buffer</title>
5057 <muttng-doc:cmddef name="push">string</muttng-doc:cmddef>
5062 This command adds the named string to the keyboard buffer. The
5063 string may contain control characters, key names and function
5064 names like the sequence string in the <muttng-doc:cmdref name="macro"/> command. You may use it to
5065 automatically run a sequence of commands at startup, or when
5066 entering certain folders. For example, the following command
5067 will automatically collapse all threads when entering a folder:
5069 <muttng-doc:lstconf>
5070 folder-hook . 'push <collapse-all>'</muttng-doc:lstconf>
5081 <title>Executing functions</title>
5084 <muttng-doc:cmddef name="exec">function [function ... ]</muttng-doc:cmddef>
5088 This command can be used to execute any function. Functions are
5089 listed in the <link linkend="functions">functions</link>.
5090 ``exec function'' is equivalent to ``push <function>''.
5100 <title>Message Scoring</title>
5103 <muttng-doc:cmddef name="score">pattern value</muttng-doc:cmddef>
5106 <muttng-doc:cmddef name="unscore">pattern [pattern ... ]</muttng-doc:cmddef>
5110 In situations where you have to cope with a lot of emails, e.g.
5111 when you read many different mailing lists, and take part in
5112 discussions, it is always useful to have the important messages
5113 marked and the annoying messages or the ones that you aren't
5114 interested in deleted. For this purpose, mutt-ng features a
5115 mechanism called ``scoring''.
5119 When you use scoring, every message has a base score of 0. You
5120 can then use the <literal>score</literal> command to define patterns
5122 positive or negative value associated with it. When a pattern
5123 matches a message, the message's score will be raised or lowered by
5124 the amount of the value associated with the pattern.
5129 <muttng-doc:lstconf>
5130 score "~f nion@muttng\.org" 50
5131 score "~f @sco\.com" -100</muttng-doc:lstconf>
5136 If the pattern matches, it is also possible to set the score
5137 value of the current message to a certain value and then stop
5143 <muttng-doc:lstconf>
5144 score "~f santaclaus@northpole\.int" =666</muttng-doc:lstconf>
5149 What is important to note is that negative score values will be
5154 To make scoring actually useful, the score must be applied in
5155 some way. That's what the <emphasis>score thresholds</emphasis> are
5157 there are three score thresholds:
5166 flag threshold: when a message has a score value equal or higher
5167 than the flag threshold, it will be flagged.
5174 read threshold: when a message has a score value equal or lower
5175 than the read threshold, it will be marked as read.
5182 delete threshold: when a message has a score value equal or
5183 lower than the delete threshold, it will be marked as deleted.
5193 These three thresholds can be set via the variables
5194 <muttng-doc:varref name="score-threshold-read"/>,
5195 <muttng-doc:varref name="score-threshold-flag"/> and
5196 <muttng-doc:varref name="score-threshold-delete"/>.
5200 <muttng-doc:varref name="score-threshold-read"/> and
5201 <muttng-doc:varref name="score-threshold-delete"/>
5203 <literal>-1</literal>, which means that in the default threshold
5205 message will ever get marked as read or deleted.
5209 Scoring gets especially interesting when combined with the <literal>
5213 and the <muttng-doc:pattern name="n"/> pattern:
5218 <muttng-doc:lstconf>
5219 color index black yellow "~n 10-"
5220 color index red yellow "~n 100-"</muttng-doc:lstconf>
5225 The rules above mark all messages with a score between 10 and 99
5226 with black and yellow, and messages with a score greater or equal
5227 100 with red and yellow. This might be unusual to you if you're used
5228 to e.g. slrn's scoring mechanism, but it is more flexible, as it
5229 visually marks different scores.
5239 <title>Spam detection</title>
5242 <muttng-doc:cmddef name="spam">pattern format</muttng-doc:cmddef>
5245 <muttng-doc:cmddef name="nospam">pattern</muttng-doc:cmddef>
5249 Mutt-ng has generalized support for external spam-scoring filters.
5250 By defining your spam patterns with the <literal>spam</literal> and <literal>
5253 commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>
5257 mail based on its spam attributes, as determined by the external
5258 filter. You also can display the spam attributes in your index
5259 display using the <literal>%H</literal> selector in the
5260 <muttng-doc:varref name="index-format"/>
5261 variable. (Tip: try <literal>%?H?[%H] ?</literal>
5262 to display spam tags only when they are defined for a given message.)
5266 Your first step is to define your external filter's spam patterns using
5267 the <literal>spam</literal> command. <emphasis>pattern</emphasis>
5268 should be a regular expression
5269 that matches a header in a mail message. If any message in the mailbox
5270 matches this regular expression, it will receive a ``spam tag'' or
5271 ``spam attribute'' (unless it also matches a <literal>nospam</literal>
5273 below.) The appearance of this attribute is entirely up to you, and is
5274 governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static
5275 text, but it also can include back-references from the <emphasis>
5278 expression. (A regular expression ``back-reference'' refers to a
5279 sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
5280 the first back-reference in the regex, <literal>%2</literal>
5281 with the second, etc.
5285 If you're using multiple spam filters, a message can have more than
5286 one spam-related header. You can define <literal>spam</literal>
5288 filter you use. If a message matches two or more of these patterns, and
5289 the $spam_separator variable is set to a string, then the
5290 message's spam tag will consist of all the <emphasis>format</emphasis>
5292 together, with the value of $spam_separator separating
5297 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
5298 define these spam settings:
5300 <muttng-doc:lstconf>
5301 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
5302 spam "X-Spam-Status: Yes" "90+/SA"
5303 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
5304 set spam_separator=", "</muttng-doc:lstconf>
5309 If I then received a message that DCC registered with ``many'' hits
5310 under the ``Fuz2'' checksum, and that PureMessage registered with a
5311 97% probability of being spam, that message's spam tag would
5312 read<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
5314 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
5318 If the $spam_separator variable is unset, then each
5319 spam pattern match supersedes the previous one. Instead of getting
5320 joined <emphasis>format</emphasis> strings, you'll get only the last
5325 The spam tag is what will be displayed in the index when you use
5326 <literal>%H</literal> in the <literal>
5329 variable. It's also the
5330 string that the <muttng-doc:pattern name="H"/> pattern-matching expression
5332 <emphasis>search</emphasis> and <emphasis>limit</emphasis> functions.
5333 And it's what sorting by spam
5334 attribute will use as a sort key.
5338 That's a pretty complicated example, and most people's actual
5339 environments will have only one spam filter. The simpler your
5340 configuration, the more effective mutt can be, especially when it comes
5345 Generally, when you sort by spam tag, mutt will sort <emphasis>
5349 that is, by ordering strings alphnumerically. However, if a spam tag
5350 begins with a number, mutt will sort numerically first, and lexically
5351 only when two numbers are equal in value. (This is like UNIX's
5352 <literal>sort -n</literal>.) A message with no spam attributes at all
5354 that didn't match <emphasis>any</emphasis> of your <literal>spam</literal> patterns -- is sorted at
5355 lowest priority. Numbers are sorted next, beginning with 0 and ranging
5356 upward. Finally, non-numeric strings are sorted, with ``a'' taking
5357 lowerpriority than ``z''. Clearly, in general, sorting by spam tags is
5359 effective when you can coerce your filter to give you a raw number. But
5360 in case you can't, mutt can still do something useful.
5364 The <literal>nospam</literal> command can be used to write exceptions
5365 to <literal>spam</literal>
5366 patterns. If a header pattern matches something in a <literal>spam</literal> command,
5367 but you nonetheless do not want it to receive a spam tag, you can list
5368 amore precise pattern under a <literal>nospam</literal> command.
5372 If the <emphasis>pattern</emphasis> given to <literal>nospam</literal>
5373 is exactly the same as the
5374 <emphasis>pattern</emphasis> on an existing <literal>spam</literal>
5375 list entry, the effect will be to
5376 remove the entry from the spam list, instead of adding an exception.
5377 Likewise, if the <emphasis>pattern</emphasis> for a <literal>spam</literal> command matches an entry
5378 on the <literal>nospam</literal> list, that <literal>nospam</literal>
5379 entry will be removed. If the
5380 <emphasis>pattern</emphasis> for <literal>nospam</literal> is ``*'', <emphasis>
5381 all entries on both lists
5383 will be removed. This might be the default action if you use <literal>
5386 and <literal>nospam</literal> in conjunction with a <muttng-doc:hook name="folder"/>.
5390 You can have as many <literal>spam</literal> or <literal>nospam</literal> commands as you like.
5391 You can even do your own primitive spam detection within mutt -- for
5392 example, if you consider all mail from <literal>MAILER-DAEMON</literal>
5394 you can use a <literal>spam</literal> command like this:
5399 <muttng-doc:lstconf>
5400 spam "^From: .*MAILER-DAEMON" "999"</muttng-doc:lstconf>
5411 <title>Setting variables</title>
5414 <muttng-doc:cmddef name="set">[no|inv]variable [=value] [variable...]</muttng-doc:cmddef>
5417 <muttng-doc:cmddef name="toggle">variable [variable ...]</muttng-doc:cmddef>
5420 <muttng-doc:cmddef name="unset">variable [variable ...]</muttng-doc:cmddef>
5423 <muttng-doc:cmddef name="reset">variable [variable ...]</muttng-doc:cmddef>
5427 This command is used to set (and unset) <link linkend="variables">variables</link>.
5428 There are four basic types of variables:
5429 boolean, number, string and quadoption. <emphasis>boolean</emphasis>
5431 <emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false).
5432 <emphasis>number</emphasis> variables can be
5433 assigned a positive integer value.
5437 <emphasis>string</emphasis> variables consist of any number of
5438 printable characters.
5439 <emphasis>strings</emphasis> must be enclosed in quotes if they contain
5441 may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
5445 newline and tab, respectively.
5449 <emphasis>quadoption</emphasis> variables are used to control whether
5450 or not to be prompted
5451 for certain actions, or to specify a default action. A value of <emphasis>
5454 will cause the action to be carried out automatically as if you had
5456 yes to the question. Similarly, a value of <emphasis>no</emphasis>
5458 action to be carried out as if you had answered ``no.'' A value of
5459 <emphasis>ask-yes</emphasis> will cause a prompt with a default answer
5461 <emphasis>ask-no</emphasis> will provide a default answer of ``no.''
5465 Prefixing a variable with ``no'' will unset it. Example: <literal>set
5472 For <emphasis>boolean</emphasis> variables, you may optionally prefix
5473 the variable name with
5474 <literal>inv</literal> to toggle the value (on or off). This is useful
5476 macros. Example: <literal>set invsmart_wrap</literal>.
5480 The <literal>toggle</literal> command automatically prepends the <literal>
5484 specified variables.
5488 The <literal>unset</literal> command automatically prepends the <literal>
5492 specified variables.
5496 Using the enter-command function in the <emphasis>index</emphasis>
5497 menu, you can query the
5498 value of a variable by prefixing the name of the variable with a
5505 <muttng-doc:lstconf>
5506 set ?allow_8bit</muttng-doc:lstconf>
5511 The question mark is actually only required for boolean and quadoption
5516 The <literal>reset</literal> command resets all given variables to the
5518 defaults (hopefully mentioned in this manual). If you use the command
5519 <literal>set</literal> and prefix the variable with ``&'' this has
5521 behavior as the reset command.
5525 With the <literal>reset</literal> command there exists the special
5527 which allows you to reset all variables to their system defaults.
5537 <title>Reading initialization commands from another file</title>
5540 <muttng-doc:cmddef name="source">filename [filename ...]</muttng-doc:cmddef>
5544 This command allows the inclusion of initialization commands
5545 from other files. For example, I place all of my aliases in
5546 <literal>~/.mail_aliases</literal> so that I can make my
5547 <literal>~/.muttrc</literal> readable and keep my aliases
5552 If the filename begins with a tilde (``~''), it will be expanded
5554 path of your home directory.
5558 If the filename ends with a vertical bar (|), then <emphasis>
5562 considered to be an executable program from which to read input (eg.
5563 <literal>source ~/bin/myscript|</literal>).
5573 <title>Removing hooks</title>
5576 <muttng-doc:cmddef name="unhook">[* | hook-type]</muttng-doc:cmddef>
5580 This command permits you to flush hooks you have previously defined.
5581 You can either remove all hooks by giving the ``*'' character as an
5582 argument, or you can remove all hooks of a specific type by saying
5583 something like <literal>unhook send</literal>.
5593 <title>Sharing Setups</title>
5595 <sect2 id="share-charset">
5596 <title>Character Sets</title>
5599 As users may run mutt-ng on different systems, the configuration
5600 must be maintained because it's likely that people want to use the
5601 setup everywhere they use mutt-ng. And mutt-ng tries to help where it
5606 To not produce conflicts with different character sets, mutt-ng
5607 allows users to specify in which character set their configuration
5608 files are encoded. Please note that while reading the configuration
5609 files, this is only respected after the corresponding declaration
5610 appears. It's advised to put the following at the very beginning of a
5616 <muttng-doc:lstconf>
5617 set config_charset = "..."</muttng-doc:lstconf>
5622 and replacing the dots with the actual character set. To avoid
5623 problems while maintaining the setup, <muttng-doc:man name="vim"/> user's may want to use
5624 modelines as show in:
5630 # vim:fileencoding=...:</screen>
5635 while, again, replacing the dots with the appropriate name. This
5636 tells <muttng-doc:man name="vim"/> as which character set to read and save the file.
5645 <sect2 id="share-modularization">
5646 <title>Modularization</title>
5649 ``Modularization'' means to divide the setup into several files
5650 while sorting the options or commands by topic. Especially for
5651 longer setups (e.g. with many hooks), this helps maintaining it
5652 and solving trouble.
5656 When using separation, setups may be, as a whole or in
5657 fractions, shared over different systems.
5666 <sect2 id="share-conditional">
5667 <title>Conditional parts</title>
5670 When using a configuration on different systems, the user may not
5671 always have influence on how mutt-ng is installed and which features
5676 To solve this, mutt-ng contain a feature based on the ``ifdef''
5677 patch written for mutt. Its basic syntax is:
5682 <muttng-doc:lstconf>
5683 ifdef <item> <command>
5684 ifndef <item> <command></muttng-doc:lstconf>
5689 ...whereby <literal><item></literal> can be one of:
5729 All available functions, variables and menus are documented
5730 elsewhere in this manual but ``features'' is specific to these
5731 two commands. To test for one, prefix one of the following
5732 keywords with <literal>feature_</literal>: ncurses,
5733 slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
5734 gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
5735 classic_smime, gpgme, header_cache
5739 As an example, one can use the following in
5740 <literal>~/.muttngrc</literal>:
5745 <muttng-doc:lstconf>
5746 ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
5747 ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
5748 ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</muttng-doc:lstconf>
5753 ...to only source <literal>~/.mutt-ng/setup-imap</literal> if
5755 support is built in, only source <literal>~/.mutt-ng/setup-pop</literal>
5756 if POP support is built in and only source
5757 <literal>~/.mutt-ng/setup-nntp</literal> if NNTP support is
5762 An example for testing for variable names can be used if users
5763 use different revisions of mutt-ng whereby the older one may not
5764 have a certain variable. To test for the availability of
5765 <muttng-doc:varref name="imap-mail-check"/>
5771 <muttng-doc:lstconf>
5772 ifdef imap_mail_check 'set imap_mail_check = 300'</muttng-doc:lstconf>
5777 Provided for completeness is the test for menu names. To set
5778 <muttng-doc:varref name="pager-index-lines"
5781 menu is available, use:
5786 <muttng-doc:lstconf>
5787 ifdef pager 'set pager_index_lines = 10'</muttng-doc:lstconf>
5792 For completeness, too, the opposite of <literal>ifdef</literal> is
5794 <literal>ifndef</literal> which only executes the command if the test
5796 example, the following two examples are equivalent:
5801 <muttng-doc:lstconf>
5802 ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
5803 ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</muttng-doc:lstconf>
5813 <muttng-doc:lstconf>
5814 ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
5815 ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</muttng-doc:lstconf>
5831 <sect1 id="vars-obsolete">
5832 <title>Obsolete Variables</title>
5835 In the process of ensuring and creating more consistency, many
5836 variables have been renamed and some of the old names were already
5837 removed. Please see <link linkend="sect-obsolete">sect-obsolete</link>
5838 for a complete list.
5854 <chapter id="advanced-usage"> <!--{{{-->
5855 <title>Advanced Usage</title>
5857 <sect1 id="advanced-regexp">
5858 <title>Regular Expressions</title>
5861 All string patterns in Mutt-ng including those in more complex
5862 <link linkend="tab-patterns">patterns</link> must be specified
5863 using regular expressions (regexp) in the ``POSIX extended'' syntax
5865 is more or less the syntax used by egrep and GNU awk). For your
5866 convenience, we have included below a brief description of this syntax.
5870 The search is case sensitive if the pattern contains at least one upper
5871 case letter, and case insensitive otherwise. Note that ``\''
5872 must be quoted if used for a regular expression in an initialization
5877 A regular expression is a pattern that describes a set of strings.
5878 Regular expressions are constructed analogously to arithmetic
5879 expressions, by using various operators to combine smaller expressions.
5883 Note that the regular expression can be enclosed/delimited by either
5885 or ' which is useful if the regular expression includes a white-space
5886 character. See <link linkend="configuration-syntax">muttrc-syntax</link>
5887 for more information on " and ' delimiter processing. To match a
5888 literal " or ' you must preface it with \ (backslash).
5892 The fundamental building blocks are the regular expressions that match
5893 a single character. Most characters, including all letters and digits,
5894 are regular expressions that match themselves. Any metacharacter with
5895 special meaning may be quoted by preceding it with a backslash.
5899 The period ``.'' matches any single character. The caret ``^''
5900 andthe dollar sign ``$'' are metacharacters that respectively
5902 the empty string at the beginning and end of a line.
5906 A list of characters enclosed by ``]'' and ``]'' matches any
5907 single character in that list; if the first character of the list
5908 is a caret ``^'' then it matches any character <emphasis role="bold">
5912 list. For example, the regular expression <emphasis role="bold">
5915 matches any single digit. A range of ASCII characters may be specified
5916 by giving the first and last characters, separated by a hyphen
5917 ``-''. Most metacharacters lose their special meaning inside
5918 lists. To include a literal ``]'' place it first in the list.
5919 Similarly, to include a literal ``^'' place it anywhere but first.
5920 Finally, to include a literal hyphen ``-'' place it last.
5924 Certain named classes of characters are predefined. Character classes
5925 consist of ``[:'', a keyword denoting the class, and ``:]''.
5926 The following classes are defined by the POSIX standard:
5933 <term>[:alnum:]</term>
5936 Alphanumeric characters.
5941 <term>[:alpha:]</term>
5944 Alphabetic characters.
5949 <term>[:blank:]</term>
5952 Space or tab characters.
5957 <term>[:cntrl:]</term>
5965 <term>[:digit:]</term>
5973 <term>[:graph:]</term>
5976 Characters that are both printable and visible. (A space is
5978 but not visible, while an ``a'' is both.)
5983 <term>[:lower:]</term>
5986 Lower-case alphabetic characters.
5991 <term>[:print:]</term>
5994 Printable characters (characters that are not control
6000 <term>[:punct:]</term>
6003 Punctuation characters (characters that are not letter, digits,
6005 characters, or space characters).
6010 <term>[:space:]</term>
6013 Space characters (such as space, tab and formfeed, to name a
6019 <term>[:upper:]</term>
6022 Upper-case alphabetic characters.
6027 <term>[:xdigit:]</term>
6030 Characters that are hexadecimal digits.
6038 A character class is only valid in a regular expression inside the
6039 brackets of a character list. Note that the brackets in these
6040 class names are part of the symbolic names, and must be included
6041 in addition to the brackets delimiting the bracket list. For
6042 example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
6043 <emphasis role="bold">[0-9]</emphasis>.
6047 Two additional special sequences can appear in character lists. These
6048 apply to non-ASCII character sets, which can have single symbols
6049 (calledcollating elements) that are represented with more than one
6051 as well as several characters that are equivalent for collating or
6059 <term>Collating Symbols</term>
6062 A collating symbol is a multi-character collating element
6064 ``[.'' and ``.]''. For example, if ``ch'' is a
6066 element, then <emphasis role="bold">
6069 is a regexp that matches
6070 this collating element, while <emphasis role="bold">
6074 matches either ``c'' or ``h''.
6079 <term>Equivalence Classes</term>
6082 An equivalence class is a locale-specific name for a list of
6083 characters that are equivalent. The name is enclosed in
6085 and ``=]''. For example, the name ``e'' might be used to
6086 represent all of ``è'' ``é'' and ``e''. In this
6088 <emphasis role="bold">[[=e=]]</emphasis> is
6089 a regexp that matches any of
6090 ``è'', ``é'' and ``e''.
6098 A regular expression matching a single character may be followed by one
6099 of several repetition operators:
6109 The preceding item is optional and matched at most once.
6117 The preceding item will be matched zero or more times.
6125 The preceding item will be matched one or more times.
6133 The preceding item is matched exactly <emphasis>n</emphasis>
6142 The preceding item is matched <emphasis>n</emphasis> or more
6151 The preceding item is matched at most <emphasis>m</emphasis>
6160 The preceding item is matched at least <emphasis>n</emphasis>
6161 times, but no more than
6162 <emphasis>m</emphasis> times.
6170 Two regular expressions may be concatenated; the resulting regular
6171 expression matches any string formed by concatenating two substrings
6172 that respectively match the concatenated subexpressions.
6176 Two regular expressions may be joined by the infix operator
6178 the resulting regular expression matches any string matching either
6183 Repetition takes precedence over concatenation, which in turn takes
6184 precedence over alternation. A whole subexpression may be enclosed in
6185 parentheses to override these precedence rules.
6189 <emphasis role="bold">Note:</emphasis> If you compile Mutt-ng with the
6190 GNU <emphasis>rx</emphasis> package, the
6191 following operators may also be used in regular expressions:
6201 Matches the empty string at either the beginning or the end of
6210 Matches the empty string within a word.
6218 Matches the empty string at the beginning of a word.
6226 Matches the empty string at the end of a word.
6234 Matches any word-constituent character (letter, digit, or
6243 Matches any character that is not word-constituent.
6251 Matches the empty string at the beginning of a buffer (string).
6259 Matches the empty string at the end of a buffer.
6267 Please note however that these operators are not defined by POSIX, so
6268 they may or may not be available in stock libraries on various systems.
6277 <sect1 id="advanced-patterns">
6278 <title>Patterns</title>
6281 Mutt-ng's pattern language provides a simple yet effective way to
6282 set up rules to match messages, e.g. for operations like tagging and
6283 scoring. A pattern consists of one or more sub-pattern, which can be
6284 logically grouped, ORed, and negated. For a complete listing of
6285 these patterns, please refer to table <link linkend="tab-patterns">patterns</link> in the Reference chapter.
6289 It must be noted that in this table, <literal>EXPR</literal> is
6290 a regular expression. For ranges, the forms
6291 <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
6292 <literal> [MIN]-</literal> and <literal>-[MAX]</literal> are
6296 <sect2 id="patterns-complex">
6297 <title>Complex Patterns</title>
6300 It is possible to combine several sub-patterns to a more complex
6301 pattern. The most simple possibility is to logically AND several
6302 patterns by stringing them together:
6308 <muttng-doc:pattern name="s"/> 'SPAM' <muttng-doc:pattern name="U"/></screen>
6313 The pattern above matches all messages that contain ``SPAM'' in
6314 the subject and are unread.
6318 To logical OR patterns, simply use the <literal>|</literal>
6320 especially useful when using local groups:
6326 <muttng-doc:pattern name="f"/> ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
6327 (<muttng-doc:pattern name="b"/> mutt-ng|<muttng-doc:pattern name="s"/> Mutt-ng)
6328 !<muttng-doc:pattern name="x"/> '@synflood\.at'</screen>
6333 The first pattern matches all messages that were sent by one of
6334 the mutt-ng maintainers, while the seconds pattern matches all
6335 messages that contain ``mutt-ng'' in the message body or ``Mutt-ng''
6336 in the subject. The third pattern matches all messages that do not
6337 contain ``@synflood\.at'' in the <literal>References:</literal>
6339 messages that are not an (indirect) reply to one of my messages. A
6340 pattern can be logicall negated using the <literal>!</literal>
6346 <sect2 sect="patterns-dates">
6347 <title>Patterns and Dates</title>
6350 When using dates in patterns, the dates must be specified in a
6351 special format, i.e. <literal>DD/MM/YYYY</literal>. If you don't
6353 month or year, they default to the current month or year. When using
6354 date ranges, and you specify only the minimum or the maximum, the
6355 specified date will be excluded, e.g. <literal>01/06/2005-</literal>
6357 against all messages <emphasis>after</emphasis> Juni 1st, 2005.
6361 It is also possible to use so-called ``error margins'' when
6362 specifying date ranges. You simply specify a date, and then the
6363 error margin. This margin needs to contain the information whether
6364 it goes ``forth'' or ``back'' in time, by using <literal>+</literal>
6365 and <literal>-</literal>.
6366 Then follows a number and a unit, i.e. <literal>y</literal> for
6367 years, <literal>m</literal> for
6368 months, <literal>w</literal> for weeks and <literal>d</literal> for
6369 days. If you use the special
6370 <literal>*</literal> sign, it means that the error margin goes to
6371 both``directions'' in time.
6377 <muttng-doc:pattern name="d"/> 01/01/2005+1y
6378 <muttng-doc:pattern name="d"/> 18/10/2004-2w
6379 <muttng-doc:pattern name="d"/> 28/12/2004*1d</screen>
6384 The first pattern matches all dates between January 1st, 2005 and
6385 January 1st 2006. The second pattern matches all dates between
6386 October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004),
6387 while the third pattern matches all dates 1 day around December
6388 28th, 2004 (i.e. Dec 27th, 28th and 29th).
6392 Relative dates are also very important, as they make it possible
6393 to specify date ranges between a fixed number of units and the
6394 current date. How this works can be seen in the following example:
6400 <muttng-doc:pattern name="d"/> >2w # messages older than two weeks
6401 <muttng-doc:pattern name="d"/> <3d # messages newer than 3 days
6402 <muttng-doc:pattern name="d"/> =1m # messages that are exactly one month old</screen>
6414 <sect1 id="formatstrings">
6415 <title>Format Strings</title>
6417 <sect2 id="formatstrings-intro">
6418 <title>Introduction</title>
6421 The so called <emphasis>Format Strings</emphasis> offer great
6423 configuring mutt-ng. In short, they describe what items to print
6424 out how in menus and status messages.
6428 Basically, they work as this: for different menus and bars,
6429 there's a variable specifying the layout. For every item
6430 available, there is a so called <emphasis>expando</emphasis>.
6434 For example, when running mutt-ng on different machines or
6435 different versions for testing purposes, it may be interesting to
6436 have the following information always printed on screen when one
6446 the current hostname
6453 the current mutt-ng version number
6463 The setting for the status bar of the index is controlled via the
6464 <muttng-doc:varref name="status-format"/>
6465 variable. For the hostname and version string, there's an expando
6466 for <literal>$status_format</literal>: <literal>
6470 hostname and <literal>%v</literal> to the version string. When
6476 <muttng-doc:lstconf>
6477 set status_format = "%v on %h: ..."</muttng-doc:lstconf>
6482 mutt-ng will replace the sequence <literal>%v</literal> with
6484 and <literal>%h</literal> with the host's name. When you are,
6485 for example, running
6486 mutt-ng version <literal>1.5.9i</literal> on host <literal>mailhost</literal>, you'll see the
6487 following when you're in the index:
6493 Mutt-ng 1.5.9i on mailhost: ...</screen>
6498 In the index, there're more useful information one could want to
6508 which mailbox is open
6515 how man new, flagged or postponed messages
6532 To include the mailbox' name is as easy as:
6537 <muttng-doc:lstconf>
6538 set status_format = "%v on %h: %B: ...</muttng-doc:lstconf>
6543 When the currently opened mailbox is <literal>Inbox</literal>, this
6551 Mutt-ng 1.5.9i on mailhost: Inbox: ...</screen>
6556 For the number of certain types of messages, one more feature of the
6558 strings is extremely useful. If there aren't messages of a certain
6560 may not be desired to print just that there aren't any but instead
6562 print something if there are any.
6571 <sect2 id="formatstrings-conditional">
6572 <title>Conditional Expansion</title>
6575 To only print the number of messages if there are new messages in
6576 the current mailbox, further extend
6577 <literal>$status_format</literal> to:
6582 <muttng-doc:lstconf>
6583 set status_format = "%v on %h: %B %?n?%n new? ...</muttng-doc:lstconf>
6588 This feature is called <emphasis>nonzero-printing</emphasis> and
6590 some expandos may be optionally printed nonzero, i.e. a portion
6591 of the format string is only evaluated if the value of the expando
6592 is different from zero. The basic syntax is:
6598 %?<item>?<string if nonzero>?</screen>
6603 which tells mutt-ng to only look at <literal><string if
6606 if the value of the <literal>%<item%gt;</literal>
6607 expando is different from zero. In our example, we used <literal>n</literal> as
6608 the expando to check for and <literal>%n new</literal> as the
6614 But this is not all: this feature only offers one alternative:
6615 ``print something if not zero.'' Mutt-ng does, as you might guess,
6616 also provide a logically complete version: ``if zero, print
6617 something and else print something else.'' This is achieved by the
6618 following syntax for those expandos which may be printed nonzero:
6624 %?<item>?<string if nonzero>&<string if zero>?</screen>
6629 Using this we can make mutt-ng to do the following:
6638 make it print ``<emphasis>n</emphasis> new messages'' whereby <emphasis>
6642 count but only if there new ones
6649 and make it print ``no new messages'' if there aren't any
6659 The corresponding configuration is:
6664 <muttng-doc:lstconf>
6665 set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</muttng-doc:lstconf>
6670 This doubles the use of the ``new messages'' string because it'll get
6671 always printed. Thus, it can be shortened to:
6676 <muttng-doc:lstconf>
6677 set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</muttng-doc:lstconf>
6682 As you might see from this rather simple example, one can create
6683 very complex but fancy status messages. Please see the reference
6684 chapter for expandos and those which may be printed nonzero.
6693 <sect2 id="formatstrings-padding">
6694 <title>Modifications and Padding</title>
6697 Besides the information given so far, there're even more features of
6707 When specifying <literal>%_<item></literal>
6709 just <literal>%<item></literal>, mutt-ng will
6711 characters in the expansion of <literal><item></literal>
6720 When specifying <literal>%:<item></literal>
6722 <literal>%<item></literal>, mutt-ng will convert
6724 expansion of <literal><item></literal> to underscores
6725 (<literal>_</literal>).
6735 Also, there's a feature called <emphasis>Padding</emphasis> supplied
6737 following two expandos: <literal>%|X</literal> and <literal>
6748 <literal>%|X</literal>
6752 When this occurs, mutt-ng will fill the
6753 rest of the line with the character <literal>X</literal>. In
6755 filling the rest of the line with dashes is done by setting:
6760 <muttng-doc:lstconf>
6761 set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</muttng-doc:lstconf>
6768 <literal>%>X</literal>
6772 Since the previous expando stops at
6773 the end of line, there must be a way to fill the gap between
6774 two items via the <literal>%>X</literal> expando:
6776 characters <literal>X</literal> in between two items so that
6778 the line will be right-justified. For example, to not put the
6779 version string and hostname of our example on the left but on
6780 the right and fill the gap with spaces, one might use (note
6781 the space after <literal>%></literal>):
6786 <muttng-doc:lstconf>
6787 set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</muttng-doc:lstconf>
6807 <sect1 id="using-tags">
6808 <title>Using Tags</title>
6811 Sometimes it is desirable to perform an operation on a group of
6812 messages all at once rather than one at a time. An example might be
6813 to save messages to a mailing list to a separate folder, or to
6814 delete all messages with a given subject. To tag all messages
6815 matching a pattern, use the tag-pattern function, which is bound to
6816 ``shift-T'' by default. Or you can select individual messages by
6817 hand using the ``tag-message'' function, which is bound to ``t'' by
6818 default. See <link linkend="tab-patterns">patterns</link> for Mutt-ng's
6824 Once you have tagged the desired messages, you can use the
6825 ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
6826 When the ``tag-prefix'' operator is used, the <emphasis role="bold">
6830 be applied to all tagged messages if that operation can be used in that
6831 manner. If the <muttng-doc:varref name="auto-tag"/>
6832 variable is set, the next operation applies to the tagged messages
6833 automatically, without requiring the ``tag-prefix''.
6837 In <muttng-doc:cmdref name="macro"/> or <muttng-doc:cmdref name="push"/> commands,
6838 you can use the ``tag-prefix-cond'' operator. If there are no tagged
6839 messages, mutt will "eat" the rest of the macro to abort it's
6840 execution.Mutt-ng will stop "eating" the macro when it encounters the
6842 operator; after this operator the rest of the macro will be executed
6853 <title>Using Hooks</title>
6856 A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor
6858 execute arbitrary commands before performing some operation. For
6860 you may wish to tailor your configuration based upon which mailbox you
6862 reading, or to whom you are sending mail. In the Mutt-ng world, a <emphasis>
6865 consists of a <link linkend="advanced-regexp">regexp</link> or
6866 <link linkend="tab-patterns">patterns</link> along with a
6867 configuration option/command. See
6873 <muttng-doc:hook name="folder"/>
6879 <muttng-doc:hook name="send"/>
6885 <muttng-doc:hook name="message"/>
6891 <muttng-doc:hook name="save"/>
6897 <muttng-doc:hook name="mbox"/>
6903 <muttng-doc:hook name="fcc"/>
6909 <muttng-doc:hook name="fcc-save"/>
6915 for specific details on each type of <emphasis>hook</emphasis>
6920 <emphasis role="bold">Note:</emphasis> if a hook changes configuration
6921 settings, these changes remain
6922 effective until the end of the current mutt session. As this is
6924 not desired, a default hook needs to be added before all other hooks to
6925 restore configuration defaults. Here is an example with <muttng-doc:hook name="send"/> and
6932 <muttng-doc:lstconf>
6933 send-hook . 'unmy_hdr From:'
6934 send-hook '~C ^b@b\.b$' my-hdr from: c@c.c</muttng-doc:lstconf>
6938 <sect2 id="pattern-hook">
6939 <title>Message Matching in Hooks</title>
6942 Hooks that act upon messages (<literal><muttng-doc:hook name="send"/>, <muttng-doc:hook name="save"/>,
6943 <muttng-doc:hook name="fcc"/>,<muttng-doc:hook name="message"/>
6945 )are evaluated in a slightly different manner. For the other
6946 types of hooks, a <link linkend="advanced-regexp">regexp</link> is
6947 sufficient. But in dealing with messages a finer grain of control is
6948 needed for matching since for different purposes you want to match
6953 Mutt-ng allows the use of the <link linkend="tab-patterns">patterns</link>
6954 language for matching messages in hook commands. This works in
6955 exactly the same way as it would when <emphasis>limiting</emphasis>
6956 or<emphasis>searching</emphasis> the mailbox, except that you are
6958 operators which match information mutt extracts from the header of
6959 the message (i.e. from, to, cc, date, subject, etc.).
6963 For example, if you wanted to set your return address based upon
6965 mail to a specific address, you could do something like:
6967 <muttng-doc:lstconf>
6968 send-hook '~t ^me@cs\.hmc\.edu$' 'my-hdr From: Mutt-ng User <user@host>'</muttng-doc:lstconf>
6970 which would execute the given command when sending mail to
6971 <emphasis>me@cs.hmc.edu</emphasis>.
6975 However, it is not required that you write the pattern to match using
6977 full searching language. You can still specify a simple <emphasis>
6981 like the other hooks, in which case Mutt-ng will translate your
6982 pattern into the full language, using the translation specified by
6984 <muttng-doc:hook name="default"/> variable. The
6985 pattern is translated at the time the hook is declared, so the value
6987 <muttng-doc:hook name="default"/> that is in effect
6988 at that time will be used.
6999 <sect1 id="sidebar">
7000 <title>Using the sidebar</title>
7003 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox
7005 which looks very similar to the ones you probably know from GUI mail
7007 The sidebar lists all specified mailboxes, shows the number in each
7008 and highlights the ones with new email
7009 Use the following configuration commands:
7011 <muttng-doc:lstconf>
7012 set sidebar_visible="yes"
7013 set sidebar_width=25</muttng-doc:lstconf>
7018 If you want to specify the mailboxes you can do so with:
7020 <muttng-doc:lstconf>
7025 ...</muttng-doc:lstconf>
7030 You can also specify the colors for mailboxes with new mails by using:
7032 <muttng-doc:lstconf>
7033 color sidebar_new red black
7034 color sidebar white black</muttng-doc:lstconf>
7039 Reasonable key bindings look e.g. like this:
7041 <muttng-doc:lstconf>
7042 bind index \Cp sidebar-prev
7043 bind index \Cn sidebar-next
7044 bind index \Cb sidebar-open
7045 bind pager \Cp sidebar-prev
7046 bind pager \Cn sidebar-next
7047 bind pager \Cb sidebar-open
7049 macro index B ':toggle sidebar_visible^M'
7050 macro pager B ':toggle sidebar_visible^M'</muttng-doc:lstconf>
7055 You can then go up and down by pressing Ctrl-P and Ctrl-N, and
7056 switch on and off the sidebar simply by pressing 'B'.
7066 <title>External Address Queries</title>
7069 Mutt-ng supports connecting to external directory databases such as
7071 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
7072 using a simple interface. Using the
7073 <muttng-doc:varref name="query-command"/>
7074 variable, you specify the wrapper
7075 command to use. For example:
7080 <muttng-doc:lstconf>
7081 set query_command = "mutt_ldap_query.pl '%s'"</muttng-doc:lstconf>
7086 The wrapper script should accept the query on the command-line. It
7087 should return a one line message, then each matching response on a
7088 single line, each line containing a tab separated address then name
7089 thensome other optional information. On error, or if there are no
7091 addresses, return a non-zero exit code and a one line error message.
7095 An example multiple response output:
7098 Searching database ... 20 entries ... 3 matching:
7099 me@cs.hmc.edu Michael Elkins mutt dude
7100 blong@fiction.net Brandon Long mutt and more
7101 roessler@guug.de Thomas Roessler mutt pgp</screen>
7106 There are two mechanisms for accessing the query function of mutt. One
7107 is to do a query from the index menu using the query function (default:
7109 This will prompt for a query, then bring up the query menu which will
7110 list the matching responses. From the query menu, you can select
7111 addresses to create aliases, or to mail. You can tag multiple
7112 addressesto mail, start a new query, or have a new query appended to
7118 The other mechanism for accessing the query function is for address
7119 completion, similar to the alias completion. In any prompt for address
7120 entry, you can use the complete-query function (default: ^T) to
7122 query based on the current address you have typed. Like aliases, mutt
7123 will look for what you have typed back to the last space or comma. If
7124 there is a single response for that query, mutt will expand the address
7125 in place. If there are multiple responses, mutt will activate the
7126 querymenu. At the query menu, you can select one or more addresses to
7128 added to the prompt.
7137 <sect1 id="mailbox-formats">
7138 <title>Mailbox Formats</title>
7141 Mutt-ng supports reading and writing of four different mailbox formats:
7142 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
7143 is no need to use a flag for different mailbox types. When creating
7144 newmailboxes, Mutt-ng uses the default specified with the
7145 <muttng-doc:varref name="mbox-type"/>
7150 <emphasis role="bold">mbox</emphasis>. This is the most widely used
7151 mailbox format for UNIX. All
7152 messages are stored in a single file. Each message has a line of the
7158 <muttng-doc:lstmail>
7159 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</muttng-doc:lstmail>
7164 to denote the start of a new message (this is often referred to as the
7169 <emphasis role="bold">MMDF</emphasis>. This is a variant of the <emphasis>
7172 format. Each message is
7173 surrounded by lines containing ``^A^A^A^A'' (four
7178 <emphasis role="bold">MH</emphasis>. A radical departure from <emphasis>
7181 and <emphasis>MMDF</emphasis>, a mailbox
7182 consists of a directory and each message is stored in a separate file.
7183 The filename indicates the message number (however, this is may not
7184 correspond to the message number Mutt-ng displays). Deleted messages
7185 arerenamed with a comma (,) prepended to the filename. <emphasis role="bold">
7189 detects this type of mailbox by looking for either <literal>
7192 or <literal>.xmhcache</literal> (needed to distinguish normal
7198 <emphasis role="bold">Maildir</emphasis>. The newest of the mailbox
7199 formats, used by the Qmail MTA (a
7200 replacement for sendmail). Similar to <emphasis>MH</emphasis>, except
7202 subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>
7206 for the messages are chosen in such a way they are unique, even when
7207 twoprograms are writing the mailbox over NFS, which means that no file
7218 <sect1 id="shortcuts">
7219 <title>Mailbox Shortcuts</title>
7222 There are a number of built in shortcuts which refer to specific
7224 These shortcuts can be used anywhere you are prompted for a file or
7235 ! -- refers to your <muttng-doc:varref name="spoolfile"/>
7242 > -- refers to your <muttng-doc:varref name="mbox"/> file
7248 < -- refers to your <muttng-doc:varref name="record"/> file
7254 ^ -- refers to the current mailbox
7260 - or !! -- refers to the file you've last visited
7266 ~ -- refers to your home directory
7272 = or + -- refers to your <muttng-doc:varref name="folder"/>
7279 @<emphasis>alias</emphasis> -- refers to the <muttng-doc:hook name="save"/>
7280 as determined by the address of the alias
7294 <sect1 id="using-lists">
7295 <title>Handling Mailing Lists</title>
7298 Mutt-ng has a few configuration options that make dealing with large
7299 amounts of mail easier. The first thing you must do is to let Mutt
7300 know what addresses you consider to be mailing lists (technically
7301 this does not have to be a mailing list, but that is what it is most
7302 often used for), and what lists you are subscribed to. This is
7303 accomplished through the use of the <muttng-doc:cmdref name="lists"/>
7304 commands in your muttrc.
7308 Now that Mutt-ng knows what your mailing lists are, it can do several
7309 things, the first of which is the ability to show the name of a list
7310 through which you received a message (i.e., of a subscribed list) in
7311 the <emphasis>index</emphasis> menu display. This is useful to
7313 personal and list mail in the same mailbox. In the
7314 <muttng-doc:varref name="index-format"/>
7315 variable, the escape ``%L''
7316 will return the string ``To <list>'' when ``list'' appears in the
7317 ``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
7318 field (otherwise it returns the name of the author).
7322 Often times the ``To'' and ``Cc'' fields in mailing list messages
7323 tend to get quite large. Most people do not bother to remove the
7324 author of the message they are reply to from the list, resulting in
7325 two or more copies being sent to that person. The ``list-reply''
7326 function, which by default is bound to ``L'' in the <emphasis>index</emphasis> menu
7327 and <emphasis>pager</emphasis>, helps reduce the clutter by only
7329 known mailing list addresses instead of all recipients (except as
7330 specified by <literal>Mail-Followup-To</literal>, see below).
7334 Mutt-ng also supports the <literal>Mail-Followup-To</literal> header.
7336 a message to a list of recipients which includes one or several
7337 subscribed mailing lists, and if the <muttng-doc:varref name="followup-to"/>
7338 option is set, mutt will generate
7339 a Mail-Followup-To header which contains all the recipients to whom
7340 you send this message, but not your address. This indicates that
7341 group-replies or list-replies (also known as ``followups'') to this
7342 message should only be sent to the original recipients of the
7343 message, and not separately to you - you'll receive your copy through
7344 one of the mailing lists you are subscribed to.
7348 Conversely, when group-replying or list-replying to a message which
7349 has a <literal>Mail-Followup-To</literal> header, mutt will respect
7351 the <muttng-doc:varref name="honor-followup-to"/>
7353 variable is set. Using list-reply will in this case also make sure
7354 that the reply goes to the mailing list, even if it's not specified
7355 in the list of recipients in the <literal>Mail-Followup-To</literal>.
7359 Note that, when header editing is enabled, you can create a
7360 <literal>Mail-Followup-To</literal> header manually. Mutt-ng will only
7362 this header if it doesn't exist when you send the message.
7366 The other method some mailing list admins use is to generate a
7367 ``Reply-To'' field which points back to the mailing list address rather
7368 than the author of the message. This can create problems when trying
7369 to reply directly to the author in private, since most mail clients
7370 will automatically reply to the address given in the ``Reply-To''
7371 field. Mutt-ng uses the <muttng-doc:varref name="reply-to"/>
7372 variable to help decide which address to use. If set to <emphasis>
7376 <emphasis>ask-no</emphasis>, you will be
7377 prompted as to whether or not you would like to use the address given
7378 inthe ``Reply-To'' field, or reply directly to the address given in the
7379 ``From'' field. When set to <emphasis>yes</emphasis>, the ``Reply-To''
7380 field will be used when
7385 The ``X-Label:'' header field can be used to further identify mailing
7386 lists or list subject matter (or just to annotate messages
7387 individually). The <muttng-doc:varref name="index-format"/>
7388 variable's ``%y'' and
7389 ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
7390 index, and Mutt-ng's pattern-matcher can match regular expressions to
7391 ``X-Label:'' fields with the ``<muttng-doc:pattern name="y"/>'' selector. ``X-Label:'' is
7393 standard message header field, but it can easily be inserted by
7394 procmailand other mail filtering agents.
7398 Lastly, Mutt-ng has the ability to <link linkend="sort">sort</link> the
7400 <link linkend="threads">threads</link>. A thread is a group of
7401 messages which all relate to the same
7402 subject. This is usually organized into a tree-like structure where a
7403 message and all of its replies are represented graphically. If you've
7405 used a threaded news client, this is the same concept. It makes
7406 dealingwith large volume mailing lists easier because you can easily
7408 uninteresting threads and quickly find topics of value.
7417 <sect1 id="editing-threads">
7418 <title>Editing threads</title>
7421 Mutt-ng has the ability to dynamically restructure threads that are
7423 either by misconfigured software or bad behavior from some
7424 correspondents. This allows to clean your mailboxes formats) from these
7425 annoyances which make it hard to follow a discussion.
7428 <sect2 id="editing-threads-link">
7429 <title>Linking threads</title>
7432 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
7433 "References:" headers when replying to a message. This results in
7435 discussions because Mutt-ng has not enough information to guess the
7438 You can fix this by tagging the reply, then moving to the parent
7440 and using the ``link-threads'' function (bound to & by default).
7442 reply will then be connected to this "parent" message.
7446 You can also connect multiple children at once, tagging them and
7448 tag-prefix command (';') or the auto_tag option.
7453 <sect2 id="editing-threads-break">
7454 <title>Breaking threads</title>
7457 On mailing lists, some people are in the bad habit of starting a new
7458 discussion by hitting "reply" to any message from the list and
7460 the subject to a totally unrelated one.
7461 You can fix such threads by using the ``break-thread'' function
7462 (boundby default to #), which will turn the subthread starting
7464 current message into a whole different thread.
7476 <title>Delivery Status Notification (DSN) Support</title>
7479 <muttng-doc:rfc num="1894"/> defines a set of MIME content types for relaying information
7480 about the status of electronic mail messages. These can be thought of
7482 ``return receipts.''
7486 Users can make use of it in one of the following two ways:
7495 Berkeley sendmail 8.8.x currently has some command line options
7496 in which the mail client can make requests as to what type of
7498 messages should be returned.
7504 The SMTP support via libESMTP supports it, too.
7513 To support this, there are two variables:
7522 <muttng-doc:varref name="dsn-notify"/> is used
7523 to request receipts for different results (such as failed
7524 message,message delivered, etc.).
7531 <muttng-doc:varref name="dsn-return"/> requests
7532 how much of your message should be returned with the receipt
7533 (headers or full message).
7543 Please see the reference chapter for possible values.
7553 <title>POP3 Support (OPTIONAL)</title>
7556 If Mutt-ng was compiled with POP3 support (by running the <emphasis>
7559 script with the <emphasis>--enable-pop</emphasis> flag), it has the
7561 with mailboxes located on a remote POP3 server and fetch mail for local
7566 You can access the remote POP3 mailbox by selecting the folder
7567 <literal>pop://popserver/</literal>.
7571 You can select an alternative port by specifying it with the server,
7573 <literal>pop://popserver:port/</literal>.
7577 You can also specify different username for each folder, i.e.:
7578 <literal>pop://username@popserver[:port]/</literal>.
7582 Polling for new mail is more expensive over POP3 than locally. For this
7583 reason the frequency at which Mutt-ng will check for mail remotely can
7586 <muttng-doc:varref name="pop-mail-check"/>
7587 variable, which defaults to every 60 seconds.
7591 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7594 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7596 can be encrypted. This naturally requires that the server supports
7597 SSL encrypted connections. To access a folder with POP3/SSL, you should
7598 use pops: prefix, ie:
7599 <literal>pops://[username@]popserver[:port]/</literal>.
7603 Another way to access your POP3 mail is the <emphasis>fetch-mail</emphasis> function
7604 (default: G). It allows to connect to <link
7605 linkend="pop-host">pop-host</link>
7606 ,fetch all your new mail and place it in the
7607 local <muttng-doc:varref name="spoolfile"/>. After this
7608 point, Mutt-ng runs exactly as if the mail had always been local.
7612 <emphasis role="bold">Note:</emphasis> If you only need to fetch all
7613 messages to local mailbox
7614 you should consider using a specialized program, such as
7615 <muttng-doc:man name="fetchmail"/>.
7625 <title>IMAP Support (OPTIONAL)</title>
7628 If Mutt-ng was compiled with IMAP support (by running the
7629 <emphasis>configure</emphasis> script with the
7630 <emphasis>--enable-imap</emphasis> flag), it has the
7631 ability to work with folders located on a remote IMAP server.
7635 You can access the remote inbox by selecting the folder via its
7641 imap://imapserver/INBOX</screen>
7645 where <literal>imapserver</literal> is the name of the IMAP
7646 server and <literal>INBOX</literal> is the special name for your
7647 spool mailbox on the IMAP server. If you want to access another
7648 mail folder at the IMAP server, you should use
7653 imap://imapserver/path/to/folder</screen>
7657 where <literal>path/to/folder</literal> is the path
7658 of the folder you want to access. You can select an alternative
7659 port by specifying it with the server, i.e.:
7664 imap://imapserver:port/INBOX</screen>
7668 You can also specify different username for each folder by
7669 prenpending your username and an @ symbol to the server's name.
7673 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7676 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7678 can be encrypted. This naturally requires that the server supports
7679 SSL encrypted connections. To access a folder with IMAP/SSL, you only
7680 need to substitute the initial <literal>imap://</literal> by
7681 <literal>imaps://</literal> in the above examples.
7685 Note that not all servers use / as the hierarchy separator. Mutt-ng
7687 correctly notice which separator is being used by the server and
7688 convertpaths accordingly.
7692 When browsing folders on an IMAP server, you can toggle whether to look
7693 at only the folders you are subscribed to, or all folders with the
7694 <emphasis>toggle-subscribed</emphasis> command. See also the
7695 <muttng-doc:varref name="imap-list-subscribed"/>
7700 Polling for new mail on an IMAP server can cause noticeable delays. So,
7702 want to carefully tune the
7703 <muttng-doc:varref name="imap-mail-check"/>
7705 <muttng-doc:varref name="timeout"/>
7710 Note that if you are using mbox as the mail store on UW servers prior
7711 tov12.250, the server has been reported to disconnect a client if
7713 selects the same folder.
7716 <sect2 id="imap-browser">
7717 <title>The Folder Browser</title>
7720 As of version 1.2, mutt supports browsing mailboxes on an IMAP
7721 server. This is mostly the same as the local file browser, with the
7722 following differences:
7728 Instead of file permissions, mutt displays the string "IMAP",
7729 possibly followed by the symbol "+", indicating
7730 that the entry contains both messages and subfolders. On
7731 Cyrus-like servers folders will often contain both messages and
7738 For the case where an entry can contain both messages and
7739 subfolders, the selection key (bound to <literal>enter</literal> by default)
7740 will choose to descend into the subfolder view. If you wish to
7742 the messages in that folder, you must use <literal>view-file</literal> instead
7743 (bound to <literal>space</literal> by default).
7749 You can create, delete and rename mailboxes with the
7750 <literal>create-mailbox</literal>, <literal>delete-mailbox</literal>, and
7751 <literal>rename-mailbox</literal> commands (default bindings: <literal>
7755 <literal>d</literal> and <literal>r</literal>, respectively).
7757 <literal>subscribe</literal> and <literal>unsubscribe</literal>
7758 to mailboxes (normally
7759 these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
7769 <sect2 id="imap-auth">
7770 <title>Authentication</title>
7773 Mutt-ng supports four authentication methods with IMAP servers: SASL,
7774 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
7775 NTLM authentication for you poor exchange users out there, but it has
7776 yet to be integrated into the main tree). There is also support for
7777 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
7778 IMAP server without having an account. To use ANONYMOUS, simply make
7779 your username blank or "anonymous".
7783 SASL is a special super-authenticator, which selects among several
7785 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most
7787 method available on your host and the server. Using some of these
7789 (including DIGEST-MD5 and possibly GSSAPI), your entire session will
7791 encrypted and invisible to those teeming network snoops. It is the
7793 option if you have it. To use it, you must have the Cyrus SASL
7794 libraryinstalled on your system and compile mutt with the <emphasis>
7801 Mutt-ng will try whichever methods are compiled in and available on
7803 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
7807 There are a few variables which control authentication:
7813 <muttng-doc:varref name="imap-user"/> - controls
7814 the username under which you request authentication on the IMAP
7816 for all authenticators. This is overridden by an explicit
7818 the mailbox path (i.e. by using a mailbox name of the form
7819 <literal>{user@host}</literal>).
7825 <muttng-doc:varref name="imap-pass"/> - a
7826 password which you may preset, used by all authentication
7828 a password is needed.
7834 <muttng-doc:varref name="imap-authenticators"/>
7835 - a colon-delimited list of IMAP
7836 authentication methods to try, in the order you wish to try
7838 specified, this overrides mutt's default (attempt everything,
7857 <title>NNTP Support (OPTIONAL)</title>
7860 If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
7861 a newsserver via NNTP. You can open a newsgroup with the
7862 ``change-newsgroup'' function from the index/pager which is by default
7863 bound to <muttng-doc:key>i</muttng-doc:key>.
7867 The Default newsserver can be obtained from the <muttng-doc:envvar name="NNTPSERVER"/>
7868 environment variable. Like other
7870 info about subscribed newsgroups is saved in a file as specified by the
7871 <muttng-doc:varref name="nntp-newsrc"/> variable.
7872 Article headers are cached and can be loaded from a file when a
7873 newsgroup is entered instead loading from newsserver; currently, this
7874 caching mechanism still is different from the header caching for
7878 <sect2 id="nntp-scoring">
7879 <title>Again: Scoring</title>
7882 Especially for Usenet, people often ask for advanced filtering
7883 and scoring functionality. Of course, mutt-ng has scoring and
7884 allows a killfile, too. How to use a killfile has been discussed
7885 in <link linkend="command-score">Message Scoring</link>.
7889 What has not been discusses in detail is mutt-ng's built-in
7890 realname filter. For may newsreaders including those for
7891 ``advanced users'' like <emphasis>slrn</emphasis> or <emphasis>tin</emphasis>, there are frequent
7892 request for such functionality. The solutions offered often are
7893 complicated regular expressions.
7897 In mutt-ng this is as easy as
7902 <muttng-doc:lstconf>
7903 score ~* =42</muttng-doc:lstconf>
7908 This tells mutt-ng to apply a score of 42 to all messages whose
7909 sender specified a valid realname and a valid email address. Using
7914 <muttng-doc:lstconf>
7915 score !~* =42</muttng-doc:lstconf>
7920 on the contrary applies a score of 42 to all messages <emphasis>not</emphasis>
7921 matching those criteria which are very strict:
7930 Email addresses must be valid according to <muttng-doc:rfc num="2822"/>
7936 the name must consist of at least 2 fields whereby a field
7937 must not end in a dot. This means that ``Joe User'' and ``Joe
7938 A.User'' are valid while ``J. User'' and ``J. A. User'' aren't.
7945 it's assumed that users are interested in reading their
7946 own mail and mail from people who they have defined an alias
7947 forso that those 2 groups of messages are excluded from the
7971 <title>SMTP Support (OPTIONAL)</title>
7974 Mutt-ng can be built using a library called ``libESMTP'' which
7975 provides SMTP functionality. When <literal>configure</literal> was
7977 <literal>--with-libesmtp</literal> or the output <literal>muttng -v</literal> contains
7978 <literal>+USE_LIBESMTP</literal>, this will be or is the case
7980 support includes support for Delivery Status Notification
7981 (see <link linkend="dsn">dsn</link> section) as well as
7982 handling the <literal>8BITMIME</literal> flag controlled via
7983 <muttng-doc:varref name="use-8bitmime"/>.
7987 To enable sending mail directly via SMTP without an MTA such as
7988 Postfix or SSMTP and the like, simply set the <muttng-doc:varref name="smtp-host"/>
7989 variable pointing to your SMTP server.
7993 Authentication mechanisms are available via the <muttng-doc:varref name="smtp-user"/>
7994 and <muttng-doc:varref name="smtp-pass"/> variables.
7998 Transport Encryption via the StartTLS command is also available. For
7999 this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
8000 Secondly, the <muttng-doc:varref name="smtp-use-tls"/> variable
8002 to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
8003 the server supports it: for the second case, the connection will fail
8004 ifit doesn't while switching back to unencrypted communication for the
8009 Some mail providers require user's to set a particular envelope
8010 sender, i.e. they allow for only one value which may not be what the
8011 user wants to send as the <literal>From:</literal> header. In this
8013 <muttng-doc:varref name="smtp-envelope"/> may be used
8014 to set the envelope different from the <literal>From:</literal> header.
8019 <sect1 id="account-hook">
8020 <title>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)</title>
8023 If you happen to have accounts on multiple IMAP and/or POP servers,
8024 you may find managing all the authentication settings inconvenient and
8025 error-prone. The <muttng-doc:hook name="account"/> command may help. This hook works like
8026 <muttng-doc:hook name="folder"/> but is invoked whenever you access a remote mailbox
8027 (including inside the folder browser), not just when you open the
8037 <muttng-doc:lstconf>
8038 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
8039 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
8040 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</muttng-doc:lstconf>
8050 <sect1 id="urlview">
8051 <title>Start a WWW Browser on URLs (EXTERNAL)</title>
8054 If a message contains URLs (<emphasis>unified resource locator</emphasis> = address in the
8055 WWW space like <emphasis>http://www.mutt.org/</emphasis>), it is
8057 a menu with all the URLs and start a WWW browser on one of them. This
8058 functionality is provided by the external urlview program which can be
8059 retrieved at <muttng-doc:web url="ftp://ftp.mutt.org/mutt/contrib/"/>
8060 and the configuration commands:
8062 <muttng-doc:lstconf>
8063 macro index \cb |urlview\n
8064 macro pager \cb |urlview\n</muttng-doc:lstconf>
8074 <sect1 id="compressed-folders">
8075 <title>Compressed folders Support (OPTIONAL)</title>
8078 If Mutt-ng was compiled with compressed folders support (by running the
8079 <emphasis>configure</emphasis> script with the <emphasis>
8083 can open folders stored in an arbitrary format, provided that the user
8084 has a script to convert from/to this format to one of the accepted.
8088 The most common use is to open compressed archived folders e.g. with
8093 In addition, the user can provide a script that gets a folder in an
8094 accepted format and appends its context to the folder in the
8095 user-defined format, which may be faster than converting the entire
8096 folder to the accepted format, appending to it and converting back to
8097 the user-defined format.
8101 There are three hooks defined (<muttng-doc:hook name="open"/>,
8102 <muttng-doc:hook name="close"/> and <muttng-doc:hook name="append"/>
8103 )which define commands to uncompress and compress
8104 a folder and to append messages to an existing compressed folder
8114 <muttng-doc:lstconf>
8115 open-hook \\.gz$ "gzip -cd %f > %t"
8116 close-hook \\.gz$ "gzip -c %t > %f"
8117 append-hook \\.gz$ "gzip -c %t >> %f" </muttng-doc:lstconf>
8122 You do not have to specify all of the commands. If you omit <muttng-doc:hook name="append"/>
8123 ,the folder will be open and
8124 closed again each time you will add to it. If you omit <muttng-doc:hook name="close"/>
8125 (or give empty command) , the
8126 folder will be open in the mode. If you specify <muttng-doc:hook name="append"/>
8127 though you'll be able to append
8132 Note that Mutt-ng will only try to use hooks if the file is not in one
8134 the accepted formats. In particular, if the file is empty, mutt
8135 supposes it is not compressed. This is important because it allows the
8136 use of programs that do not have well defined extensions. Just use
8137 "." as a regexp. But this may be surprising if your
8138 compressing script produces empty files. In this situation, unset
8139 <muttng-doc:varref name="save-empty"/>
8140 ,so that the compressed file
8141 will be removed if you delete all of the messages.
8144 <sect2 id="open-hook">
8145 <title>Open a compressed mailbox for reading</title>
8148 Usage: <muttng-doc:hook name="open"/> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
8152 The <emphasis>command</emphasis> is the command that can be used for
8154 folders whose names match <emphasis>regexp</emphasis>.
8158 The <emphasis>command</emphasis> string is the printf-like format
8160 should accept two parameters: %f, which is replaced with the
8161 (compressed) folder name, and %t which is replaced with the
8162 name of the temporary folder to which to write.
8166 %f and %t can be repeated any number of times in the
8167 command string, and all of the entries are replaced with the
8168 appropriate folder name. In addition, %% is replaced by
8169 %, as in printf, and any other %anything is left as is.
8173 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the original compressed file.
8174 The <emphasis>command</emphasis> should return non-zero exit status
8176 mutt knows something's wrong.
8185 <muttng-doc:lstconf>
8186 open-hook \\.gz$ "gzip -cd %f > %t"</muttng-doc:lstconf>
8191 If the <emphasis>command</emphasis> is empty, this operation is
8192 disabled for this file
8198 <sect2 id="close-hook">
8199 <title>Write a compressed mailbox</title>
8202 Usage: <muttng-doc:hook name="close"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
8206 This is used to close the folder that was open with the <muttng-doc:hook name="open"/>
8207 command after some changes were made to it.
8211 The <emphasis>command</emphasis> string is the command that can be
8212 used for closing the
8213 folders whose names match <emphasis>regexp</emphasis>. It has the
8215 the <muttng-doc:hook name="open"/> command. Temporary
8217 in this case is the folder previously produced by the <muttng-doc:hook name="open"/>
8222 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
8223 <emphasis>command</emphasis> should return non-zero exit status if it
8225 knows something's wrong.
8234 <muttng-doc:lstconf>
8235 close-hook \\.gz$ "gzip -c %t > %f"</muttng-doc:lstconf>
8240 If the <emphasis>command</emphasis> is empty, this operation is
8241 disabled for this file
8242 type, and the file can only be open in the readonly mode.
8246 <muttng-doc:hook name="close"/> is not called when you
8248 from the folder if the folder was not changed.
8253 <sect2 id="append-hook">
8254 <title>Append a message to a compressed mailbox</title>
8257 Usage: <muttng-doc:hook name="append"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
8261 This command is used for saving to an existing compressed folder.
8262 The <emphasis>command</emphasis> is the command that can be used for
8264 folders whose names match <emphasis>regexp</emphasis>. It has the
8266 the <muttng-doc:hook name="open"/> command.
8267 The temporary folder in this case contains the messages that are
8272 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
8273 <emphasis>command</emphasis> should return non-zero exit status if it
8275 knows something's wrong.
8284 <muttng-doc:lstconf>
8285 append-hook \\.gz$ "gzip -c %t >> %f" </muttng-doc:lstconf>
8290 When <muttng-doc:hook name="append"/> is used, the
8292 not opened, which saves time, but this means that we can not find out
8293 what the folder type is. Thus the default (<muttng-doc:varref name="mbox-type"/>
8294 )type is always supposed (i.e.
8295 this is the format used for the temporary folder).
8299 If the file does not exist when you save to it, <muttng-doc:hook name="close"/>
8300 is called, and not <muttng-doc:hook name="append"/>. <muttng-doc:hook name="append"/>
8302 for appending to existing folders.
8306 If the <emphasis>command</emphasis> is empty, this operation is
8307 disabled for this file
8308 type. In this case, the folder will be open and closed again (using
8309 <muttng-doc:hook name="open"/> and <muttng-doc:hook name="close"/>
8310 respectively) each time you will add to it.
8315 <sect2 id="encrypted-folders">
8316 <title>Encrypted folders</title>
8319 The compressed folders support can also be used to handle encrypted
8320 folders. If you want to encrypt a folder with PGP, you may want to
8321 usethe following hooks:
8326 <muttng-doc:lstconf>
8327 open-hook \\.pgp$ "pgp -f < %f > %t"
8328 close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"</muttng-doc:lstconf>
8333 Please note, that PGP does not support appending to an encrypted
8334 folder, so there is no <muttng-doc:hook name="append"/> defined.
8338 <emphasis role="bold">Note:</emphasis> the folder is temporary stored
8339 decrypted in the /tmp
8340 directory, where it can be read by your system administrator. So
8341 thinkabout the security aspects of this.
8359 <chapter id="mime-support"> <!--{{{-->
8360 <title>Mutt-ng's MIME Support</title>
8363 Quite a bit of effort has been made to make Mutt-ng the premier text-mode
8364 MIME MUA. Every effort has been made to provide the functionality that
8365 the discerning MIME user requires, and the conformance to the standards
8366 wherever possible. When configuring Mutt-ng for MIME, there are two
8367 extratypes of configuration files which Mutt-ng uses. One is the
8368 <literal>mime.types</literal> file, which contains the mapping of file
8370 IANA MIME types. The other is the <literal>mailcap</literal> file, which
8372 the external commands to use for handling specific MIME types.
8376 <title>Using MIME in Mutt</title>
8379 There are three areas/menus in Mutt-ng which deal with MIME, they are
8381 pager (while viewing a message), the attachment menu and the compose
8385 <sect2 id="mime-view">
8386 <title>Viewing MIME messages in the pager</title>
8389 When you select a message from the index and view it in the pager,
8391 decodes the message to a text representation. Mutt-ng internally
8393 a number of MIME types, including <literal>text/plain, text/enriched,
8394 message/rfc822, and message/news
8396 .In addition, the export
8397 controlled version of Mutt-ng recognizes a variety of PGP MIME types,
8398 including PGP/MIME and application/pgp.
8402 Mutt-ng will denote attachments with a couple lines describing them.
8403 These lines are of the form:
8406 [-- Attachment #1: Description --]
8407 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]</screen>
8409 Where the <literal>Description</literal> is the description or
8410 filename given for the
8411 attachment, and the <literal>Encoding</literal> is one of
8412 <literal>7bit/8bit/quoted-printable/base64/binary</literal>.
8416 If Mutt-ng cannot deal with a MIME type, it will display a message
8420 [-- image/gif is unsupported (use 'v' to view this part) --]</screen>
8426 <sect2 id="attach-menu">
8427 <title>The Attachment Menu</title>
8430 The default binding for <literal>view-attachments</literal> is `v',
8432 attachment menu for a message. The attachment menu displays a list
8433 ofthe attachments in a message. From the attachment menu, you can
8435 print, pipe, delete, and view attachments. You can apply these
8436 operations to a group of attachments at once, by tagging the
8438 and by using the ``tag-prefix'' operator. You can also reply to the
8439 current message from this menu, and only the current attachment (or
8441 attachments tagged) will be quoted in your reply. You can view
8442 attachments as text, or view them using the mailcap viewer
8447 Finally, you can apply the usual message-related functions (like
8448 <muttng-doc:funcref name="resend-message"/>, and the reply
8449 and forward functions) to attachments of type <literal>message/rfc822</literal>.
8453 See the help on the attachment menu for more information.
8458 <sect2 id="compose-menu">
8459 <title>The Compose Menu</title>
8462 The compose menu is the menu you see before you send a message. It
8463 allows you to edit the recipient list, the subject, and other aspects
8464 of your message. It also contains a list of the attachments of your
8465 message, including the main body. From this menu, you can print,
8467 filter, pipe, edit, compose, review, and rename an attachment or a
8468 list of tagged attachments. You can also modifying the attachment
8469 information, notably the type, encoding and description.
8473 Attachments appear as follows:
8476 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
8477 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description></screen>
8482 The '-' denotes that Mutt-ng will delete the file after sending (or
8483 postponing, or canceling) the message. It can be toggled with the
8484 <literal>toggle-unlink</literal> command (default: u). The next
8486 content-type, and can be changed with the <literal>edit-type</literal> command
8487 (default: ^T). The next field is the encoding for the
8489 which allows a binary message to be encoded for transmission on 7bit
8490 links. It can be changed with the <literal>edit-encoding</literal>
8492 (default: ^E). The next field is the size of the attachment,
8493 rounded to kilobytes or megabytes. The next field is the filename,
8494 which can be changed with the <literal>rename-file</literal> command
8496 The final field is the description of the attachment, and can be
8497 changed with the <literal>edit-description</literal> command
8509 <sect1 id="mime-types">
8511 MIME Type configuration with <literal>mime.types</literal>
8515 When you add an attachment to your mail message, Mutt-ng searches your
8516 personal mime.types file within <muttng-doc:envvar name="HOME"/> and then
8517 the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
8518 <literal>/etc/mime.types</literal>
8522 The mime.types file consist of lines containing a MIME type and a space
8523 separated list of extensions. For example:
8526 application/postscript ps eps
8528 audio/x-aiff aif aifc aiff</screen>
8530 A sample <literal>mime.types</literal> file comes with the Mutt-ng
8532 should contain most of the MIME types you are likely to use.
8536 If Mutt-ng can not determine the mime type by the extension of the file
8538 attach, it will look at the file. If the file is free of binary
8539 information, Mutt-ng will assume that the file is plain text, and mark
8541 as <literal>text/plain</literal>. If the file contains binary
8542 information, then Mutt-ng will
8543 mark it as <literal>application/octet-stream</literal>. You can change
8545 type that Mutt-ng assigns to an attachment by using the <literal>
8548 command from the compose menu (default: ^T). The MIME type is
8550 major mime type followed by the sub-type, separated by a '/'. 6 major
8551 types: application, text, image, video, audio, and model have been
8553 after various internet discussions. Mutt-ng recognises all of these if
8555 appropriate entry is found in the mime.types file. It also recognises
8557 major mime types, such as the chemical type that is widely used in the
8558 molecular modelling community to pass molecular data in various forms
8560 various molecular viewers. Non-recognised mime types should only be
8562 if the recipient of the message is likely to be expecting such
8572 <sect1 id="mime-mailcap">
8574 MIME Viewer configuration with <literal>mailcap</literal>
8578 Mutt-ng supports <muttng-doc:rfc num="1524"/> MIME Configuration, in particular the Unix
8579 specific format specified in Appendix A of the RfC. This file format
8580 is commonly referred to as the mailcap format. Many MIME compliant
8581 programs utilize the mailcap format, allowing you to specify handling
8582 for all MIME types in one place for all programs. Programs known to
8583 use this format include Netscape, XMosaic, lynx and metamail.
8587 In order to handle various MIME types that Mutt-ng can not handle
8588 internally, Mutt-ng parses a series of external configuration files to
8589 find an external handler. The default search string for these files
8590 is a colon delimited list set to
8593 ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap</screen>
8595 where <muttng-doc:envvar name="HOME"/> is your home directory.
8599 In particular, the metamail distribution will install a mailcap file,
8600 usually as <literal>/usr/local/etc/mailcap</literal>, which contains
8605 <sect2 id="mime-mailcap-basics">
8606 <title>The Basics of the mailcap file</title>
8609 A mailcap file consists of a series of lines which are comments,
8615 A comment line consists of a # character followed by anything you
8620 A blank line is blank.
8624 A definition line consists of a content type, a view command, and any
8625 number of optional fields. Each field of a definition line is
8626 dividedby a semicolon ';' character.
8630 The content type is specified in the MIME standard type/subtype
8633 <literal>text/plain, text/html, image/gif,</literal>
8634 etc. In addition, the mailcap format includes two formats for
8635 wildcards, one using the special '*' subtype, the other is the
8637 wild, where you only include the major type. For example, <literal>
8641 <literal>video,</literal> will match all image types and video types,
8646 The view command is a Unix command for viewing the type specified.
8648 are two different types of commands supported. The default is to send
8649 the body of the MIME message to the command on stdin. You can change
8650 this behavior by using %s as a parameter to your view command.
8651 This will cause Mutt-ng to save the body of the MIME message to a
8653 file, and then call the view command with the %s replaced by
8654 the name of the temporary file. In both cases, Mutt-ng will turn over
8656 terminal to the view program until the program quits, at which time
8658 will remove the temporary file if it exists.
8662 So, in the simplest form, you can send a text/plain message to the
8663 external pager more on stdin:
8666 text/plain; more</screen>
8668 Or, you could send the message as a file:
8671 text/plain; more %s</screen>
8673 Perhaps you would like to use lynx to interactively view a text/html
8677 text/html; lynx %s</screen>
8679 In this case, lynx does not support viewing a file from stdin, so you
8680 must use the %s syntax.
8681 <emphasis role="bold">Note:</emphasis> <emphasis>Some older versions
8682 of lynx contain a bug where they
8683 will check the mailcap file for a viewer for text/html. They will
8685 the line which calls lynx, and run it. This causes lynx to
8687 spawn itself to view the object.
8692 On the other hand, maybe you don't want to use lynx interactively,
8693 youjust want to have it convert the text/html to text/plain, then you
8698 text/html; lynx -dump %s | more</screen>
8703 Perhaps you wish to use lynx to view text/html files, and a pager on
8704 all other text formats, then you would use the following:
8708 text/*; more</screen>
8710 This is the simplest form of a mailcap file.
8715 <sect2 id="mime-mailcap-security">
8716 <title>Secure use of mailcap</title>
8719 The interpretation of shell meta-characters embedded in MIME
8721 can lead to security problems in general. Mutt-ng tries to quote
8723 in expansion of %s syntaxes properly, and avoids risky
8725 substituting them, see the <muttng-doc:varref name="mailcap-sanitize"/>
8730 Although mutt's procedures to invoke programs with mailcap seem to be
8731 safe, there are other applications parsing mailcap, maybe taking less
8733 of it. Therefore you should pay attention to the following rules:
8737 <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
8738 Don't quote them with single or double quotes. Mutt-ng does this for
8739 you, the right way, as should any other program which interprets
8740 mailcap. Don't put them into backtick expansions. Be highly careful
8741 with eval statements, and avoid them if possible at all. Trying to
8743 broken behaviour with quotes introduces new leaks - there is no
8744 alternative to correct quoting in the first place.
8748 If you have to use the %-expandos' values in context where you
8750 quoting or backtick expansions, put that value into a shell variable
8751 and reference the shell variable where necessary, as in the following
8752 example (using <literal>$charset</literal> inside the backtick
8754 since it is not itself subject to any further expansion):
8760 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
8761 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1</screen>
8767 <sect2 id="mime-mailcap-advanced">
8768 <title>Advanced mailcap Usage</title>
8770 <sect3 id="mime-mailcap-advanced-fields">
8771 <title>Optional Fields</title>
8774 In addition to the required content-type and view command fields,
8776 can add semi-colon ';' separated fields to set flags and other
8778 Mutt-ng recognizes the following optional fields:
8782 <term>copiousoutput</term>
8785 This flag tells Mutt-ng that the command passes possibly
8787 text on stdout. This causes Mutt-ng to invoke a pager
8788 (either the internal
8789 pager or the external pager defined by the pager variable)
8791 of the view command. Without this flag, Mutt-ng assumes
8793 is interactive. One could use this to replace the pipe to <literal>
8796 in the <literal>lynx -dump</literal> example in the Basic
8800 text/html; lynx -dump %s ; copiousoutput</screen>
8802 This will cause lynx to format the text/html output as
8804 and Mutt-ng will use your standard pager to display the
8810 <term>needsterminal</term>
8813 Mutt-ng uses this flag when viewing attachments with <muttng-doc:cmdref name="auto_view"/>,
8814 in order to decide whether it should honor the setting
8815 of the <muttng-doc:varref name="wait-key"/> variable or
8816 not. When an attachment is viewed using an interactive
8818 corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
8819 <muttng-doc:varref name="wait-key"/> and the exit
8820 statusof the program to decide if it will ask you to press
8822 external program has exited. In all other situations it
8829 <term>compose=<command></term>
8832 This flag specifies the command to use to create a new
8834 specific MIME type. Mutt-ng supports this from the compose
8840 <term>composetyped=<command></term>
8843 This flag specifies the command to use to create a new
8845 specific MIME type. This command differs from the compose
8847 that mutt will expect standard MIME headers on the data.
8849 used to specify parameters, filename, description, etc. for
8851 attachment. Mutt-ng supports this from the compose menu.
8856 <term>print=<command></term>
8859 This flag specifies the command to use to print a specific
8861 Mutt-ng supports this from the attachment and compose
8867 <term>edit=<command></term>
8870 This flag specifies the command to use to edit a specific
8872 Mutt-ng supports this from the compose menu, and also uses
8874 new attachments. Mutt-ng will default to the defined
8881 <term>nametemplate=<template></term>
8884 This field specifies the format for the file denoted by
8886 command fields. Certain programs will require a certain
8888 for instance, to correctly view a file. For instance, lynx
8890 interpret a file as <literal>text/html</literal> if the
8891 file ends in <literal>.html</literal>.
8892 So, you would specify lynx as a <literal>text/html</literal> viewer with a line in
8893 the mailcap file like:
8896 text/html; lynx %s; nametemplate=%s.html</screen>
8902 <term>test=<command></term>
8905 This field specifies a command to run to test whether this
8907 entry should be used. The command is defined with the
8909 rules defined in the next section. If the command returns
8911 test passed, and Mutt-ng uses this entry. If the command
8913 then the test failed, and Mutt-ng continues searching for
8915 <emphasis role="bold">Note:</emphasis> <emphasis>the
8916 content-type must match before Mutt-ng performs the test.
8921 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8922 text/html; lynx %s</screen>
8924 In this example, Mutt-ng will run the program RunningX
8926 if the X Window manager is running, and non-zero if it
8928 RunningX returns 0, then Mutt-ng will call netscape to
8930 text/html object. If RunningX doesn't return 0, then
8932 to the next entry and use lynx to display the text/html
8942 <sect3 id="mime-mailcap-advanced-searchorder">
8943 <title>Search Order</title>
8946 When searching for an entry in the mailcap file, Mutt-ng will
8948 the most useful entry for its purpose. For instance, if you are
8949 attempting to print an <literal>image/gif</literal>, and you have
8951 entries in your mailcap file, Mutt-ng will search for an entry with
8957 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
8958 nametemplate=%s.gif</screen>
8960 Mutt-ng will skip the <literal>image/*</literal> entry and use the <literal>
8963 entry with the print command.
8967 In addition, you can use this with <muttng-doc:cmdref name="auto_view"/>
8968 to denote two commands for viewing an attachment, one to be viewed
8969 automatically, the other to be viewed interactively from the
8971 menu. In addition, you can then use the test feature to determine
8973 viewer to use interactively depending on your environment.
8976 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8977 text/html; lynx %s; nametemplate=%s.html
8978 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput</screen>
8980 For <muttng-doc:cmdref name="auto_view"/>, Mutt-ng will choose
8982 entry because of the copiousoutput tag. For interactive viewing,
8984 will run the program RunningX to determine if it should use the
8986 entry. If the program returns non-zero, Mutt-ng will use the
8988 for interactive viewing.
8993 <sect3 id="mime-mailcap-advanced-expansion">
8994 <title>Command Expansion</title>
8997 The various commands defined in the mailcap files are passed to the
8998 <literal>/bin/sh</literal> shell using the system() function.
9000 command is passed to <literal>/bin/sh -c</literal>, it is parsed to
9002 various special parameters with information from Mutt-ng. The
9004 Mutt-ng expands are:
9011 As seen in the basic mailcap section, this variable is
9013 to a filename specified by the calling program. This file
9015 the body of the message to view/print/edit or where the
9017 program should place the results of composition. In
9019 use of this keyword causes Mutt-ng to not pass the body of
9021 to the view/print/edit program on stdin.
9029 Mutt-ng will expand %t to the text representation of
9031 type of the message in the same form as the first parameter
9033 mailcap definition line, ie <literal>text/html</literal> or
9034 <literal>image/gif</literal>.
9039 <term>%{<parameter>}</term>
9042 Mutt-ng will expand this to the value of the specified
9044 from the Content-Type: line of the mail message. For
9046 Your mail message contains:
9048 <muttng-doc:lstmail>
9049 Content-Type: text/plain; charset=iso-8859-1</muttng-doc:lstmail>
9051 then Mutt-ng will expand %{charset} to
9052 iso-8859-1. The default metamail
9053 mailcap file uses this feature to test the charset to spawn
9055 using the right charset to view the message.
9063 This will be replaced by a %
9068 Mutt-ng does not currently support the %F and %n
9070 specified in <muttng-doc:rfc num="1524"/>. The main purpose of these parameters is for
9071 multipart messages, which is handled internally by Mutt-ng.
9078 <sect2 id="mime-mailcap-examples">
9079 <title>Example mailcap files</title>
9082 This mailcap file is fairly simple and standard:
9085 # I'm always running X :)
9086 video/*; xanim %s > /dev/null
9087 image/*; xv %s > /dev/null
9089 # I'm always running netscape (if my computer had more memory, maybe)
9090 text/html; netscape -remote 'openURL(%s)'</screen>
9095 This mailcap file shows quite a number of examples:
9101 # Use xanim to view all videos Xanim produces a header on startup,
9102 # send that to /dev/null so I don't see it
9103 video/*; xanim %s > /dev/null
9105 # Send html to a running netscape by remote
9106 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
9107 # If I'm not running netscape but I am running X, start netscape on the
9109 text/html; netscape %s; test=RunningX
9111 # Else use lynx to view it as text
9114 # This version would convert the text/html to text/plain
9115 text/html; lynx -dump %s; copiousoutput
9117 # I use enscript to print text in two columns to a page
9118 text/*; more %s; print=enscript -2Gr %s
9120 # Netscape adds a flag to tell itself to view jpegs internally
9121 image/jpeg;xv %s; x-mozilla-flags=internal
9123 # Use xv to view images if I'm running X
9124 # In addition, this uses the \ to extend the line and set my editor
9126 image/*;xv %s; test=RunningX; edit=xpaint %s
9128 # Convert images to text using the netpbm tools
9129 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | \
9130 pgmtopbm | pbmtoascii -1x2 ) 2>&1 ; copiousoutput
9132 # Send excel spreadsheets to my NT box
9133 application/ms-excel; open.pl %s</screen>
9146 <title>MIME Autoview</title>
9149 <muttng-doc:cmddef name="auto_view">mime-type [mime-type ...]</muttng-doc:cmddef>
9153 <muttng-doc:cmddef name="unauto_view">mime-type [mime-type ...]</muttng-doc:cmddef>
9157 In addition to explicitly telling Mutt-ng to view an attachment with
9158 theMIME viewer defined in the mailcap file, Mutt-ng has support for
9159 automatically viewing MIME attachments while in the pager.
9163 To work, you must define a viewer in the mailcap file which uses the
9164 <literal>copiousoutput</literal> option to denote that it is
9166 Usually, you also use the entry to convert the attachment to a text
9167 representation which you can view in the pager.
9171 You then use the <literal>auto_view</literal> muttrc command to
9173 content-types that you wish to view automatically.
9177 For instance, if you set auto_view to:
9179 <muttng-doc:lstconf>
9180 auto_view text/html application/x-gunzip application/postscript
9181 image/gif application/x-tar-gz</muttng-doc:lstconf>
9186 Mutt-ng could use the following mailcap entries to automatically view
9187 attachments of these types.
9190 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
9191 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
9192 application/x-gunzip; gzcat; copiousoutput
9193 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
9194 application/postscript; ps2ascii %s; copiousoutput</screen>
9199 ``unauto_view'' can be used to remove previous entries from the
9201 This can be used with <muttng-doc:hook name="message"/> to autoview messages based on size,
9203 ``unauto_view *'' will remove all previous entries.
9213 <title>MIME Multipart/Alternative</title>
9216 <muttng-doc:cmddef name="alternative_order">mime-type [mime-type ...]</muttng-doc:cmddef>
9220 <muttng-doc:cmddef name="unalternative_order">mime-type [mime-type ...]</muttng-doc:cmddef>
9224 Mutt-ng has some heuristics for determining which attachment of a
9225 multipart/alternative type to display. First, mutt will check the
9226 alternative_order list to determine if one of the available
9227 typesis preferred. The alternative_order list consists of a
9229 MIME types in order, including support for implicit and explicit
9230 wildcards, for example:
9232 <muttng-doc:lstconf>
9233 alternative_order text/enriched text/plain text
9234 application/postscript image/*</muttng-doc:lstconf>
9239 Next, mutt will check if any of the types have a defined
9240 <muttng-doc:cmdref name="auto_view"/>, and use that. Failing
9241 that, Mutt-ng will look for any text type. As a last attempt, mutt
9242 willlook for any type it knows how to handle.
9246 To remove a MIME type from the <literal>alternative_order</literal> list, use the
9247 <literal>unalternative_order</literal> command.
9257 <title>MIME Lookup</title>
9260 <muttng-doc:cmddef name="mime_lookup">mime-type [mime-type ...]</muttng-doc:cmddef>
9264 <muttng-doc:cmddef name="unmime_lookup">mime-type [mime-type ...]</muttng-doc:cmddef>
9268 Mutt-ng's mime_lookup list specifies a list of mime-types that
9270 be treated according to their mailcap entry. This option is designed
9271 todeal with binary types such as application/octet-stream. When an
9273 mime-type is listed in mime_lookup, then the extension of the
9275 be compared to the list of extensions in the mime.types file. The
9277 associated with this extension will then be used to process the
9279 according to the rules in the mailcap file and according to any other
9281 options (such as auto_view) specified. Common usage would be:
9283 <muttng-doc:lstconf>
9284 mime_lookup application/octet-stream application/X-Lotus-Manuscript</muttng-doc:lstconf>
9289 In addition, the unmime_lookup command may be used to disable
9291 for any particular mime-type if it had been set, for example, in a
9309 <chapter id="security"> <!--{{{-->
9310 <title>Security Considerations</title>
9313 First of all, mutt-ng contains no security holes included by
9314 intention but may contain unknown security holes. As a consequence,
9315 please run mutt-ng only with as few permissions as possible.
9319 Please do not run mutt-ng as the super user.
9323 When configuring mutt-ng, there're some points to note about secure
9328 In practice, mutt-ng can be easily made as vulnerable as even the
9329 most insecure mail user agents (in their default configuration) just
9330 by changing mutt-ng's configuration files: it then can execute
9331 arbitrary programs and scripts attached to messages, send out private
9332 data on its own, etc. Although this is not believed to the common type
9333 of setup, please read this chapter carefully.
9336 <sect1 id="security-passwords">
9337 <title>Passwords</title>
9340 Although mutt-ng can be told the various passwords for accounts,
9341 please never store passwords in configuration files. Besides the
9342 fact that the system's operator can always read them, you could
9343 forget to replace the actual password with asterisks when reporting
9344 a bug or asking for help via, for example, a mailing list so that
9345 your mail including your password could be archived by internet
9346 search engines, etc. Please never store passwords on disk.
9351 <sect1 id="security-tempfiles">
9352 <title>Temporary Files</title>
9355 Mutt-ng uses many temporary files for viewing messages, verifying
9356 digital signatures, etc. The <muttng-doc:varref name="umask"/>
9357 variable can be used to change the default permissions of these
9358 files. Please only change it if you really know what you are doing.
9359 Also, a different location for these files may be desired which can
9360 be changed via the <muttng-doc:varref name="tmpdir"/> variable.
9365 <sect1 id="security-leaks">
9366 <title>Information Leaks</title>
9368 <sect2 id="security-leaks-mid">
9369 <title>Message-ID: headers</title>
9372 In the default configuration, mutt-ng will leak some information
9373 to the outside world when sending messages: the generation of
9374 <literal>Message-ID:</literal> headers includes a step counter which
9376 (and rotated) with every message sent. If you'd like to hide this
9377 information probably telling others how many mail you sent in which
9378 time, you at least need to remove the <literal>%P</literal>
9380 default setting of the <muttng-doc:varref name="msgid-format"/> variable. Please make sure that
9381 you really know how local parts of these <literal>Message-ID:</literal> headers
9387 <sect2 id="security-leaks-mailto">
9388 <title>mailto:-style links</title>
9391 As mutt-ng be can be set up to be the mail client to handle
9392 <literal>mailto:</literal> style links in websites, there're security
9393 considerations, too. To keep the old behavior by default, mutt-ng
9394 will be strict in interpreting them which means that arbitrary
9395 header fields can be embedded in these links which could override
9396 existing header fields or attach arbitrary files. This may be
9397 problematic if the <muttng-doc:varref name="edit-headers"/>
9398 variable is <emphasis>unset</emphasis>, i.e. the
9399 user doesn't want to see header fields while editing the message.
9403 For example, following a link like
9409 mailto:joe@host?Attach=~/.gnupg/secring.gpg</screen>
9414 will send out the user's private gnupg keyring to <literal>joe@host</literal> if
9415 the user doesn't follow the information on screen carefully
9420 When <emphasis>unsetting</emphasis> the <muttng-doc:varref name="strict-mailto"/>
9421 variable, mutt-ng will
9430 be less strict when interpreting these links by
9431 prepending a <literal>X-Mailto-</literal> string to all header
9433 embedded in such a link <emphasis>and</emphasis>
9440 turn on the <muttng-doc:varref name="edit-headers"/>
9442 force to let the user see all the headers
9443 (because they still may leak information.)
9456 <sect1 id="security-external">
9457 <title>External applications</title>
9460 Mutt-ng in many places has to rely on external applications or
9461 for convenience supports mechanisms involving external
9465 <sect2 id="security-external-mailcap">
9466 <title>mailcap</title>
9469 One of these is the <literal>mailcap</literal> mechanism as defined
9470 by <muttng-doc:rfc num="1524"/>. Mutt-ng can be set up to <emphasis>automatically</emphasis>
9472 given utility as listed in one of the mailcap files (see the
9473 <muttng-doc:varref name="mailcap-path"/>
9474 variable for details.)
9478 These utilities may have a variety of security vulnerabilities,
9479 including overwriting of arbitrary files, information leaks or
9480 other exploitable bugs. These vulnerabilities may go unnoticed by
9481 the user, especially when they are called automatically (and
9482 without interactive prompting) from the mailcap file(s). When
9483 using mutt-ng's autoview mechanism in combination with mailcap
9484 files, please be sure to...
9493 manually select trustworth applications with a reasonable
9501 periodically check the contents of mailcap files,
9502 especially after software installations or upgrades
9509 keep the software packages referenced in the mailcap file up to
9517 leave the <muttng-doc:varref name="mailcap-sanitize"/> variable in its default
9518 state to restrict mailcap expandos to a safe set of characters
9529 <sect2 id="security-external-other">
9530 <title>Other</title>
9533 Besides the mailcap mechanism, mutt-ng uses a number of other
9534 external utilities for operation.
9538 The same security considerations apply for these as for tools
9539 involved via mailcap (for example, mutt-ng is vulnerable to Denial
9540 of Service Attacks with compressed folders support if the
9541 uncompressed mailbox is too large for the disk it is saved to.)
9545 As already noted, most of these problems are not built in but
9546 caused by wrong configuration, so please check your configuration.
9556 <chapter id="reference"> <!--{{{-->
9557 <title>Reference</title>
9559 <sect1 id="commandline">
9560 <title>Command line options</title>
9563 Running <literal>mutt</literal> with no arguments will make Mutt-ng
9564 attempt to read your spool
9565 mailbox. However, it is possible to read other mailboxes and
9566 to send messages from the command line as well.
9571 <table frame="none" rowsep="1" texstr="l|l">
9572 <title>Reference: Command Line Options</title>
9573 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9576 <entry>Option</entry>
9577 <entry>Description</entry>
9582 <entry><literal>-A</literal></entry>
9583 <entry>expand an alias</entry>
9586 <entry><literal>-a</literal></entry>
9587 <entry>attach a file to a message</entry>
9590 <entry><literal>-b</literal></entry>
9591 <entry>specify a blind carbon-copy (BCC) address</entry>
9594 <entry><literal>-c</literal></entry>
9595 <entry>specify a carbon-copy (Cc) address</entry>
9598 <entry><literal>-e</literal></entry>
9599 <entry>specify a config command to be run after initialization files are read</entry>
9602 <entry><literal>-f</literal></entry>
9603 <entry>specify a mailbox to load</entry>
9606 <entry><literal>-F</literal></entry>
9607 <entry>specify an alternate file to read initialization commands</entry>
9610 <entry><literal>-h</literal></entry>
9611 <entry>print help on command line options</entry>
9614 <entry><literal>-H</literal></entry>
9615 <entry>specify a draft file from which to read a header and body</entry>
9618 <entry><literal>-i</literal></entry>
9619 <entry>specify a file to include in a message composition</entry>
9622 <entry><literal>-m</literal></entry>
9623 <entry>specify a default mailbox type</entry>
9626 <entry><literal>-n</literal></entry>
9627 <entry>do not read the system Muttngrc</entry>
9630 <entry><literal>-p</literal></entry>
9631 <entry>recall a postponed message</entry>
9634 <entry><literal>-Q</literal></entry>
9635 <entry>query a configuration variable</entry>
9638 <entry><literal>-R</literal></entry>
9639 <entry>open mailbox in read-only mode</entry>
9642 <entry><literal>-s</literal></entry>
9643 <entry>specify a subject (enclose in quotes if it contains spaces)</entry>
9646 <entry><literal>-t</literal></entry>
9647 <entry>dump the value of all variables to stdout</entry>
9650 <entry><literal>-T</literal></entry>
9651 <entry>dump the value of all changed variables to stdout</entry>
9654 <entry><literal>-v</literal></entry>
9655 <entry>show version number and compile-time definitions</entry>
9658 <entry><literal>-x</literal></entry>
9659 <entry>simulate the mailx(1) compose mode</entry>
9662 <entry><literal>-y</literal></entry>
9663 <entry>show a menu containing the files specified by the mailboxes command</entry>
9666 <entry><literal>-z</literal></entry>
9667 <entry>exit immediately if there are no messages in the mailbox</entry>
9670 <entry><literal>-Z</literal></entry>
9671 <entry>open the first folder with new message,exit immediately if none</entry>
9680 To read messages in a mailbox
9684 <literal>mutt</literal> ] -nz ] ] -F <emphasis>muttrc</emphasis> ] ] -m <emphasis>
9687 ] ] -f <emphasis>mailbox</emphasis> ]
9691 To compose a new message
9695 <literal>mutt</literal> ] -n ] ] -F <emphasis>muttrc</emphasis> ] ] -a <emphasis>
9698 ] ] -c <emphasis>address</emphasis> ] ] -i <emphasis>
9701 ] ] -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> ] <emphasis>
9708 Mutt-ng also supports a ``batch'' mode to send prepared messages.
9710 input from the file you wish to send. For example,
9714 <literal>mutt -s "data set for run #2"
9715 professor@bigschool.edu
9721 This command will send a message to ``professor@bigschool.edu'' with a
9723 of ``data set for run #2''. In the body of the message will be the
9725 of the file ``~/run2.dat''.
9734 <sect1 id="patterns">
9735 <title>Patterns</title>
9739 <table frame="none" rowsep="1" id="tab-patterns" texstr="l|l|l">
9740 <title>Reference: Patterns</title>
9741 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9744 <entry>Pattern Modifier</entry>
9745 <entry>Argument</entry>
9746 <entry>Description</entry>
9751 <entry><muttng-doc:pattern full="1" name="A"/></entry>
9752 <entry><literal></literal></entry>
9753 <entry>all messages</entry>
9756 <entry><muttng-doc:pattern full="1" name="b"/></entry>
9757 <entry><literal>EXPR</literal></entry>
9758 <entry>messages which contain EXPR in the message body</entry>
9761 <entry><muttng-doc:pattern full="1" name="B"/></entry>
9762 <entry><literal>EXPR</literal></entry>
9763 <entry>messages which contain EXPR in the whole message</entry>
9766 <entry><muttng-doc:pattern full="1" name="c"/></entry>
9767 <entry><literal>EXPR</literal></entry>
9768 <entry>messages carbon-copied to EXPR</entry>
9771 <entry><muttng-doc:pattern full="1" name="C"/></entry>
9772 <entry><literal>EXPR</literal></entry>
9773 <entry>message is either to: or cc: EXPR</entry>
9776 <entry><muttng-doc:pattern full="1" name="D"/></entry>
9777 <entry><literal></literal></entry>
9778 <entry>deleted messages</entry>
9781 <entry><muttng-doc:pattern full="1" name="d"/></entry>
9782 <entry><literal>[MIN]-[MAX]</literal></entry>
9783 <entry>messages with ``date-sent'' in a Date range</entry>
9786 <entry><muttng-doc:pattern full="1" name="E"/></entry>
9787 <entry><literal></literal></entry>
9788 <entry>expired messages</entry>
9791 <entry><muttng-doc:pattern full="1" name="e"/></entry>
9792 <entry><literal>EXPR</literal></entry>
9793 <entry>message which contains EXPR in the ``Sender'' field</entry>
9796 <entry><muttng-doc:pattern full="1" name="F"/></entry>
9797 <entry><literal></literal></entry>
9798 <entry>flagged messages</entry>
9801 <entry><muttng-doc:pattern full="1" name="f"/></entry>
9802 <entry><literal>EXPR</literal></entry>
9803 <entry>messages originating from EXPR</entry>
9806 <entry><muttng-doc:pattern full="1" name="g"/></entry>
9807 <entry><literal></literal></entry>
9808 <entry>cryptographically signed messages</entry>
9811 <entry><muttng-doc:pattern full="1" name="G"/></entry>
9812 <entry><literal></literal></entry>
9813 <entry>cryptographically encrypted messages</entry>
9816 <entry><muttng-doc:pattern full="1" name="H"/></entry>
9817 <entry><literal>EXPR</literal></entry>
9818 <entry>messages with a spam attribute matching EXPR</entry>
9821 <entry><muttng-doc:pattern full="1" name="h"/></entry>
9822 <entry><literal>EXPR</literal></entry>
9823 <entry>messages which contain EXPR in the message header</entry>
9826 <entry><muttng-doc:pattern full="1" name="k"/></entry>
9827 <entry><literal></literal></entry>
9828 <entry>message contains PGP key material</entry>
9831 <entry><muttng-doc:pattern full="1" name="i"/></entry>
9832 <entry><literal>EXPR</literal></entry>
9833 <entry>message which match ID in the ``Message-ID'' field</entry>
9836 <entry><muttng-doc:pattern full="1" name="L"/></entry>
9837 <entry><literal>EXPR</literal></entry>
9838 <entry>message is either originated or received by EXPR</entry>
9841 <entry><muttng-doc:pattern full="1" name="l"/></entry>
9842 <entry><literal></literal></entry>
9843 <entry>message is addressed to a known mailing list</entry>
9846 <entry><muttng-doc:pattern full="1" name="m"/></entry>
9847 <entry><literal>[MIN]-[MAX]</literal></entry>
9848 <entry>message in the range MIN to MAX *)</entry>
9851 <entry><muttng-doc:pattern full="1" name="M"/></entry>
9852 <entry><literal></literal></entry>
9853 <entry>multipart messages</entry>
9856 <entry><muttng-doc:pattern full="1" name="n"/></entry>
9857 <entry><literal>[MIN]-[MAX]</literal></entry>
9858 <entry>messages with a score in the range MIN to MAX *)</entry>
9861 <entry><muttng-doc:pattern full="1" name="N"/></entry>
9862 <entry><literal></literal></entry>
9863 <entry>new messages</entry>
9866 <entry><muttng-doc:pattern full="1" name="O"/></entry>
9867 <entry><literal></literal></entry>
9868 <entry>old messages</entry>
9871 <entry><muttng-doc:pattern full="1" name="p"/></entry>
9872 <entry><literal></literal></entry>
9873 <entry>message is addressed to you (consults alternates)</entry>
9876 <entry><muttng-doc:pattern full="1" name="P"/></entry>
9877 <entry><literal></literal></entry>
9878 <entry>message is from you (consults alternates)</entry>
9881 <entry><muttng-doc:pattern full="1" name="Q"/></entry>
9882 <entry><literal></literal></entry>
9883 <entry>messages which have been replied to</entry>
9886 <entry><muttng-doc:pattern full="1" name="R"/></entry>
9887 <entry><literal></literal></entry>
9888 <entry>read messages</entry>
9891 <entry><muttng-doc:pattern full="1" name="r"/></entry>
9892 <entry><literal>[MIN]-[MAX]</literal></entry>
9893 <entry>messages with ``date-received'' in a Date range</entry>
9896 <entry><muttng-doc:pattern full="1" name="S"/></entry>
9897 <entry><literal></literal></entry>
9898 <entry>superseded messages</entry>
9901 <entry><muttng-doc:pattern full="1" name="s"/></entry>
9902 <entry><literal>EXPR</literal></entry>
9903 <entry>messages having EXPR in the ``Subject'' field.</entry>
9906 <entry><muttng-doc:pattern full="1" name="T"/></entry>
9907 <entry><literal></literal></entry>
9908 <entry>tagged messages</entry>
9911 <entry><muttng-doc:pattern full="1" name="t"/></entry>
9912 <entry><literal>EXPR</literal></entry>
9913 <entry>messages addressed to EXPR</entry>
9916 <entry><muttng-doc:pattern full="1" name="U"/></entry>
9917 <entry><literal></literal></entry>
9918 <entry>unread messages</entry>
9921 <entry><muttng-doc:pattern full="1" name="u"/></entry>
9922 <entry><literal></literal></entry>
9923 <entry>message is addressed to a subscribed mailing list</entry>
9926 <entry><muttng-doc:pattern full="1" name="v"/></entry>
9927 <entry><literal></literal></entry>
9928 <entry>message is part of a collapsed thread.</entry>
9931 <entry><muttng-doc:pattern full="1" name="V"/></entry>
9932 <entry><literal></literal></entry>
9933 <entry>cryptographically verified messages</entry>
9936 <entry><muttng-doc:pattern full="1" name="w"/></entry>
9937 <entry><literal>EXPR</literal></entry>
9938 <entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry>
9941 <entry><muttng-doc:pattern full="1" name="x"/></entry>
9942 <entry><literal>EXPR</literal></entry>
9943 <entry>messages which contain EXPR in the `References' field</entry>
9946 <entry><muttng-doc:pattern full="1" name="y"/></entry>
9947 <entry><literal>EXPR</literal></entry>
9948 <entry>messages which contain EXPR in the `X-Label' field</entry>
9951 <entry><muttng-doc:pattern full="1" name="z"/></entry>
9952 <entry><literal>[MIN]-[MAX]</literal></entry>
9953 <entry>messages with a size in the range MIN to MAX *)</entry>
9956 <entry><muttng-doc:pattern full="1" name="="/></entry>
9957 <entry><literal></literal></entry>
9958 <entry>duplicated messages (see $duplicate_threads)</entry>
9961 <entry><muttng-doc:pattern full="1" name="$"/></entry>
9962 <entry><literal></literal></entry>
9963 <entry>unreferenced messages (requires threaded view)</entry>
9966 <entry><muttng-doc:pattern full="1" name="*"/></entry>
9967 <entry><literal></literal></entry>
9968 <entry>``From'' contains realname and (syntactically) valid address
9969 (excluded are addresses matching against alternates or any alias)</entry>
9978 <link linkend="advanced-regexp">regexp</link>. Special attention has to be
9979 made when using regular expressions inside of patterns. Specifically,
9980 Mutt-ng's parser for these patterns will strip one level of backslash
9982 which is normally used for quoting. If it is your intention to use a
9983 backslash in the regular expression, you will need to use two
9989 *) The forms <literal><[MAX]</literal>, <literal>>[MIN]</literal>,
9990 <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
9996 <sect1 id="commands">
9997 <title>Configuration Commands</title>
10000 The following are the commands understood by mutt.
10009 <literal><muttng-doc:hook name="account"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10015 <literal><muttng-doc:cmdref name="alias"/></literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>, ... ]
10021 <literal><muttng-doc:cmdref name="unalias"/></literal> [ * | <emphasis>key</emphasis> ... ]
10027 <literal><muttng-doc:cmdref name="alternates"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10033 <literal><muttng-doc:cmdref name="unalternates"/></literal> [ * | <emphasis>regexp</emphasis> ... ]
10039 <literal><muttng-doc:cmdref name="alternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10045 <literal><muttng-doc:cmdref name="unalternative_order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10051 <literal><muttng-doc:hook name="append"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10057 <literal><muttng-doc:cmdref name="auto_view"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10063 <literal><muttng-doc:cmdref name="unauto_view"/></literal><emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10069 <literal><muttng-doc:cmdref name="bind"/></literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
10075 <literal><muttng-doc:hook name="charset"/></literal> <emphasis>alias</emphasis> <emphasis>charset</emphasis>
10081 <literal><muttng-doc:hook name="close"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10087 <literal><muttng-doc:cmdref name="color"/></literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> [ <emphasis>regexp</emphasis> ]
10093 <literal><muttng-doc:cmdref name="uncolor"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10099 <literal><muttng-doc:cmdref name="exec"/></literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
10105 <literal><muttng-doc:hook name="fcc"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10111 <literal><muttng-doc:hook name="fcc-save"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10117 <literal><muttng-doc:hook name="folder"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10123 <literal><muttng-doc:cmdref name="hdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
10129 <literal><muttng-doc:cmdref name="unhdr_order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
10135 <literal><muttng-doc:hook name="charset"/></literal> <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
10141 <literal><muttng-doc:cmdref name="ignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10147 <literal><muttng-doc:cmdref name="unignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10153 <literal><muttng-doc:cmdref name="lists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10159 <literal><muttng-doc:cmdref name="unlists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10165 <literal><muttng-doc:cmdref name="macro"/></literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
10171 <literal><muttng-doc:cmdref name="mailboxes"/></literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
10177 <literal><muttng-doc:hook name="mbox"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10183 <literal><muttng-doc:hook name="message"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10189 <literal><muttng-doc:cmdref name="mime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10196 <muttng-doc:cmdref name="unmime_lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10202 <literal><muttng-doc:cmdref name="mono"/></literal> <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
10208 <literal><muttng-doc:cmdref name="unmono"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10214 <literal><muttng-doc:cmdref name="my_hdr"/></literal> <emphasis>string</emphasis>
10220 <literal><muttng-doc:cmdref name="unmy_hdr"/></literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
10226 <literal><muttng-doc:hook name="open"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10232 <literal><muttng-doc:hook name="crypt"/></literal> <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
10238 <literal><muttng-doc:cmdref name="push"/></literal> <emphasis>string</emphasis>
10244 <literal><muttng-doc:cmdref name="reset"/> </literal><emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
10250 <literal><muttng-doc:hook name="save"/></literal> <emphasis>regexp</emphasis> <emphasis>filename</emphasis>
10256 <literal><muttng-doc:cmdref name="score"/> </literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
10262 <literal><muttng-doc:cmdref name="unscore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10268 <literal><muttng-doc:hook name="send"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10274 <literal><muttng-doc:hook name="reply"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10280 <literal><muttng-doc:cmdref name="set"/></literal> [no|inv]<emphasis>variable</emphasis>[ =<emphasis>value</emphasis> ] [ <emphasis>variable</emphasis> ... ]
10286 <literal><muttng-doc:cmdref name="unset"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
10292 <literal><muttng-doc:cmdref name="source"/></literal> <emphasis>filename</emphasis>
10298 <literal><muttng-doc:cmdref name="spam"/></literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
10304 <literal><muttng-doc:cmdref name="nospam"/></literal> <emphasis>pattern</emphasis>
10310 <literal><muttng-doc:cmdref name="subscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10316 <literal><muttng-doc:cmdref name="unsubscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10322 <literal><muttng-doc:cmdref name="toggle"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
10328 <literal><muttng-doc:cmdref name="unhook"/></literal> <emphasis>hook-type</emphasis>
10338 <sect1 id="variables">
10339 <title>Configuration variables</title>
10342 The following list contains all variables which, in the process of
10343 providing more consistency, have been renamed and are partially even
10344 removed already. The left column contains the old synonym variables,
10345 the right column the full/new name:
10349 <anchor id="sect-obsolete"/>
10351 <table frame="none" rowsep="1" texstr="l|l">
10352 <title>Reference: Obsolete Variables</title>
10353 <tgroup cols="2" align="left" colsep="1" rowsep="1">
10356 <entry>Old Name</entry>
10357 <entry>New Name</entry>
10362 <entry><literal>edit_hdrs</literal></entry>
10363 <entry><muttng-doc:varref name="edit-headers"/></entry>
10366 <entry><literal>forw_decode</literal></entry>
10367 <entry><muttng-doc:varref name="forward-decode"/></entry>
10370 <entry><literal>forw_format</literal></entry>
10371 <entry><muttng-doc:varref name="forward-format"/></entry>
10374 <entry><literal>forw_quote</literal></entry>
10375 <entry><muttng-doc:varref name="forward-quote"/></entry>
10378 <entry><literal>hdr_format</literal></entry>
10379 <entry><muttng-doc:varref name="index-format"/></entry>
10382 <entry><literal>indent_str</literal></entry>
10383 <entry><muttng-doc:varref name="indent-string"/></entry>
10386 <entry><literal>mime_fwd</literal></entry>
10387 <entry><muttng-doc:varref name="mime-forward"/></entry>
10390 <entry><literal>msg_format</literal></entry>
10391 <entry><muttng-doc:varref name="message-format"/></entry>
10394 <entry><literal>pgp_autosign</literal></entry>
10395 <entry><muttng-doc:varref name="crypt-autosign"/></entry>
10398 <entry><literal>pgp_autoencrypt</literal></entry>
10399 <entry><muttng-doc:varref name="crypt-autoencrypt"/></entry>
10402 <entry><literal>pgp_replyencrypt</literal></entry>
10403 <entry><muttng-doc:varref name="crypt-replyencrypt"/></entry>
10406 <entry><literal>pgp_replysign</literal></entry>
10407 <entry><muttng-doc:varref name="crypt-replysign"/></entry>
10410 <entry><literal>pgp_replysignencrypted</literal></entry>
10411 <entry><muttng-doc:varref name="crypt-replysignencrypted"/></entry>
10414 <entry><literal>pgp_verify_sig</literal></entry>
10415 <entry><muttng-doc:varref name="crypt-verify-sig"/></entry>
10418 <entry><literal>pgp_create_traditional</literal></entry>
10419 <entry><muttng-doc:varref name="pgp-autoinline"/></entry>
10422 <entry><literal>pgp_auto_traditional</literal></entry>
10423 <entry><muttng-doc:varref name="pgp-replyinline"/></entry>
10426 <entry><literal>forw_decrypt</literal></entry>
10427 <entry><muttng-doc:varref name="forward-decrypt"/></entry>
10430 <entry><literal>smime_sign_as</literal></entry>
10431 <entry><muttng-doc:varref name="smime-default-key"/></entry>
10434 <entry><literal>post_indent_str</literal></entry>
10435 <entry><muttng-doc:varref name="post-indent-string"/></entry>
10438 <entry><literal>print_cmd</literal></entry>
10439 <entry><muttng-doc:varref name="print-command"/></entry>
10442 <entry><literal>shorten_hierarchy</literal></entry>
10443 <entry><muttng-doc:varref name="sidebar-shorten-hierarchy"/></entry>
10446 <entry><literal>ask_followup_to</literal></entry>
10447 <entry><muttng-doc:varref name="nntp-ask-followup-to"/></entry>
10450 <entry><literal>ask_x_comment_to</literal></entry>
10451 <entry><muttng-doc:varref name="nntp-ask-x-comment-to"/></entry>
10454 <entry><literal>catchup_newsgroup</literal></entry>
10455 <entry><muttng-doc:varref name="nntp-catchup"/></entry>
10458 <entry><literal>followup_to_poster</literal></entry>
10459 <entry><muttng-doc:varref name="nntp-followup-to-poster"/></entry>
10462 <entry><literal>group_index_format</literal></entry>
10463 <entry><muttng-doc:varref name="nntp-group-index-format"/></entry>
10466 <entry><literal>inews</literal></entry>
10467 <entry><muttng-doc:varref name="nntp-inews"/></entry>
10470 <entry><literal>mime_subject</literal></entry>
10471 <entry><muttng-doc:varref name="nntp-mime-subject"/></entry>
10474 <entry><literal>news_cache_dir</literal></entry>
10475 <entry><muttng-doc:varref name="nntp-cache-dir"/></entry>
10478 <entry><literal>news_server</literal></entry>
10479 <entry><muttng-doc:varref name="nntp-host"/></entry>
10482 <entry><literal>newsrc</literal></entry>
10483 <entry><muttng-doc:varref name="nntp-newsrc"/></entry>
10486 <entry><literal>nntp_poll</literal></entry>
10487 <entry><muttng-doc:varref name="nntp-mail-check"/></entry>
10490 <entry><literal>pop_checkinterval</literal></entry>
10491 <entry><muttng-doc:varref name="pop-mail-check"/></entry>
10494 <entry><literal>post_moderated</literal></entry>
10495 <entry><muttng-doc:varref name="nntp-post-moderated"/></entry>
10498 <entry><literal>save_unsubscribed</literal></entry>
10499 <entry><muttng-doc:varref name="nntp-save-unsubscribed"/></entry>
10502 <entry><literal>show_new_news</literal></entry>
10503 <entry><muttng-doc:varref name="nntp-show-new-news"/></entry>
10506 <entry><literal>show_only_unread</literal></entry>
10507 <entry><muttng-doc:varref name="nntp-show-only-unread"/></entry>
10510 <entry><literal>x_comment_to</literal></entry>
10511 <entry><muttng-doc:varref name="nntp-x-comment-to"/></entry>
10514 <entry><literal>smtp_auth_username</literal></entry>
10515 <entry><muttng-doc:varref name="smtp-user"/></entry>
10518 <entry><literal>smtp_auth_password</literal></entry>
10519 <entry><muttng-doc:varref name="smtp-pass"/></entry>
10522 <entry><literal>user_agent</literal></entry>
10523 <entry><muttng-doc:varref name="agent-string"/></entry>
10532 The <literal>contrib</literal> subdirectory contains a script named
10533 <literal>update-config.pl</literal> which eases migration.
10537 A complete list of current variables follows.