X-Git-Url: https://git.llucax.com/software/mutt-debian.git/blobdiff_plain/14c29200cb58d3c4a0830265f2433849781858d0..097d8d8b63b7a270ffe4581e895b9edff5124580:/doc/manual.xml.head diff --git a/doc/manual.xml.head b/doc/manual.xml.head index b751aaf..e8dd169 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -4,18 +4,18 @@ - The Mutt E-Mail Client - - MichaelElkins - me@cs.hmc.edu - - version @VERSION@ - - - - ``All mail clients suck. This one just sucks less.'' -me, circa 1995 - - +The Mutt E-Mail Client + +MichaelElkins +me@cs.hmc.edu + +version @VERSION@ + + + +All mail clients suck. This one just sucks less. — me, circa 1995 + + @@ -33,10 +33,8 @@ groups of messages. Mutt Home Page -http://www.mutt.org/ +The official homepage can be found at +http://www.mutt.org/. @@ -50,8 +48,6 @@ word subscribe in the body to list-name-request@mutt.org. - - @@ -74,64 +70,148 @@ word subscribe in the body to + + +All messages posted to +mutt-announce are automatically forwarded to +mutt-users, so you do not need to be subscribed to +both lists. + + + + + + +Getting Mutt + + +Mutt releases can be downloaded from +ftp://ftp.mutt.org/mutt/. +For a list of mirror sites, please refer to +http://www.mutt.org/download.html. -Note: all messages posted to mutt-announce are automatically -forwarded to mutt-users, so you do not need to be subscribed to both -lists. +For nightly tarballs and version control access, please refer to the +Mutt development site. - -Software Distribution Sites + +Mutt Online Resources + + + +Bug Tracking System + +The official Mutt bug tracking system can be found at +http://bugs.mutt.org/ + + + - + +Wiki + +An (unofficial) wiki can be found +at http://wiki.mutt.org/. + + + + +IRC + -ftp://ftp.mutt.org/mutt/ +For the IRC user community, visit channel #mutt on +irc.freenode.net. + - + +USENET + + +For USENET, see the newsgroup comp.mail.mutt. + + + + + + + + + +Contributing to Mutt + + +There are various ways to contribute to the Mutt project. + + + +Especially for new users it may be helpful to meet other new and +experienced users to chat about Mutt, talk about problems and share +tricks. + + +Since translations of Mutt into other languages are highly appreciated, +the Mutt developers always look for skilled translators that help +improve and continue to maintain stale translations. -For a list of mirror sites, please refer to http://www.mutt.org/download.html. +For contributing code patches for new features and bug fixes, please +refer to the developer pages at +http://dev.mutt.org/ for more details. - -IRC + +Typograhical Conventions -Visit channel #mutt on -irc.freenode.net to chat with -other people interested in Mutt. +This section lists typographical conventions followed throughout this +manual. See table for typographical +conventions for special terms. - + +Typographical conventions for special terms + + +ItemRefers to... + + +printf(3)UNIX manual pages, execute man 3 printf +<PageUp>named keys +<create-alias>named Mutt function +ˆGControl+G key combination +$mail_checkMutt configuration option +$HOMEenvironment variable + + +
+ + +Examples are presented as: + - -USENET + +mutt -v + -See the newsgroup comp.mail.mutt. +Within command synopsis, curly brackets ({}) denote a set +of options of which one is mandatory, square brackets +([]) denote optional arguments, three dots +denote that the argument may be repeated arbitrary times. @@ -140,8 +220,8 @@ url="news:comp.mail.mutt" Copyright -Mutt is Copyright (C) 1996-2005 Michael R. Elkins -me@cs.hmc.edu and others +Mutt is Copyright © 1996-2009 Michael R. Elkins +me@mutt.org and others. @@ -175,54 +255,255 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. This section is intended as a brief overview of how to use Mutt. There are many other features which are described elsewhere in the manual. There is even more information available in the Mutt FAQ and various web -pages. See the Mutt Page for more details. +pages. See the Mutt homepage for more details. The keybindings described in this section are the defaults as distributed. Your local system administrator may have altered the defaults for your site. -You can always type ``?'' in any menu to display the current bindings. +You can always type ? in any menu to display the current bindings. -The first thing you need to do is invoke mutt, simply by typing mutt -at the command line. There are various command-line options, see -either the mutt man page or the reference. +The first thing you need to do is invoke Mutt, simply by typing mutt +at the command line. There are various command-line options, see +either the Mutt man page or the reference. - -Moving Around in Menus + +Core Concepts + + +Mutt is a text-based application which interacts with users through +different menus which are mostly line-/entry-based or page-based. A +line-based menu is the so-called index menu (listing all messages of +the currently opened folder) or the alias menu (allowing you to +select recipients from a list). Examples for page-based menus are the +pager (showing one message at a time) or the help menu listing +all available key bindings. + + + +The user interface consists of a context sensitive help line at the top, +the menu's contents followed by a context sensitive status line and +finally the command line. The command line is used to display +informational and error messages as well as for prompts and for entering +interactive commands. + + + +Mutt is configured through variables which, if the user wants to +permanently use a non-default value, are written to configuration +files. Mutt supports a rich config file syntax to make even complex +configuration files readable and commentable. + + + +Because Mutt allows for customizing almost all key bindings, there are +so-called functions which can be executed manually (using the +command line) or in macros. Macros allow the user to bind a sequence of +commands to a single key or a short key sequence instead of repeating a +sequence of actions over and over. + + + +Many commands (such as saving or copying a message to another folder) +can be applied to a single message or a set of messages (so-called +tagged messages). To help selecting messages, Mutt provides a rich +set of message patterns (such as recipients, sender, body contents, date +sent/received, etc.) which can be combined into complex expressions +using the boolean and and or +operations as well as negating. These patterns can also be used to (for +example) search for messages or to limit the index to show only matching +messages. + + + +Mutt supports a hook concept which allows the user to execute +arbitrary configuration commands and functions in certain situations +such as entering a folder, starting a new message or replying to an +existing one. These hooks can be used to highly customize Mutt's +behaviour including managing multiple identities, customizing the +display for a folder or even implementing auto-archiving based on a +per-folder basis and much more. + + + +Besides an interactive mode, Mutt can also be used as a command-line +tool only send messages. It also supports a +mailx(1)-compatible interface, see for a complete list of command-line +options. + + + + + +Screens and Menus + + +Index + + +The index is the screen that you usually see first when you start +Mutt. It gives an overview over your emails in the currently opened +mailbox. By default, this is your system mailbox. The information you +see in the index is a list of emails, each with its number on the left, +its flags (new email, important email, email that has been forwarded or +replied to, tagged email, ...), the date when email was sent, its +sender, the email size, and the subject. Additionally, the index also +shows thread hierarchies: when you reply to an email, and the other +person replies back, you can see the other's person email in a +"sub-tree" below. This is especially useful for personal email between +a group of people or when you've subscribed to mailing lists. + + + + + +Pager + + +The pager is responsible for showing the email content. On the top of +the pager you have an overview over the most important email headers +like the sender, the recipient, the subject, and much more +information. How much information you actually see depends on your +configuration, which we'll describe below. + + + +Below the headers, you see the email body which usually contains the +message. If the email contains any attachments, you will see more +information about them below the email body, or, if the attachments are +text files, you can view them directly in the pager. + + + +To give the user a good overview, it is possible to configure Mutt to +show different things in the pager with different colors. Virtually +everything that can be described with a regular expression can be +colored, e.g. URLs, email addresses or smileys. + + + + + +File Browser + + +The file browser is the interface to the local or remote file +system. When selecting a mailbox to open, the browser allows custom +sorting of items, limiting the items shown by a regular expression and a +freely adjustable format of what to display in which way. It also allows +for easy navigation through the file system when selecting file(s) to +attach to a message, select multiple files to attach and many more. + + + + + +Help + + +The help screen is meant to offer a quick help to the user. It lists the +current configuration of key bindings and their associated commands +including a short description, and currently unbound functions that +still need to be associated with a key binding (or alternatively, they +can be called via the Mutt command prompt). + + + + + +Compose Menu + + +The compose menu features a split screen containing the information +which really matter before actually sending a message by mail: who gets +the message as what (recipients and who gets what kind of +copy). Additionally, users may set security options like deciding +whether to sign, encrypt or sign and encrypt a message with/for what +keys. Also, it's used to attach messages, to re-edit any attachment +including the message itself. + + + + + +Alias Menu -Information is presented in menus, very similar to ELM, see -for common keys used to navigate menus in Mutt. +The alias menu is used to help users finding the recipients of +messages. For users who need to contact many people, there's no need to +remember addresses or names completely because it allows for searching, +too. The alias mechanism and thus the alias menu also features grouping +several addresses by a shorter nickname, the actual alias, so that users +don't have to select each single recipient manually. + + + +Attachment Menu + + +As will be later discussed in detail, Mutt features a good and stable +MIME implementation, that is, it supports sending and receiving messages +of arbitrary MIME types. The attachment menu displays a message's +structure in detail: what content parts are attached to which parent +part (which gives a true tree structure), which type is of what type and +what size. Single parts may saved, deleted or modified to offer great +and easy access to message's internals. + + + + + + + +Moving Around in Menus + +The most important navigation keys common to line- or entry-based menus +are shown in and in + for page-based menus. + - -Most common navigation keys +
+Most common navigation keys in entry-based menus KeyFunctionDescription -j or Downnext-entrymove to the next entry -k or Upprevious-entrymove to the previous entry -z or PageDnpage-downgo to the next page -Z or PageUppage-upgo to the previous page -= or Homefirst-entryjump to the first entry -* or Endlast-entryjump to the last entry -qquitexit the current menu -?helplist all keybindings for the current menu +j or <Down><next-entry>move to the next entry +k or <Up><previous-entry>move to the previous entry +z or <PageDn><page-down>go to the next page +Z or <PageUp><page-up>go to the previous page += or <Home><first-entry>jump to the first entry +* or <End><last-entry>jump to the last entry +q<quit>exit the current menu +?<help>list all keybindings for the current menu
- + +Most common navigation keys in page-based menus + + +KeyFunctionDescription + + +J or <Return><next-line>scroll down one line +<Backspace><previous-line>sroll up one line +K, <Space> or <PageDn><next-page>move to the next page +- or <PageUp><previous-page>move the previous page +<Home><top>move to the top +<End><bottom>move to the bottom + + +
@@ -240,8 +521,6 @@ reference of available functions, their default key bindings, and short descriptions. - - Most common line editor keys @@ -249,39 +528,37 @@ short descriptions. KeyFunctionDescription -ˆA or <Home>bolmove to the start of the line -ˆB or <Left>backward-charmove back one char -Esc Bbackward-wordmove back one word -ˆD or <Delete>delete-chardelete the char under the cursor -ˆE or <End>eolmove to the end of the line -ˆF or <Right>forward-charmove forward one char -Esc Fforward-wordmove forward one word -<Tab>completecomplete filename or alias -ˆTcomplete-querycomplete address with query -ˆKkill-eoldelete to the end of the line -ESC dkill-eowdelete to the end ot the word -ˆWkill-wordkill the word in front of the cursor -ˆUkill-linedelete entire line -ˆVquote-charquote the next typed key -<Up>history-uprecall previous string from history -<Down>history-downrecall next string from history -<BackSpace>backspacekill the char in front of the cursor -Esc uupcase-wordconvert word to upper case -Esc ldowncase-wordconvert word to lower case -Esc ccapitalize-wordcapitalize the word +ˆA or <Home><bol>move to the start of the line +ˆB or <Left><backward-char>move back one char +Esc B<backward-word>move back one word +ˆD or <Delete><delete-char>delete the char under the cursor +ˆE or <End><eol>move to the end of the line +ˆF or <Right><forward-char>move forward one char +Esc F<forward-word>move forward one word +<Tab><complete>complete filename or alias +ˆT<complete-query>complete address with query +ˆK<kill-eol>delete to the end of the line +Esc d<kill-eow>delete to the end of the word +ˆW<kill-word>kill the word in front of the cursor +ˆU<kill-line>delete entire line +ˆV<quote-char>quote the next typed key +<Up><history-up>recall previous string from history +<Down><history-down>recall next string from history +<BackSpace><backspace>kill the char in front of the cursor +Esc u<upcase-word>convert word to upper case +Esc l<downcase-word>convert word to lower case +Esc c<capitalize-word>capitalize the wordˆGn/aabort<Return>n/afinish editing
- - You can remap the editor functions using the -bind command. For example, to make -the Delete key delete the character in front of -the cursor rather than under, you could use +bind command. For example, to make +the <Delete> key delete the character in front of +the cursor rather than under, you could use: @@ -294,11 +571,15 @@ bind editor <delete> backspace History -The number of items in the built-in editor's history is controlled by -the $history variable. You may -cycle through them at an editor prompt by using the -history-up and/or history-down -commands. +Mutt maintains a history for the built-in editor. The number of items +is controlled by the $history +variable and can be made persistent using an external file specified +using $history_file. +You may cycle through them at an editor prompt by using the +<history-up> and/or +<history-down> commands. But notice that Mutt +does not remember the currently entered text, it only cycles through +history and wraps around at the end or beginning. @@ -306,26 +587,20 @@ Mutt maintains several distinct history lists, one for each of the following categories: - -muttrc commands +.muttrc commands addresses and aliases shell commands filenames patterns everything else - -Mutt automatically filters out repeated items from the history. It +Mutt automatically filters out consecutively repeated items from the history. It also mimics the behavior of some shells by ignoring items starting -with a space. - - - -The latter feature can be useful in macros to not clobber the history's -valuable entries with unwanted entries. +with a space. The latter feature can be useful in macros to not clobber +the history's valuable entries with unwanted entries. @@ -333,13 +608,13 @@ valuable entries with unwanted entries. -Reading Mail - The Index and Pager +Reading Mail Similar to many other mail clients, there are two modes in which mail is -read in Mutt. The first is the index of messages in the mailbox, which is -called the ``index'' in Mutt. The second mode is the display of the -message contents. This is called the ``pager.'' +read in Mutt. The first is a list of messages in the mailbox, which is +called the index menu in Mutt. The second mode is the display of the +message contents. This is called the pager. @@ -347,16 +622,16 @@ The next few sections describe the functions provided in each of these modes. - + The Message Index Common keys used to navigate through and manage messages in the index -are shown in . +are shown in . How messages are presented +in the index menu can be customized using the +$index_format variable. - - Most common message index keys @@ -365,10 +640,10 @@ are shown in . cchange to a different mailbox -ESC cchange to a folder in read-only mode +Esc cchange to a folder in read-only modeCcopy the current message to another mailbox -ESC Cdecode a message and copy it to a folder -ESC sdecode a message and save it to a folder +Esc Cdecode a message and copy it to a folder +Esc sdecode a message and save it to a folderDdelete messages matching a patternddelete the current messageFmark as important @@ -380,7 +655,7 @@ are shown in . ssave-message Ttag messages matching a pattern ttoggle the tag on a message -ESC ttoggle tag on entire message thread +Esc ttoggle tag on entire message thread Uundelete messages matching a pattern uundelete-message vview-attachments @@ -390,255 +665,133 @@ are shown in . @show the author's full e-mail address $save changes to mailbox /search -ESC /search-reverse +Esc /search-reverse ˆLclear and redraw the screen ˆTuntag messages matching a pattern
- - - -Status Flags - In addition to who sent the message and the subject, a short summary of the disposition of each message is printed beside the message number. -Zero or more of the following ``flags'' may appear, which mean: +Zero or more of the flags in +may appear, some of which can be turned on or off using these functions: +<set-flag> and +<clear-flag> +bound by default to w and W respectively. - - - -D - - -message is deleted (is marked for deletion) - - - - -d - - -message have attachments marked for deletion +Furthermore, the flags in reflect +who the message is addressed to. They can be customized with the +$to_chars variable. - - - -K - + + +Message status flags + + +FlagDescription + + +Dmessage is deleted (is marked for deletion) +dmessage has attachments marked for deletion +Kcontains a PGP public key +Nmessage is new +Omessage is old +Pmessage is PGP encrypted +rmessage has been replied to +Smessage is signed, and the signature is successfully verified +smessage is signed +!message is flagged +*message is tagged + + +
+ + +Message recipient flags + + +FlagDescription + + ++message is to you and you only +Tmessage is to you, but also to or cc'ed to others +Cmessage is cc'ed to you +Fmessage is from you +Lmessage is sent to a subscribed mailing list + + +
+ + + + +The Pager + -contains a PGP public key +By default, Mutt uses its builtin pager to display the contents of +messages (an external pager such as less(1) can be +configured, see $pager variable). +The pager is very similar to the Unix program less(1) +though not nearly as featureful. - - - -N - + + +Most common pager keys + + +KeyDescription + + +<Return>go down one line +<Space>display the next page (or next message if at the end of a message) +-go back to the previous page +nsearch for next match +Sskip beyond quoted text +Ttoggle display of quoted text +?show keybindings +/regular expression search +Esc /backward regular expression search +\toggle highlighting of search matches +ˆjump to the top of the message + + +
+ -message is new +In addition to key bindings in , +many of the functions from the index menu are also available in +the pager, such as <delete-message> or <copy-message> +(this is one advantage over using an external pager to view messages). - - - -O - + -message is old +Also, the internal pager supports a couple other advanced features. For +one, it will accept and translate the standard nroff sequences for +bold and underline. These sequences are a series of either the letter, +backspace (ˆH), the letter again for bold or the letter, backspace, +_ for denoting underline. Mutt will attempt to display these +in bold and underline respectively if your terminal supports them. If +not, you can use the bold and underline color +objects to specify a color or mono attribute for them. - - - -P - + -message is PGP encrypted +Additionally, the internal pager supports the ANSI escape sequences for +character attributes. Mutt translates them into the correct color and +character settings. The sequences Mutt supports are: - - - -r - + + +\e[Ps;Ps;..Ps;m + + -message has been replied to - - - - -S - - -message is signed, and the signature is successfully verified - - - - -s - - -message is signed - - - - -! - - -message is flagged - - - - -* - - -message is tagged - - - - - - - -Some of the status flags can be turned on or off using - - - - - -set-flag (default: w) - - - - - -clear-flag (default: W) - - - - - - - - -Furthermore, the following flags reflect who the message is addressed -to. They can be customized with the -$to_chars variable. - - - - - - -+ - - -message is to you and you only - - - - -T - - -message is to you, but also to or cc'ed to others - - - - -C - - -message is cc'ed to you - - - - -F - - -message is from you - - - - -L - - -message is sent to a subscribed mailing list - - - - - - - - - - - -The Pager - - -By default, Mutt uses its builtin pager to display the body of messages. -The pager is very similar to the Unix program less though not nearly as -featureful. - - - - - -Most common pager keys - - -KeyDescription - - -<Return>go down one line -<Space>display the next page (or next message if at the end of a message) --go back to the previous page -nsearch for next match -Sskip beyond quoted text -Ttoggle display of quoted text -?show keybindings -/search for a regular expression (pattern) -ESC /search backwards for a regular expression -\toggle search pattern coloring -ˆjump to the top of the message - - -
- - - - -In addition to key bindings in , -many of the functions from the index are available in -the pager, such as delete-message or copy-message (this is one -advantage over using an external pager to view messages). - - - -Also, the internal pager supports a couple other advanced features. For -one, it will accept and translate the ``standard'' nroff sequences for -bold and underline. These sequences are a series of either the letter, -backspace (ˆH), the letter again for bold or the letter, backspace, -``_'' for denoting underline. Mutt will attempt to display these -in bold and underline respectively if your terminal supports them. If -not, you can use the bold and underline color -objects to specify a color or mono attribute for them. - - - -Additionally, the internal pager supports the ANSI escape sequences for -character attributes. Mutt translates them into the correct color and -character settings. The sequences Mutt supports are -'\e[Ps;Ps;..Ps;m' -where Ps can be one of the codes shown in -. +where Ps can be one of the codes shown in +. @@ -648,7 +801,7 @@ where Ps can be one of the codes shown in Escape codeDescription -0All Attributes Off +0All attributes off1Bold on4Underline on5Blink on @@ -679,12 +832,29 @@ where Ps can be one of the codes shown in
-Mutt uses these attributes for handling text/enriched messages, and they -can also be used by an external autoview -script for highlighting purposes. Note: If you change the colors for your +Mutt uses these attributes for handling text/enriched +messages, and they can also be used by an external +autoview script for highlighting +purposes. + + + + +If you change the colors for your display, for example by changing the color associated with color2 for your xterm, then that color will be used instead of green. + + + + +Note that the search commands in the pager take regular expressions, +which are not quite the same as the more +complex patterns used by the search +command in the index. This is because patterns are used to select messages by +criteria whereas the pager already displays a selected message. + + @@ -692,12 +862,19 @@ your xterm, then that color will be used instead of green. Threaded Mode -When the mailbox is sorted by threads, there are -a few additional functions available in the index and pager modes -as shown in . +So-called threads provide a hierarchy of messages where +replies are linked to their parent message(s). This organizational form +is extremely useful in mailing lists where different parts of the +discussion diverge. Mutt displays threads as a tree structure. +In Mutt, when a mailbox is sorted +by threads, there are a few additional functions +available in the index +and pager modes as shown in +. + Most common thread mode keys @@ -706,100 +883,115 @@ as shown in . KeyFunctionDescription -ˆDdelete-threaddelete all messages in the current thread -ˆUundelete-threadundelete all messages in the current thread -ˆNnext-threadjump to the start of the next thread -ˆPprevious-threadjump to the start of the previous thread -ˆRread-threadmark the current thread as read -ESC ddelete-subthreaddelete all messages in the current subthread -ESC uundelete-subthreadundelete all messages in the current subthread -ESC nnext-subthreadjump to the start of the next subthread -ESC pprevious-subthreadjump to the start of the previous subthread -ESC rread-subthreadmark the current subthread as read -ESC ttag-threadtoggle the tag on the current thread -ESC vcollapse-threadtoggle collapse for the current thread -ESC Vcollapse-alltoggle collapse for all threads -Pparent-messagejump to parent message in thread +ˆD<delete-thread>delete all messages in the current thread +ˆU<undelete-thread>undelete all messages in the current thread +ˆN<next-thread>jump to the start of the next thread +ˆP<previous-thread>jump to the start of the previous thread +ˆR<read-thread>mark the current thread as read +Esc d<delete-subthread>delete all messages in the current subthread +Esc u<undelete-subthread>undelete all messages in the current subthread +Esc n<next-subthread>jump to the start of the next subthread +Esc p<previous-subthread>jump to the start of the previous subthread +Esc r<read-subthread>mark the current subthread as read +Esc t<tag-thread>toggle the tag on the current thread +Esc v<collapse-thread>toggle collapse for the current thread +Esc V<collapse-all>toggle collapse for all threads +P<parent-message>jump to parent message in thread
- - -Note: Collapsing a thread displays only the first message +Collapsing a thread displays only the first message in the thread and hides the others. This is useful when threads contain so many messages that you can only see a handful of threads on the screen. See %M in $index_format. -For example, you could use "%?M?(#%03M)&(%4l)?" in $index_format to optionally -display the number of hidden messages if the thread is collapsed. +For example, you could use %?M?(#%03M)&(%4l)? in $index_format to optionally +display the number of hidden messages if the thread is +collapsed. The %?<char>?<if-part>&<else-part>? +syntax is explained in detail in +format string conditionals. -See also: $strict_threads. +Technically, every reply should contain a list of its parent messages in +the thread tree, but not all do. In these cases, Mutt groups them by +subject which can be controlled using the +$strict_threads variable. - + Miscellaneous Functions -create-alias (default: a) - +In addition, the index and pager +menus have these interesting functions: + + + + +<create-alias> (default: a) + + Creates a new alias based upon the current message (or prompts for a -new one). Once editing is complete, an alias -command is added to the file specified by the $alias_file variable for future use. Note: -Specifying an $alias_file -does not add the aliases specified there-in, you must also source the file. +new one). Once editing is complete, an alias +command is added to the file specified by +the $alias_file variable +for future use + -check-traditional-pgp (default: ESC P) - +Mutt does not read the $alias_file +upon startup so you must explicitly source the file. + + + + + +<check-traditional-pgp> (default: Esc P) + + This function will search the current message for content signed or -encrypted with PGP the "traditional" way, that is, without proper +encrypted with PGP the traditional way, that is, without proper MIME tagging. Technically, this function will temporarily change the MIME content types of the body parts containing PGP data; this -is similar to the edit-type function's +is similar to the <edit-type> function's effect. + + + + +<edit> (default: e) + + -display-toggle-weed (default: h) - - - - -Toggles the weeding of message header fields specified by ignore commands. - - - -edit (default: e) - - - - -This command (available in the ``index'' and ``pager'') allows you to +This command (available in the index and pager) allows you to edit the raw current message as it's present in the mail folder. After you have finished editing, the changed message will be appended to the current folder, and the original message will be -marked for deletion. - - - -edit-type - -(default: ˆE on the attachment menu, and in the pager and index menus; ˆT on the -compose menu) +marked for deletion; if the message is unchanged it won't be replaced. + + + + +<edit-type> (default: +ˆE on the attachment menu, and in the pager and index menus; +ˆT on the compose menu) + + This command is used to temporarily edit an attachment's content type to fix, for instance, bogus character set parameters. When @@ -815,73 +1007,85 @@ Note that this command is also available on the com menu. There, it's used to fine-tune the properties of attachments you are going to send. + + - -enter-command (default: ``:'') - - - + + +<enter-command> (default: :) + + This command is used to execute any command you would normally put in a configuration file. A common use is to check the settings of variables, or in conjunction with macros to change settings on the fly. + + - -extract-keys (default: ˆK) - - - + + +<extract-keys> (default: ˆK) + + This command extracts PGP public keys from the current or tagged message(s) and adds them to your PGP public key ring. + + - -forget-passphrase (default: + + +<forget-passphrase> (default: ˆF) - - - + + This command wipes the passphrase(s) from memory. It is useful, if you misspelled the passphrase. + + - -list-reply (default: L) - - - + + +<list-reply> (default: L) + + Reply to the current or tagged message(s) by extracting any addresses which -match the regular expressions given by the lists or subscribe +match the regular expressions given by the lists or subscribe commands, but also honor any Mail-Followup-To header(s) if the $honor_followup_to configuration variable is set. Using this when replying to messages posted to mailing lists helps avoid duplicate copies being sent to the author of the message you are replying to. + + - -pipe-message (default: |) - - - + + +<pipe-message> (default: |) + + Asks for an external Unix command and pipes the current or tagged message(s) to it. The variables $pipe_decode, $pipe_split, $pipe_sep and $wait_key control the exact behavior of this function. + + + + +<resend-message> (default: Esc e) + + -resend-message (default: ESC e) - - - - -With resend-message, mutt takes the current message as a template for a +Mutt takes the current message as a template for a new message. This function is best described as "recall from arbitrary folders". It can conveniently be used to forward MIME messages while preserving the original mail structure. Note that the amount of headers @@ -892,43 +1096,54 @@ variable. This function is also available from the attachment menu. You can use this to easily resend a message which was included with a bounce message -as a message/rfc822 body part. - - - -shell-escape (default: !) - +as a message/rfc822 body part. + + + + +<shell-escape> (default: !) + + Asks for an external Unix command and executes it. The $wait_key can be used to control whether Mutt will wait for a key to be pressed when the command returns (presumably to let the user read the output of the command), based on -the return status of the named command. - - - -toggle-quoted (default: T) - +the return status of the named command. If no command is given, an +interactive shell is executed. + + + + +<toggle-quoted> (default: T) + + -The pager uses the $quote_regexp variable to detect quoted text when +The pager uses the $quote_regexp variable to detect quoted text when displaying the body of the message. This function toggles the display of the quoted material in the message. It is particularly useful when -are interested in just the response and there is a large amount of +being interested in just the response and there is a large amount of quoted text in the way. + + + + +<skip-quoted> (default: S) + + -skip-quoted (default: S) - - - - -This function will go to the next line of non-quoted text which come +This function will go to the next line of non-quoted text which comes after a line of quoted text in the internal pager. + + + + @@ -937,13 +1152,14 @@ after a line of quoted text in the internal pager. Sending Mail + +Introduction + The bindings shown in are available in the -index for sending messages. +index and pager to start a new message. - - Most common mail sending keys @@ -951,58 +1167,100 @@ The bindings shown in are available in the KeyFunctionDescription -mcomposecompose a new message -rreplyreply to sender -ggroup-replyreply to all recipients -Llist-replyreply to mailing list address -fforwardforward message -bbouncebounce (remail) message -ESC kmail-keymail a PGP public key to someone +m<compose>compose a new message +r<reply>reply to sender +g<group-reply>reply to all recipients +L<list-reply>reply to mailing list address +f<forward>forward message +b<bounce>bounce (remail) message +Esc k<mail-key>mail a PGP public key to someone
- - -Bouncing a message sends the message as is to the recipient you -specify. Forwarding a message allows you to add comments or +Bouncing a message sends the message as-is to the recipient you +specify. Forwarding a message allows you to add comments or modify the message you are forwarding. These items are discussed -in greater detail in the next chapter ``Forwarding -and Bouncing Mail.'' +in greater detail in the next section Forwarding +and Bouncing Mail. Mutt will then enter the compose menu and prompt you for the -recipients to place on the ``To:'' header field. Next, it will ask -you for the ``Subject:'' field for the message, providing a default if -you are replying to or forwarding a message. See also +recipients to place on the To: header field when you hit m to start a new message. Next, it will ask +you for the Subject: field for the message, providing a default if +you are replying to or forwarding a message. You again +have the chance to adjust recipients, subject, and security settings +right before actually sending the message. See also $askcc, $askbcc, $autoedit, -$bounce, +$bounce, $fast_reply, and $include -for changing how Mutt asks these questions. +for changing how and if Mutt asks these questions. -Mutt will then automatically start your $editor on the message body. If the $edit_headers variable is set, the headers will be at -the top of the message in your editor. Any messages you are replying -to will be added in sort order to the message, with appropriate $attribution, $indent_string and $post_indent_string. When forwarding a -message, if the $mime_forward -variable is unset, a copy of the forwarded message will be included. If -you have specified a $signature, it -will be appended to the message. +When replying, Mutt fills these fields with proper values depending on +the reply type. The types of replying supported are: + + +Simple reply + -Once you have finished editing the body of your mail message, you are -returned to the compose menu providing the functions -show in . +Reply to the author directly. + + + + +Group reply + + +Reply to the author as well to all recipients except you; this consults +alternates. + + + + +List reply + + +Reply to all mailing list addresses found, either specified via +configuration or auto-detected. See for +details. + + + + + + +After getting recipients for new messages, forwards or replies, Mutt +will then automatically start your $editor on the message body. If the $edit_headers variable is +set, the headers will be at the top of the message in your editor. Any +messages you are replying to will be added in sort order to the message, +with appropriate $attribution, +$indent_string and +$post_indent_string. +When forwarding a message, if the $mime_forward variable is +unset, a copy of the forwarded message will be included. If you have +specified a $signature, it will +be appended to the message. +Once you have finished editing the body of your mail message, you are +returned to the compose menu providing the functions +shown in to modify, send or postpone the +message. + Most common compose menu keys @@ -1011,98 +1269,138 @@ show in . KeyFunctionDescription -aattach-fileattach a file -Aattach-messageattach message(s) to the message -ESC kattach-keyattach a PGP public key -dedit-descriptionedit description on attachment -Ddetach-filedetach a file -tedit-toedit the To field -ESC fedit-fromedit the From field -redit-reply-toedit the Reply-To field -cedit-ccedit the Cc field -bedit-bccedit the Bcc field -ysend-messagesend the message -sedit-subjectedit the Subject -Ssmime-menuselect S/MIME options -fedit-fccspecify an ``Fcc'' mailbox -ppgp-menuselect PGP options -Ppostpone-messagepostpone this message until later -qquitquit (abort) sending the message -wwrite-fccwrite the message to a folder -iispellcheck spelling (if available on your system) -ˆFforget-passphrasewipe passphrase(s) from memory +a<attach-file>attach a file +A<attach-message>attach message(s) to the message +Esc k<attach-key>attach a PGP public key +d<edit-description>edit description on attachment +D<detach-file>detach a file +t<edit-to>edit the To field +Esc f<edit-from>edit the From field +r<edit-reply-to>edit the Reply-To field +c<edit-cc>edit the Cc field +b<edit-bcc>edit the Bcc field +y<send-message>send the message +s<edit-subject>edit the Subject +S<smime-menu>select S/MIME options +f<edit-fcc>specify an Fcc mailbox +p<pgp-menu>select PGP options +P<postpone-message>postpone this message until later +q<quit>quit (abort) sending the message +w<write-fcc>write the message to a folder +i<ispell>check spelling (if available on your system) +ˆF<forget-passphrase>wipe passphrase(s) from memory
+ +The compose menu is also used to edit the attachments for a message which can be either files +or other messages. The <attach-message> function to will prompt you for a folder to +attach messages from. You can now tag messages in that folder and they +will be attached to the message you are sending. + -Note: The attach-message function will prompt you for a folder to -attach messages from. You can now tag messages in that folder and they -will be attached to the message you are sending. Note that certain +Note that certain operations like composing a new mail, replying, forwarding, etc. are -not permitted when you are in that folder. The %r in $status_format will change to -a 'A' to indicate that you are in attach-message mode. +not permitted when you are in that folder. The %r in +$status_format will change to +a A to indicate that you are in attach-message mode. + + + - -Editing the message header + +Editing the Message Header -When editing the header of your outgoing message, there are a couple of -special features available. +When editing the header because of $edit_headers +being set, there are a several pseudo headers available which +will not be included in sent messages but trigger special Mutt behavior. + +Fcc: Pseudo Header + If you specify + + Fcc: filename - -Mutt will pick up filename -just as if you had used the edit-fcc function in the compose menu. -You can also attach files to your message by specifying +as a header, Mutt will pick up filename +just as if you had used the <edit-fcc> function in the compose menu. +It can later be changed from the compose menu. + + + -Attach: filename [ description ] + +Attach: Pseudo Header -where filename is the file to attach and description is an -optional string to use as the description of the attached file. + +You can also attach files to your message by specifying -When replying to messages, if you remove the In-Reply-To: field from -the header field, Mutt will not generate a References: field, which -allows you to create a new message thread. +Attach: filename +[ description ] -Also see $edit_headers. +where filename is the file to attach and description is an +optional string to use as the description of the attached file. Spaces +in filenames have to be escaped using backslash (\). +The file can be removed as well as more added from the compose menu. - + - -Using Mutt with PGP + +Pgp: Pseudo Header -If you want to use PGP, you can specify +If you want to use PGP, you can specify -Pgp: [ E | S | S<id> ] +Pgp: [ E | S | S<id> ] + + + +E selects encryption, S selects signing and +S<id> selects signing with the given key, setting +$pgp_sign_as +permanently. The selection can later be changed in the compose menu. + + + +In-Reply-To: Header + -``E'' encrypts, ``S'' signs and -``S<id>'' signs with the given key, setting $pgp_sign_as permanently. +When replying to messages, the In-Reply-To: header contains the +Message-Id of the message(s) you reply to. If you remove or modify its value, Mutt will not generate a +References: field, which allows you to create a new message thread, for example +to create a new message to a mailing list without having to enter the mailing list's address. + + + + + +Sending Cryptographically Signed/Encrypted Messages + -If you have told mutt to PGP encrypt a message, it will guide you +If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you through a key selection process when you try to send the message. Mutt will not ask you any questions about keys which have a certified user ID matching one of the message recipients' mail @@ -1113,26 +1411,27 @@ keys can be found. In these cases, you are dropped into a menu with a list of keys from -which you can select one. When you quit this menu, or mutt can't +which you can select one. When you quit this menu, or Mutt can't find any matching keys, you are prompted for a user ID. You can, as -usually, abort this prompt using ˆG. When you do so, mutt will +usually, abort this prompt using ˆG. When you do so, Mutt will return to the compose screen. Once you have successfully finished the key selection, the message -will be encrypted using the selected public keys, and sent out. +will be encrypted using the selected public keys when sent out. -Most fields of the entries in the key selection menu (see also $pgp_entry_format) -have obvious meanings. But some explanations on the capabilities, flags, +Most fields of the entries in the key selection menu (see also $pgp_entry_format) +have obvious meanings. But some explanations on the capabilities, flags, and validity fields are in order. -The flags sequence (%f) will expand to one of the flags in +The flags sequence (%f) will expand to one of the flags in . + PGP key menu flags @@ -1149,89 +1448,37 @@ The flags sequence (%f) will expand to one of the flags in
- - -The capabilities field (%c) expands to a two-character sequence +The capabilities field (%c) expands to a two-character sequence representing a key's capabilities. The first character gives -the key's encryption capabilities: A minus sign (-) means -that the key cannot be used for encryption. A dot (.) means that -it's marked as a signature key in one of the user IDs, but may -also be used for encryption. The letter e indicates that +the key's encryption capabilities: A minus sign (-) means +that the key cannot be used for encryption. A dot (.) means that +it's marked as a signature key in one of the user IDs, but may +also be used for encryption. The letter e indicates that this key can be used for encryption. -The second character indicates the key's signing capabilities. Once -again, a ``-'' implies ``not for signing'', ``.'' implies +The second character indicates the key's signing capabilities. Once +again, a - implies not for signing, . implies that the key is marked as an encryption key in one of the user-ids, and -``s'' denotes a key which can be used for signing. +s denotes a key which can be used for signing. -Finally, the validity field (%t) indicates how well-certified a user-id -is. A question mark (?) indicates undefined validity, a minus -character (-) marks an untrusted association, a space character -means a partially trusted association, and a plus character (+) +Finally, the validity field (%t) indicates how well-certified a user-id +is. A question mark (?) indicates undefined validity, a minus +character (-) marks an untrusted association, a space character +means a partially trusted association, and a plus character (+) indicates complete validity. - -Sending anonymous messages via mixmaster. - - -You may also have configured mutt to co-operate with Mixmaster, an -anonymous remailer. Mixmaster permits you to send your messages -anonymously using a chain of remailers. Mixmaster support in mutt is for -mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03. -It does not support earlier versions or the later so-called version 3 betas, -of which the latest appears to be called 2.9b23. - - - -To use it, you'll have to obey certain restrictions. Most -important, you cannot use the Cc and Bcc headers. To tell -Mutt to use mixmaster, you have to select a remailer chain, using -the mix function on the compose menu. - - - -The chain selection screen is divided into two parts. In the -(larger) upper part, you get a list of remailers you may use. In -the lower part, you see the currently selected chain of remailers. - - - -You can navigate in the chain using the chain-prev and -chain-next functions, which are by default bound to the left -and right arrows and to the h and l keys (think vi -keyboard bindings). To insert a remailer at the current chain -position, use the insert function. To append a remailer behind -the current chain position, use select-entry or append. -You can also delete entries from the chain, using the corresponding -function. Finally, to abandon your changes, leave the menu, or -accept them pressing (by default) the Return key. - - - -Note that different remailers do have different capabilities, -indicated in the %c entry of the remailer menu lines (see -$mix_entry_format). Most important is -the ``middleman'' capability, indicated by a capital ``M'': This -means that the remailer in question cannot be used as the final -element of a chain, but will only forward messages to other -mixmaster remailers. For details on the other capabilities, please -have a look at the mixmaster documentation. - - - - - -Sending format=flowed messages + +Sending Format=Flowed Messages - + Concept @@ -1239,64 +1486,66 @@ have a look at the mixmaster documentation. for short) are text/plain messages that consist of paragraphs which a receiver's mail client may reformat to its own needs which mostly means to customize line lengths regardless of what the sender sent. Technically this is -achieved by letting lines of a ``flowable'' paragraph end in spaces. +achieved by letting lines of a flowable paragraph end in spaces +except for the last line. -While for text-mode clients like mutt it's the best way to assume only a +While for text-mode clients like Mutt it's the best way to assume only a standard 80x25 character cell terminal, it may be desired to let the receiver decide completely how to view a message. - -Mutt support + +Mutt Support Mutt only supports setting the required format=flowed -MIME parameter on outgoing messages if the $text_flowed variable is set. It does not add the -trailing spaces nor does it provide any other feature related to -composing f=f messages (like reformatting -non-f=f parts of a reply to f=f -before calling the editor). +MIME parameter on outgoing messages if the $text_flowed +variable is set, specifically it does not add the +trailing spaces. After editing the initial message text and before entering -the compose menu, mutt properly space-stuffes the message. +the compose menu, Mutt properly space-stuffes the message. Space-stuffing is required by RfC3676 defining format=flowed and means to prepend a space to: all lines starting with a space -lines starting with the word ``From'' +lines starting with the word From followed by space -all lines starting with ``>'' which +all lines starting with > which is not intended to be a quote character + -All leading spaces are to be removed by receiving clients to restore -the original message. +Mutt only supports space-stuffing +for the first two types of lines but not for the third: It is impossible to +safely detect whether a leading > character starts a +quote or not. Furthermore, Mutt only applies space-stuffing +once after the initial edit is finished. + -Note that mutt only support space-stuffing -for the first two types of lines but not for the third: It is impossible to -safely detect whether a leading > character starts a -quote or not. +All leading spaces are to be removed by receiving clients to restore +the original message prior to further processing. - -Editor considerations + +Editor Considerations -As mutt provides no additional features to compose f=f +As Mutt provides no additional features to compose f=f messages, it's completely up to the user and his editor to produce proper messages. Please consider your editor's documentation if you intend to send f=f messages. @@ -1326,28 +1575,14 @@ fo-table for details. Bouncing and forwarding let you send an existing message to recipients -that you specify. Bouncing a message uses the $sendmail command to send a copy to alternative addresses as if -they were the message's original recipients. Forwarding a message, on -the other hand, allows you to modify the message before it is resent -(for example, by adding your own comments). The default key bindings -are shown in . - - - - - -Message forwarding/bouncing keys - - -KeyFunctionDescription - - -fforwardforward message -bbouncebounce (remail) message - - -
- +that you specify. Bouncing a message sends a verbatim copy of a message +to alternative addresses as if they were the message's original +recipients specified in the Bcc header. +Forwarding a message, on the other hand, allows you to modify the message +before it is resent (for example, by adding your own comments). Bouncing +is done using the <bounce> function and forwarding +using the <forward> function bound to b and f +respectively. @@ -1356,8 +1591,8 @@ message's body (surrounded by indicating lines) or including it as a MIME attachment, depending on the value of the $mime_forward variable. Decoding of attachments, like in the pager, can be controlled by the $forward_decode and $mime_forward_decode variables, respectively. The desired forwarding format may depend on the content, -therefore $mime_forward is a quadoption which, for -example, can be set to ``ask-no''. +therefore $mime_forward is a quadoption which, for +example, can be set to ask-no. @@ -1377,7 +1612,7 @@ replying to a message does. At times it is desirable to delay sending a message that you have -already begun to compose. When the postpone-message function is +already begun to compose. When the <postpone-message> function is used in the compose menu, the body of your message and attachments are stored in the mailbox specified by the $postponed variable. This means that you can recall the message even if you exit Mutt and then restart it at a later time. @@ -1385,19 +1620,21 @@ message even if you exit Mutt and then restart it at a later time. Once a message is postponed, there are several ways to resume it. From the -command line you can use the ``-p'' option, or if you compose a new +command line you can use the -p option, or if you compose a new message from the index or pager you will be prompted if postponed messages exist. If multiple messages are currently postponed, the postponed menu will pop up and you can select which message you would like to resume. + -Note: If you postpone a reply to a message, the reply setting of +If you postpone a reply to a message, the reply setting of the message is only updated when you actually finish the message and send it. Also, you must be in the same folder with the message you replied to for the status of the message to be updated. + See also the $postpone quad-option. @@ -1410,17 +1647,20 @@ See also the $postpone quad-option. Configuration + +Location of Initialization Files + -While the default configuration (or ``preferences'') make Mutt +While the default configuration (or preferences) make Mutt usable right out of the box, it is often desirable to tailor Mutt to suit your own tastes. When Mutt is first invoked, it will attempt to -read the ``system'' configuration file (defaults set by your local -system administrator), unless the ``-n'' command line option is specified. This file is typically +read the system configuration file (defaults set by your local +system administrator), unless the -n command line option is specified. This file is typically /usr/local/share/mutt/Muttrc or /etc/Muttrc. Mutt will next look for a file named .muttrc in your home directory. If this file does not exist and your home directory has -a subdirectory named .mutt, mutt try to load a file named -.mutt/muttrc. +a subdirectory named .mutt, Mutt tries to load a file named +.mutt/muttrc. @@ -1428,105 +1668,131 @@ a subdirectory named .mutt, mutt try to load a file named -In addition, mutt supports version specific configuration files that are +In addition, Mutt supports version specific configuration files that are parsed instead of the default files as explained above. For instance, if your system has a Muttrc-0.88 file in the system configuration -directory, and you are running version 0.88 of mutt, this file will be +directory, and you are running version 0.88 of Mutt, this file will be sourced instead of the Muttrc file. The same is true of the user configuration file, if you have a file .muttrc-0.88.6 in your home -directory, when you run mutt version 0.88.6, it will source this file +directory, when you run Mutt version 0.88.6, it will source this file instead of the default .muttrc file. The version number is the -same which is visible using the ``-v'' command line switch or using the show-version key (default: +same which is visible using the -v command line switch or using the show-version key (default: V) from the index menu. + + Syntax of Initialization Files An initialization file consists of a series of commands. Each line of the file may contain one or more commands. -When multiple commands are used, they must be separated by a semicolon (;). +When multiple commands are used, they must be separated by a semicolon +(;). + + +Multiple configuration commands per line set realname='Mutt user' ; ignore x- + + The hash mark, or pound sign -(``#''), is used as a ``comment'' character. You can use it to +(#), is used as a comment character. You can use it to annotate your initialization file. All text after the comment character -to the end of the line is ignored. For example, +to the end of the line is ignored. - - + +Commenting configuration files my_hdr X-Disclaimer: Why are you listening to me? # This is a comment - - + -Single quotes (') and double quotes (") can be used to quote strings +Single quotes (') and double quotes (") can be used to quote strings which contain spaces or other special characters. The difference between the two types of quotes is similar to that of many popular shell programs, namely that a single quote is used to specify a literal string (one that is not interpreted for shell variables or quoting with a backslash [see next paragraph]), while double quotes indicate a string for which -should be evaluated. For example, backtics are evaluated inside of double -quotes, but not for single quotes. +should be evaluated. For example, backticks are evaluated inside of double +quotes, but not for single quotes. -\ quotes the next character, just as in shells such as bash and zsh. -For example, if want to put quotes ``"'' inside of a string, you can use -``\'' to force the next character to be a literal instead of interpreted +\ quotes the next character, just as in shells such as bash and zsh. +For example, if want to put quotes " inside of a string, you can use +\ to force the next character to be a literal instead of interpreted character. + + +Escaping quotes in congfiguration files set realname="Michael \"MuttDude\" Elkins" - - + -``\\'' means to insert a literal ``\'' into the line. -``\n'' and ``\r'' have their usual C meanings of linefeed and +\\ means to insert a literal \ into the line. +\n and \r have their usual C meanings of linefeed and carriage-return, respectively. -A \ at the end of a line can be used to split commands over -multiple lines, provided that the split points don't appear in the -middle of command names. +A \ at the end of a line can be used to split commands over +multiple lines as it escapes the line end, provided that the split points don't appear in the +middle of command names. Lines are first concatenated before +interpretation so that a multi-line can be commented by commenting out +the first line only. + +Splitting long configuration commands over several lines + +set status_format="some very \ +long value split \ +over several lines" + + + It is also possible to substitute the output of a Unix command in an initialization file. This is accomplished by enclosing the command in -backquotes (``). For example, +backticks (``). In , the output of the +Unix command uname -a will be substituted before the +line is parsed. +Since initialization files are line oriented, only +the first line of output from the Unix command will be substituted. + + +Using external command's output in configuration files my_hdr X-Operating-System: `uname -a` - -The output of the Unix command ``uname -a'' will be substituted before the -line is parsed. Note that since initialization files are line oriented, only -the first line of output from the Unix command will be substituted. - + -Both environment variables and mutt variables can be accessed by -prepending ``$'' to the name of the variable. For example, +Both environment variables and Mutt variables can be accessed by +prepending $ to the name of the variable. For example, + +Using environment variables in configuration files set record=+sent_on_$HOSTNAME + -will cause mutt to save outgoing messages to a folder named -``sent_on_kremvax'' if the environment variable HOSTNAME is set to -``kremvax.'' (See $record for +will cause Mutt to save outgoing messages to a folder named +sent_on_kremvax if the environment variable $HOSTNAME is set to +kremvax. (See $record for details.) @@ -1538,23 +1804,93 @@ not be affected. -The commands understood by mutt are explained in the next paragraphs. +The commands understood by Mutt are explained in the next paragraphs. For a complete list, see the command reference. - - - -Address groups - -Usage: group [ -group name [ ... ] ] [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ] ] +All configuration files are expected to be in the current locale as +specified by the $charset variable +which doesn't have a default value since it's determined by Mutt at startup. +If a configuration file is not encoded in the same character set the +$config_charset +variable should be used: all lines starting with the next are recoded +from $config_charset +to $charset. -group is used to directly add either addresses or +This mechanism should be avoided if possible as it has the +following implications: + + + + +These variables should be set early in a configuration +file with $charset preceding +$config_charset so Mutt +knows what character set to convert to. + +If $config_charset is set, it should be set +in each configuration file because the value is global and not +per configuration file. + +Because Mutt first recodes a line before it attempts to parse it, +a conversion introducing question marks or other characters as +part of errors (unconvertable characters, transliteration) may introduce syntax +errors or silently change the meaning of certain tokens (e.g. inserting +question marks into regular expressions). + + + + + + +Address Groups + +Usage: + + +group + + +name + + + + +expr + + + +expr + + + +ungroup + + +name + + + +* + + + +expr + + + +expr + + + + + +group is used to directly add either addresses or regular expressions to the specified group or groups. The different -categories of arguments to the group command can be +categories of arguments to the group command can be in any order. The flags -rx and -addr specify what the following strings (that cannot begin with a hyphen) should be interpreted as: either a regular @@ -1562,10 +1898,10 @@ expression or an email address, respectively. -These address groups can also be created implicitely by the -alias, lists, +These address groups can also be created implicitly by the +alias, lists, subscribe and -alternates commands by specifying the +alternates commands by specifying the optional -group option. @@ -1576,13 +1912,9 @@ display to messages matching a group. -Usage: ungroup [ -group name [ ... ] ] [ * | [ [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ] ] ] - - - -ungroup is used to remove addresses or regular +ungroup is used to remove addresses or regular expressions from the specified group or groups. The syntax is similar to -the group command, however the special character +the group command, however the special character * can be used to empty a group of all of its contents. @@ -1590,77 +1922,95 @@ contents. -Defining/Using aliases - - -Usage: alias [ -group name [ ... ] ] key address [ , address, ... ] - +Defining/Using Aliases + +Usage: + + +alias + + +name + + +key + + +address + + +address + + +unalias + + +name + + + +* + + +key + + + It's usually very cumbersome to remember or type out the address of someone -you are communicating with. Mutt allows you to create ``aliases'' which map +you are communicating with. Mutt allows you to create aliases which map a short string to a full address. + -Note: if you want to create an alias for more than -one address, you must separate the addresses with a comma (``,''). +If you want to create an alias for more than +one address, you must separate the addresses with a comma (,). + The optional -group argument to -alias causes the aliased address(es) to be added to +alias causes the aliased address(es) to be added to the named group. -To remove an alias or aliases (``*'' means all aliases): - - - -unalias [ * | key ... ] +To remove an alias or aliases (* means all aliases): - - alias muttdude me@cs.hmc.edu (Michael Elkins) alias theguys manny, moe, jack - - Unlike other mailers, Mutt doesn't require aliases to be defined -in a special file. The alias command can appear anywhere in -a configuration file, as long as this file is sourced. Consequently, you can have multiple alias files, or -you can have all aliases defined in your muttrc. +in a special file. The alias command can appear anywhere in +a configuration file, as long as this file is sourced. Consequently, you can have multiple alias files, or +you can have all aliases defined in your .muttrc. -On the other hand, the create-alias +On the other hand, the <create-alias> function can use only one file, the one pointed to by the $alias_file variable (which is ˜/.muttrc by default). This file is not special either, in the sense that Mutt will happily append aliases to any file, but in -order for the new aliases to take effect you need to explicitly source this file too. +order for the new aliases to take effect you need to explicitly source this file too. - -For example: - - - - + +Configuring external alias files source /usr/local/share/Mutt.aliases source ~/.mail_aliases set alias_file=~/.mail_aliases - - + -To use aliases, you merely use the alias at any place in mutt where mutt +To use aliases, you merely use the alias at any place in Mutt where Mutt prompts for addresses, such as the To: or Cc: prompt. You can also enter aliases in your editor at the appropriate headers if you have the $edit_headers variable set. @@ -1669,26 +2019,37 @@ also enter aliases in your editor at the appropriate headers if you have the In addition, at the various address prompts, you can use the tab character to expand a partial alias to the full alias. If there are multiple matches, -mutt will bring up a menu with the matching aliases. In order to be -presented with the full list of aliases, you must hit tab with out a partial +Mutt will bring up a menu with the matching aliases. In order to be +presented with the full list of aliases, you must hit tab without a partial alias, such as at the beginning of the prompt or after a comma denoting multiple addresses. In the alias menu, you can select as many aliases as you want with the -select-entry key (default: RET), and use the exit key -(default: q) to return to the address prompt. +select-entry key (default: <Return>), and use the +exit key (default: q) to return to the address prompt. -Changing the default key bindings +Changing the Default Key Bindings - -Usage: bind map key function - +Usage: + + +bind + +map + + +key + + +function + + This command allows you to change the default key bindings (operation @@ -1701,7 +2062,6 @@ be specified by separating them with commas (no additional whitespace is allowed). The currently defined maps are: - @@ -1713,7 +2073,7 @@ This is not a real menu, but is used as a fallback for all of the other menus except for the pager and editor modes. If a key is not defined in another menu, Mutt will look for a binding to use in this menu. This allows you to bind a key to a certain function in multiple menus instead of having -multiple bind statements to accomplish the same task. +multiple bind statements to accomplish the same task. @@ -1722,7 +2082,7 @@ multiple bind statements to accomplish the same task. The alias menu is the list of your personal aliases as defined in your -muttrc. It is the mapping from a short alias name to the full email +.muttrc. It is the mapping from a short alias name to the full email address(es) of the recipient(s). @@ -1781,7 +2141,16 @@ listings. pgp -The pgp menu is used to select the OpenPGP keys used for encrypting outgoing +The pgp menu is used to select the OpenPGP keys used to encrypt outgoing +messages. + + + + +smime + + +The smime menu is used to select the OpenSSL certificates used to encrypt outgoing messages. @@ -1795,23 +2164,38 @@ recalling a message the user was composing, but saved until later. - + +query + + +The query menu is the browser for results returned by +$query_command. + + + + +mix + + +The mixmaster screen is used to select remailer options for outgoing +messages (if Mutt is compiled with Mixmaster support). + + + key is the key (or key sequence) you wish to bind. To specify a control character, use the sequence \Cx, where x is the letter of the control character (for example, to specify control-A use -``\Ca''). Note that the case of x as well as \C is +\Ca). Note that the case of x as well as \C is ignored, so that \CA, \Ca, \cA and \ca are all equivalent. An alternative form is to specify the key as a three digit -octal number prefixed with a ``\'' (for example \177 is +octal number prefixed with a \ (for example \177 is equivalent to \c?). In addition, key may be a symbolic name as shown in . - - Symbolic key names @@ -1846,39 +2230,50 @@ be a symbolic name as shown in .
- - key does not need to be enclosed in quotes unless it contains a -space (`` ''). +space ( ) or semi-colon (;). function specifies which action to take when key is pressed. -For a complete list of functions, see the reference. The special function noop unbinds the specified key +For a complete list of functions, see the reference. The special function <noop> unbinds the specified key sequence. -Defining aliases for character sets - - - -Usage: charset-hook alias charset -Usage: iconv-hook charset local-charset - - - - -The charset-hook command defines an alias for a character set. +Defining Aliases for Character Sets + +Usage: + + +charset-hook + +alias + + +charset + + +iconv-hook + +charset + + +local-charset + + + + +The charset-hook command defines an alias for a character set. This is useful to properly display messages which are tagged with a -character set name not known to mutt. +character set name not known to Mutt. -The iconv-hook command defines a system-specific name for a +The iconv-hook command defines a system-specific name for a character set. This is helpful when your systems character conversion library insists on using strange, system-specific names for character sets. @@ -1887,83 +2282,111 @@ for character sets. -Setting variables based upon mailbox +Setting Variables Based Upon Mailbox - -Usage: folder-hook [!]regexp command - +Usage: + + +folder-hook + +[!]regexp + + +command + + It is often desirable to change settings based on which mailbox you are -reading. The folder-hook command provides a method by which you can execute +reading. The folder-hook command provides a method by which you can execute any configuration command. regexp is a regular expression specifying in which mailboxes to execute command before loading. If a mailbox -matches multiple folder-hook's, they are executed in the order given in the -muttrc. +matches multiple folder-hooks, they are executed in the order given in the +.muttrc. + -Note: if you use the ``!'' shortcut for $spoolfile at the beginning of the pattern, you must place it +If you use the ! shortcut for $spoolfile at the beginning of the pattern, you must place it inside of double or single quotes in order to distinguish it from the logical not operator for the expression. + + -Note that the settings are not restored when you leave the mailbox. +Settings are not restored when you leave the mailbox. For example, a command action to perform is to change the sorting method based upon the mailbox being read: - - - -folder-hook mutt set sort=threads - +folder-hook mutt "set sort=threads" - - - However, the sorting method is not restored to its previous value when reading a different mailbox. To specify a default command, use the -pattern ``.'': +pattern . before other folder-hooks adjusting a value on a per-folder basis +because folder-hooks are evaluated in the order given in the +configuration file. + +The following example will set the sort variable +to date-sent for all folders but to threads +for all folders containing mutt in their name. + + +Setting sort method based on mailbox name -folder-hook . set sort=date-sent +folder-hook . "set sort=date-sent" +folder-hook mutt "set sort=threads" - - + -Keyboard macros - - -Usage: macro menu key sequence [ description ] - +Keyboard Macros + +Usage: + + +macro + +menu + + +key + + +sequence + + +description + + Macros are useful when you would like a single key to perform a series of actions. When you press key in menu menu, Mutt will behave as if you had typed sequence. So if you have a common sequence of commands you type, you can create a macro to execute those commands with a single -key. +key or fewer keys. -menu is the map which the macro will be bound. +menu is the map which the macro will be bound in. Multiple maps may be specified by separating multiple menu arguments by commas. Whitespace may not be used in between the menu arguments and the commas separating them. -key and sequence are expanded by the same rules as the key bindings. There are some additions however. The +key and sequence are expanded by the same rules as the +key bindings with some additions. The first is that control characters in sequence can also be specified -as ˆx. In order to get a caret (`ˆ'') you need to use +as ˆx. In order to get a caret (ˆ) you need to use ˆˆ. Secondly, to specify a certain key such as up or to invoke a function directly, you can use the format <key name> and <function name>. For a listing of key @@ -1981,364 +2404,317 @@ than one user (e.g., the system Muttrc). Optionally you can specify a descriptive text after sequence, -which is shown in the help screens. +which is shown in the help screens if they contain a description. + -Note: Macro definitions (if any) listed in the help screen(s), are +Macro definitions (if any) listed in the help screen(s), are silently truncated at the screen width, and are not wrapped. + -Using color and mono video attributes - - - -Usage: color object foreground background [ regexp ] -Usage: color index foreground background pattern -Usage: uncolor index pattern [ pattern ... ] - - +Using Color and Mono Video Attributes + +Usage: + + +color + +object + + +foreground + + +background + + +color + + + + + + + + + +foreground + + +background + + +regexp + + +color + + + + +foreground + + +background + + +pattern + + +uncolor + + + + + + + + + + + + + +* + + +pattern + + + If your terminal supports color, you can spice up Mutt by creating your own color scheme. To define the color of an object (type of information), you -must specify both a foreground color and a background color (it is not +must specify both a foreground color and a background color (it is not possible to only specify one or the other). -object can be one of: +header and body match regexp +in the header/body of a message, index matches pattern +(see ) in the message index. +object can be one of: + - +attachment +bold (hiliting bold patterns in the body of messages) +error (error messages printed by Mutt) +hdrdefault (default color of the message header in the pager) +indicator (arrow or bar used to indicate the current item in a menu) +markers (the + markers at the beginning of wrapped lines in the pager) +message (informational messages) +normal +quoted (text matching $quote_regexp in the body of a message) +quoted1, quoted2, ..., quotedN (higher levels of quoting) +search (hiliting of words in the pager) +signaturestatus (mode lines used to display info about the mailbox or message) +tilde (the ˜ used to pad blank lines in the pager) +tree (thread tree drawn in the message index and attachment menu) +underline (hiliting underlined patterns in the body of messages) + -attachment +foreground and background can be one of the following: - - - -body (match regexp in the body of messages) - + +white +black +green +magenta +blue +cyan +yellow +red +default +colorx - + -bold (hiliting bold patterns in the body of messages) +foreground can optionally be prefixed with the keyword bright to make +the foreground color boldfaced (e.g., brightred). - - -error (error messages printed by Mutt) +If your terminal supports it, the special keyword default can be +used as a transparent color. The value brightdefault is also valid. +If Mutt is linked against the S-Lang library, you also need to set +the $COLORFGBG environment variable to the default colors of your +terminal for this to work; for example (for Bourne-like shells): - - + +set COLORFGBG="green;black" +export COLORFGBG + + + -header (match regexp in the message header) - - - - - -hdrdefault (default color of the message header in the pager) - - - - - -index (match pattern in the message index) - - - - - -indicator (arrow or bar used to indicate the current item in a menu) - - - - - -markers (the ``+'' markers at the beginning of wrapped lines in the pager) - - - - - -message (informational messages) - - - - - -normal - - - - - -quoted (text matching $quote_regexp in the body of a message) - - - - - -quoted1, quoted2, ..., quotedN (higher levels of quoting) - - - - - -search (hiliting of words in the pager) - - - - - -signature - - - - - -status (mode lines used to display info about the mailbox or message) - - - - - -tilde (the ``˜'' used to pad blank lines in the pager) - - - - - -tree (thread tree drawn in the message index and attachment menu) - - - - - -underline (hiliting underlined patterns in the body of messages) - - - - - - - - -foreground and background can be one of the following: - - - - - - - - -white - - - - - -black - - - - - -green - - - - - -magenta - - - - - -blue - - - - - -cyan - - - - - -yellow - - - - - -red - - - - - -default - - - - - -colorx - - - - - - - - -foreground can optionally be prefixed with the keyword bright to make -the foreground color boldfaced (e.g., brightred). - - - -If your terminal supports it, the special keyword default can be -used as a transparent color. The value brightdefault is also valid. -If Mutt is linked against the S-Lang library, you also need to set -the COLORFGBG environment variable to the default colors of your -terminal for this to work; for example (for Bourne-like shells): - - - - - -set COLORFGBG="green;black" -export COLORFGBG - - - - - -Note: The S-Lang library requires you to use the lightgray +The S-Lang library requires you to use the lightgray and brown keywords instead of white and yellow when setting this variable. + + -Note: The uncolor command can be applied to the index object only. It -removes entries from the list. You must specify the same pattern -specified in the color command for it to be removed. The pattern ``*'' is -a special token which means to clear the color index list of all entries. +The uncolor command can be applied to the index, header and body objects only. It +removes entries from the list. You must specify the same pattern +specified in the color command for it to be removed. The pattern * is +a special token which means to clear the color list of all entries. + Mutt also recognizes the keywords color0, color1, …, -colorN-1 (N being the number of colors supported +colorN-1 (N being the number of colors supported by your terminal). This is useful when you remap the colors for your display (for example by changing the color associated with color2 for your xterm), since color names may then lose their normal meaning. + If your terminal does not support color, it is still possible change the video -attributes through the use of the ``mono'' command: - - - - -Usage: mono <object> <attribute> [ regexp ] -Usage: mono index attribute pattern -Usage: unmono index pattern [ pattern ... ] - +attributes through the use of the mono command. Usage: + + + +mono + +object + + +attribute + + +mono + + + + + + + + + +attribute + + +regexp + + +mono + + + + +attribute + + +pattern + + +unmono + + + + + + + + + + + + + +* + + +pattern + + + + + +For object, see the color command. attribute +can be one of the following: - -where attribute is one of the following: - - - - - - - -none - - - - - -bold - - - - - -underline - - - - - -reverse - - - +none +bold +underline +reverse +standout + - -standout - - + - + +Message Header Display - + +Selecting Headers - +Usage: - -Ignoring (weeding) unwanted message headers + +ignore + +pattern + + +pattern + - -Usage: [un]ignore pattern [ pattern ... ] - +unignore + + +* + + +pattern + + + Messages often have many header fields added by automatic processing systems, or which may not seem useful to display on the screen. This command allows -you to specify header fields which you don't normally want to see. +you to specify header fields which you don't normally want to see in the pager. You do not need to specify the full header field name. For example, -``ignore content-'' will ignore all header fields that begin with the pattern -``content-''. ``ignore *'' will ignore all headers. +ignore content- will ignore all header fields that begin with the pattern +content-. ignore * will ignore all headers. -To remove a previously added token from the list, use the ``unignore'' command. -The ``unignore'' command will make Mutt display headers with the given pattern. -For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''. +To remove a previously added token from the list, use the unignore command. +The unignore command will make Mutt display headers with the given pattern. +For example, if you do ignore x- it is possible to unignore x-mailer. -``unignore *'' will remove all tokens from the ignore list. +unignore * will remove all tokens from the ignore list. - -For example: - + +Header weeding # Sven's draconian header weeding ignore * @@ -2346,33 +2722,102 @@ unignore from date subject to cc unignore organization organisation x-mailer: x-newsreader: x-mailing-list: unignore posted-to: + - + - + +Ordering Displayed Headers - -Alternative addresses +Usage: - -Usage: [un]alternates [ -group name [ ... ] ] regexp [ regexp ... ] + +hdr_order + +header + + +header + +unhdr_order + + +* + + +header + + + + + +With the hdr_order command you can specify an order in +which Mutt will attempt to present these headers to you when viewing messages. -With various functions, mutt will treat messages differently, +unhdr_order * will clear all previous headers from the order list, +thus removing the header order effects set by the system-wide startup file. + + + +Configuring header display order + +hdr_order From Date: From: To: Cc: Subject: + + + + + + + +Alternative Addresses + +Usage: + + +alternates + + +name + + +regexp + + +regexp + + +unalternates + + +name + + + +* + + +regexp + + + + + +With various functions, Mutt will treat messages differently, depending on whether you sent them or whether you received them from someone else. For instance, when replying to a message that you -sent to a different party, mutt will automatically suggest to send -the response to the original message's recipients -- responding to +sent to a different party, Mutt will automatically suggest to send +the response to the original message's recipients — responding to yourself won't make much sense in many cases. (See $reply_to.) Many users receive e-mail under a number of different addresses. To -fully use mutt's features here, the program must be able to +fully use Mutt's features here, the program must be able to recognize what e-mail addresses you receive mail under. That's the -purpose of the alternates command: It takes a list of regular +purpose of the alternates command: It takes a list of regular expressions, each of which can identify an address under which you receive e-mail. @@ -2388,7 +2833,7 @@ alternates user@example -mutt will consider ``some-user@example'' as +Mutt will consider some-user@example as being your address, too which may not be desired. As a solution, in such cases addresses should be specified as: @@ -2403,73 +2848,143 @@ to be added to the named group. -The unalternates command can be used to write exceptions to -alternates patterns. If an address matches something in an -alternates command, but you nonetheless do not think it is -from you, you can list a more precise pattern under an unalternates +The unalternates command can be used to write exceptions to +alternates patterns. If an address matches something in an +alternates command, but you nonetheless do not think it is +from you, you can list a more precise pattern under an unalternates command. -To remove a regular expression from the alternates list, use the -unalternates command with exactly the same regexp. -Likewise, if the regexp for an alternates command matches -an entry on the unalternates list, that unalternates -entry will be removed. If the regexp for unalternates -is ``*'', all entries on alternates will be removed. +To remove a regular expression from the alternates list, use the +unalternates command with exactly the same regexp. +Likewise, if the regexp for an alternates command matches +an entry on the unalternates list, that unalternates +entry will be removed. If the regexp for unalternates +is *, all entries on alternates will be removed. -Mailing lists +Mailing Lists - - -Usage: [un]lists [ -group name [ ... ] ] regexp [ regexp ... ] -Usage: [un]subscribe [ -group name [ ... ] ] regexp [ regexp ... ] - - + +Usage: + + +lists + + +name + + +regexp + + +regexp + + +unlists + + +name + + + +* + + +regexp + + + +subscribe + + +name + + +regexp + + +regexp + + +unsubscribe + + +name + + + +* + + +regexp + + + Mutt has a few nice features for handling mailing lists. In order to take advantage of them, you must specify which addresses belong to mailing lists, and which mailing -lists you are subscribed to. Once you have done this, the list-reply function will work for all known lists. -Additionally, when you send a message to a subscribed list, mutt will +lists you are subscribed to. Mutt also has limited support for +auto-detecting mailing lists: it supports parsing +mailto: links in the common +List-Post: header which has the same effect as +specifying the list address via the lists command +(except the group feature). Once you have done this, the +<list-reply> +function will work for all known lists. +Additionally, when you send a message to a subscribed list, Mutt will add a Mail-Followup-To header to tell other users' mail user agents -not to send copies of replies to your personal address. Note that -the Mail-Followup-To header is a non-standard extension which is not +not to send copies of replies to your personal address. + + + + +The Mail-Followup-To header is a non-standard extension which is not supported by all mail user agents. Adding it is not bullet-proof against receiving personal CCs of list messages. Also note that the generation -of the Mail-Followup-To header is controlled by the $followup_to configuration variable. +of the Mail-Followup-To header is controlled by the +$followup_to +configuration variable since it's common practice on some mailing lists +to send Cc upons replies (which is more a group- than a list-reply). + More precisely, Mutt maintains lists of patterns for the addresses of known and subscribed mailing lists. Every subscribed mailing -list is known. To mark a mailing list as known, use the ``lists'' -command. To mark it as subscribed, use ``subscribe''. +list is known. To mark a mailing list as known, use the list +command. To mark it as subscribed, use subscribe. -You can use regular expressions with both commands. To mark all -messages sent to a specific bug report's address on mutt's bug +You can use regular expressions with both commands. To mark all +messages sent to a specific bug report's address on Debian's bug tracking system as list mail, for instance, you could say -``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just -give a portion of the list's e-mail address. + + + +subscribe [0-9]*.*@bugs.debian.org + + +as it's often, it's sufficient to just give a portion of the list's e-mail address. Specify as much of the address as you need to to remove ambiguity. For example, if you've subscribed to the Mutt mailing list, you will receive mail -addressed to mutt-users@mutt.org. So, to tell Mutt -that this is a mailing list, you could add ``lists mutt-users@'' to your -initialization file. To tell mutt that you are subscribed to it, -add ``subscribe mutt-users'' to your initialization file instead. +addressed to mutt-users@mutt.org. So, to tell Mutt +that this is a mailing list, you could add lists mutt-users@ to your +initialization file. To tell Mutt that you are subscribed to it, +add subscribe mutt-users to your initialization file instead. If you also happen to get mail from someone whose address is -mutt-users@example.com, you could use -``lists ^mutt-users@mutt\\.org$'' -or ``subscribe ^mutt-users@mutt\\.org$'' to +mutt-users@example.com, you could use +lists ^mutt-users@mutt\\.org$ +or subscribe ^mutt-users@mutt\\.org$ to match only mail from the actual list. @@ -2479,30 +2994,38 @@ to the named group. -The ``unlists'' command is used to remove a token from the list of -known and subscribed mailing-lists. Use ``unlists *'' to remove all +The unlists command is used to remove a token from the list of +known and subscribed mailing-lists. Use unlists * to remove all tokens. To remove a mailing list from the list of subscribed mailing lists, -but keep it on the list of known mailing lists, use ``unsubscribe''. +but keep it on the list of known mailing lists, use unsubscribe. -Using Multiple spool mailboxes +Using Multiple Spool Mailboxes - -Usage: mbox-hook [!]pattern mailbox - +Usage: + + +mbox-hook + +[!]pattern + + +mailbox + + This command is used to move read messages from a specified mailbox to a different mailbox automatically when you quit or change folders. pattern is a regular expression specifying the mailbox to treat as a -``spool'' mailbox and mailbox specifies where mail should be saved when +spool mailbox and mailbox specifies where mail should be saved when read. @@ -2515,167 +3038,173 @@ mailbox). -Monitoring incoming mail - - -Usage: [un]mailboxes folder [ folder ... ] - +Monitoring Incoming Mail + +Usage: + + +mailboxes + +mailbox + + +mailbox + + +unmailboxes + + +* + + +mailbox + + + This command specifies folders which can receive mail and -which will be checked for new messages. By default, the -main menu status bar displays how many of these folders have -new messages. +which will be checked for new messages periodically. -folder can either be a local file or directory +folder can either be a local file or directory (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP -support, folder can also be a POP/IMAP folder +support, folder can also be a POP/IMAP folder URL. The URL syntax is described in , POP and IMAP are described in and respectively. -When changing folders, pressing space will cycle -through folders with new mail. - - - -Pressing TAB in the directory browser will bring up a menu showing the files -specified by the mailboxes command, and indicate which contain new -messages. Mutt will automatically enter this mode when invoked from the -command line with the -y option. +Mutt provides a number of advanced features for handling (possibly many) +folders and new mail within them, please refer to + for details (including in what +situations and how often Mutt checks for new mail). -The ``unmailboxes'' command is used to remove a token from the list -of folders which receive mail. Use ``unmailboxes *'' to remove all +The unmailboxes command is used to remove a token from the list +of folders which receive mail. Use unmailboxes * to remove all tokens. + -Note: the folders in the mailboxes command are resolved when -the command is executed, so if these names contain shortcut characters (such as ``='' and ``!''), any variable -definition that affect these characters (like $folder and $spoolfile) -should be executed before the mailboxes command. If +The folders in the mailboxes command are resolved when +the command is executed, so if these names contain shortcut characters (such as = and !), any variable +definition that affects these characters (like $folder and $spoolfile) +should be set before the mailboxes command. If none of these shorcuts are used, a local path should be absolute as -otherwise mutt tries to find it within the current working directory -from where mutt was started which may not always be desired. +otherwise Mutt tries to find it relative to the directory +from where Mutt was started which may not always be desired. + -For local folders, new mail is detected by comparing access and/or -modification times of files and folders. The interval in which Mutt -checks for new mail is defined by -$mail_check. - - - -Special care is required with Mbox and Mmdf -folders as Mutt assumes such a folder has new mail if it wasn't +For Mbox and Mmdf folders, new mail is detected by comparing access and/or +modification times of files: Mutt assumes a folder has new mail if it wasn't accessed after it was last modified. Utilities like biff or frm or any other program which accesses the mailbox might cause Mutt to never detect new mail for that mailbox if they do not properly reset the -access time. Backup tools are another common reason for updated access times. +access time. Other possible causes of Mutt not detecting new mail in these folders +are backup tools (updating access times) or filesystems mounted without +access time update support. + + + +In cases where new mail detection for Mbox or Mmdf folders appears to be +unreliable, the +$check_mbox_size +option can be used to make Mutt track and consult file sizes for new +mail detection instead which won't work for size-neutral changes. -User defined headers - - -Usage: +User-Defined Headers -my_hdr string +Usage: -unmy_hdr field [ field ... ] - + +my_hdr + +string + - -The ``my_hdr'' command allows you to create your own header -fields which will be added to every message you send. - +unmy_hdr + + +* + + +field + + + -For example, if you would like to add an ``Organization:'' header field to -all of your outgoing messages, you can put the command +The my_hdr command allows you to create your own header +fields which will be added to every message you send and appear in the +editor if $edit_headers is set. -my_hdr Organization: A Really Big Company, Anytown, USA +For example, if you would like to add an Organization: header field to +all of your outgoing messages, you can put the command something like +shown in in your .muttrc. - -in your .muttrc. - + +Defining custom headers + +my_hdr Organization: A Really Big Company, Anytown, USA + + + -Note: space characters are not allowed between the keyword and -the colon (``:''). The standard for electronic mail (RFC822) says that +Space characters are not allowed between the keyword and +the colon (:). The standard for electronic mail (RFC2822) says that space is illegal there, so Mutt enforces the rule. + If you would like to add a header field to a single message, you should either set the $edit_headers variable, -or use the edit-headers function (default: ``E'') in the send-menu so +or use the <edit-headers> function (default: E) in the compose menu so that you can edit the header of your message along with the body. -To remove user defined header fields, use the ``unmy_hdr'' -command. You may specify an asterisk (``*'') to remove all header -fields, or the fields to remove. For example, to remove all ``To'' and -``Cc'' header fields, you could use: +To remove user defined header fields, use the unmy_hdr +command. You may specify an asterisk (*) to remove all header +fields, or the fields to remove. For example, to remove all To and +Cc header fields, you could use: - -unmy_hdr to cc - - - - - -Defining the order of headers when viewing messages - - -Usage: hdr_order header1 header2 header3 - - - -With this command, you can specify an order in which mutt will attempt -to present headers to you when viewing messages. - - - -``unhdr_order *'' will clear all previous headers from the order list, -thus removing the header order effects set by the system-wide startup -file. - - - - -hdr_order From Date: From: To: Cc: Subject: +unmy_hdr to cc - - -Specify default save mailbox +Specify Default Save Mailbox - -Usage: save-hook [!]pattern mailbox - +Usage: + + +save-hook + +[!]pattern + + +mailbox + + This command is used to override the default mailbox used when saving @@ -2690,35 +3219,40 @@ expandos of $index_format to mailbox after it was expanded. - -Examples: - - - - + +Using %-expandos in <command>save-hook</command> # default: save all to ~/Mail/<author name> save-hook . ~/Mail/%F -# save from me@turing.cs.hmc.edu/me@cs.hmc.edu to $folder/elinks + +# save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins + # save from aol.com to $folder/spam save-hook aol\\.com$ +spam - - + -Also see the fcc-save-hook command. +Also see the fcc-save-hook command. -Specify default Fcc: mailbox when composing +Specify Default Fcc: Mailbox When Composing - -Usage: fcc-hook [!]pattern mailbox - +Usage: + + +fcc-hook + +[!]pattern + + +mailbox + + This command is used to save outgoing mail in a mailbox other than @@ -2738,27 +3272,33 @@ expandos of $index_format to See for information on the exact format of pattern. - -Example: fcc-hook [@.]aol\\.com$ +spammers - +fcc-hook [@.]aol\\.com$ +spammers -The above will save a copy of all messages going to the aol.com domain to -the `+spammers' mailbox by default. Also see the fcc-save-hook command. +...will save a copy of all messages going to the aol.com domain to +the `+spammers' mailbox by default. Also see the fcc-save-hook command. -Specify default save filename and default Fcc: mailbox at once +Specify Default Save Filename and Default Fcc: Mailbox at Once - -Usage: fcc-save-hook [!]pattern mailbox - +Usage: + + +fcc-save-hook + +[!]pattern + + +mailbox + + -This command is a shortcut, equivalent to doing both a fcc-hook -and a save-hook with its arguments, +This command is a shortcut, equivalent to doing both a fcc-hook +and a save-hook with its arguments, including %-expansion on mailbox according to $index_format. @@ -2766,51 +3306,76 @@ to $index_format. -Change settings based upon message recipients +Change Settings Based Upon Message Recipients + + + + +Usage: + + +reply-hook + +[!]pattern + + +command + + +send-hook + +[!]pattern + + +command + + +send2-hook + +[!]pattern + + +command + + - -Usage: reply-hook [!]pattern command -Usage: send-hook [!]pattern command -Usage: send2-hook [!]pattern command - +These commands can be used to execute arbitrary configuration commands based +upon recipients of the message. pattern is used to match +the message, see for details. command +is executed when pattern matches. -These commands can be used to execute arbitrary configuration commands based -upon recipients of the message. pattern is a regular expression -matching the desired address. command is executed when regexp -matches recipients of the message. +reply-hook is matched against the message you are replying to, +instead of the message you are sending. send-hook is +matched against all messages, both new +and replies. + -reply-hook is matched against the message you are replying -to, instead of the message you are sending. send-hook is -matched against all messages, both new and replies. Note: -reply-hooks are matched before the send-hook, regardless +reply-hooks are matched before the send-hook, regardless of the order specified in the user's configuration file. + -send2-hook is matched every time a message is changed, either +send2-hook is matched every time a message is changed, either by editing it, or by using the compose menu to change its recipients -or subject. send2-hook is executed after send-hook, and +or subject. send2-hook is executed after send-hook, and can, e.g., be used to set parameters such as the $sendmail variable depending on the message's sender address. -For each type of send-hook or reply-hook, when multiple matches -occur, commands are executed in the order they are specified in the muttrc +For each type of send-hook or reply-hook, when multiple matches +occur, commands are executed in the order they are specified in the .muttrc (for that type of hook). -See for information on the exact format of pattern. - - - -Example: send-hook mutt "set mime_forward signature=''" +Example: send-hook mutt "set mime_forward signature=''" @@ -2820,30 +3385,43 @@ variables in order to change the language of the attributions and signatures based upon the recipients. + -Note: the send-hook's are only executed ONCE after getting the initial -list of recipients. Adding a recipient after replying or editing the -message will NOT cause any send-hook to be executed. Also note that -my_hdr commands which modify recipient headers, or the message's -subject, don't have any effect on the current message when executed -from a send-hook. +send-hook's are only executed once after getting the +initial list of recipients. Adding a recipient after replying or +editing the message will not cause any send-hook to be executed, +similarily if $autoedit is set +(as then the initial list of recipients is empty). Also note that my_hdr commands which +modify recipient headers, or the message's subject, don't have any +effect on the current message when executed from a +send-hook. + -Change settings before formatting a message +Change Settings Before Formatting a Message - -Usage: message-hook [!]pattern command - +Usage: + + +message-hook + +[!]pattern + + +command + + This command can be used to execute arbitrary configuration commands before viewing or formatting a message based upon information about the message. command is executed if the pattern matches the message to be displayed. When multiple matches occur, commands are executed in the order -they are specified in the muttrc. +they are specified in the .muttrc. @@ -2853,35 +3431,42 @@ information on the exact format of pattern. Example: + message-hook ~A 'set pager=builtin' message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' - - -Choosing the cryptographic key of the recipient +Choosing the Cryptographic Key of the Recipient - -Usage: crypt-hook pattern keyid - +Usage: + + +crypt-hook + +pattern + + +keyid + + -When encrypting messages with PGP or OpenSSL, you may want to associate a certain +When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a certain key with a given e-mail address automatically, either because the recipient's public key can't be deduced from the destination address, or because, for some reasons, you need to override the key Mutt would -normally use. The crypt-hook command provides a method by which you can -specify the ID of the public key to be used when encrypting messages to -a certain recipient. +normally use. The crypt-hook command provides a +method by which you can specify the ID of the public key to be used +when encrypting messages to a certain recipient. -The meaning of "key id" is to be taken broadly in this context: You +The meaning of keyid is to be taken broadly in this context: You can either put a numerical key ID here, an e-mail address, or even just a real name. @@ -2889,38 +3474,55 @@ just a real name. -Adding key sequences to the keyboard buffer +Adding Key Sequences to the Keyboard Buffer - -Usage: push string - +Usage: + + +push + +string + + This command adds the named string to the keyboard buffer. The string may contain control characters, key names and function names like the sequence string in the macro command. You may use it to automatically run a sequence of commands at startup, or when entering -certain folders. For example, the following command will automatically -collapse all threads when entering a folder: +certain folders. For example, +shows how to automatically collapse all threads when entering a folder. + + +Embedding <command>push</command> in <command>folder-hook</command> folder-hook . 'push <collapse-all>' - + -Executing functions +Executing Functions - -Usage: exec function [ function ... ] - +Usage: + + +exec + +function + + +function + + This command can be used to execute any function. Functions are listed in the function reference. -``exec function'' is equivalent to ``push <function>''. +execfunction is equivalent to +push <function>. @@ -2928,46 +3530,76 @@ listed in the function reference. Message Scoring - - -Usage: score pattern value -Usage: unscore pattern [ pattern ... ] - - - - -The score commands adds value to a message's score if pattern +Usage: + + +score + +pattern + + +value + + +unscore + + +* + + +pattern + + + + + +The score commands adds value to a message's score if pattern matches it. pattern is a string in the format described in the patterns section (note: For efficiency reasons, patterns which scan information not available in the index, such as ˜b, ˜B or ˜h, may not be used). value is a positive or negative integer. A message's final score is the sum total of all -matching score entries. However, you may optionally prefix value with -an equal sign (=) to cause evaluation to stop at a particular entry if there is +matching score entries. However, you may optionally prefix value with +an equal sign (=) to cause evaluation to stop at a particular entry if there is a match. Negative final scores are rounded up to 0. -The unscore command removes score entries from the list. You must -specify the same pattern specified in the score command for it to be -removed. The pattern ``*'' is a special token which means to clear the list +The unscore command removes score entries from the list. You must +specify the same pattern specified in the score command for it to be +removed. The pattern * is a special token which means to clear the list of all score entries. -Spam detection - - - -Usage: spam pattern format -Usage: nospam pattern - - +Spam Detection + +Usage: + + +spam + +pattern + + +format + + +nospam + + +* + + +pattern + + + Mutt has generalized support for external spam-scoring filters. -By defining your spam patterns with the spam and nospam +By defining your spam patterns with the spam and nospam commands, you can limit, search, and sort your mail based on its spam attributes, as determined by the external filter. You also can display the spam attributes in your index @@ -2977,241 +3609,373 @@ to display spam tags only when they are defined for a given message.) Your first step is to define your external filter's spam patterns using -the spam command. pattern should be a regular expression +the spam command. pattern should be a regular expression that matches a header in a mail message. If any message in the mailbox -matches this regular expression, it will receive a ``spam tag'' or -``spam attribute'' (unless it also matches a nospam pattern -- see +matches this regular expression, it will receive a spam tag or +spam attribute (unless it also matches a nospam pattern — see below.) The appearance of this attribute is entirely up to you, and is governed by the format parameter. format can be any static text, but it also can include back-references from the pattern -expression. (A regular expression ``back-reference'' refers to a +expression. (A regular expression back-reference refers to a sub-expression contained within parentheses.) %1 is replaced with the first back-reference in the regex, %2 with the second, etc. + +To match spam tags, mutt needs the corresponding header information +which is always the case for local and POP folders but not for IMAP in +the default configuration. Depending on the spam header to be analyzed, +$imap_headers may need +to be adjusted. + + If you're using multiple spam filters, a message can have more than -one spam-related header. You can define spam patterns for each +one spam-related header. You can define spam patterns for each filter you use. If a message matches two or more of these patterns, and -the $spam_separator variable is set to a string, then the +the $spam_separator variable is set to a string, then the message's spam tag will consist of all the format strings joined -together, with the value of $spam_separator separating +together, with the value of $spam_separator separating them. -For example, suppose I use DCC, SpamAssassin, and PureMessage. I might -define these spam settings: +For example, suppose one uses DCC, SpamAssassin, and PureMessage, then +the configuration might look like in . + + +Configuring spam detection spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1" spam "X-Spam-Status: Yes" "90+/SA" spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM" set spam_separator=", " - - + -If I then received a message that DCC registered with ``many'' hits -under the ``Fuz2'' checksum, and that PureMessage registered with a +If then a message is received that DCC registered with many hits +under the Fuz2 checksum, and that PureMessage registered with a 97% probability of being spam, that message's spam tag would read -90+/DCC-Fuz2, 97/PM. (The four characters before ``=many'' in a -DCC report indicate the checksum used -- in this case, ``Fuz2''.) +90+/DCC-Fuz2, 97/PM. (The four characters before =many in a +DCC report indicate the checksum used — in this case, Fuz2.) -If the $spam_separator variable is unset, then each +If the $spam_separator variable is unset, then each spam pattern match supersedes the previous one. Instead of getting joined format strings, you'll get only the last one to match. The spam tag is what will be displayed in the index when you use -%H in the $index_format variable. It's also the +%H in the $index_format variable. It's also the string that the ˜H pattern-matching expression matches against for -search and limit functions. And it's what sorting by spam +<search> and <limit> functions. And it's what sorting by spam attribute will use as a sort key. That's a pretty complicated example, and most people's actual environments will have only one spam filter. The simpler your -configuration, the more effective mutt can be, especially when it comes +configuration, the more effective Mutt can be, especially when it comes to sorting. -Generally, when you sort by spam tag, mutt will sort lexically -- +Generally, when you sort by spam tag, Mutt will sort lexically — that is, by ordering strings alphanumerically. However, if a spam tag -begins with a number, mutt will sort numerically first, and lexically +begins with a number, Mutt will sort numerically first, and lexically only when two numbers are equal in value. (This is like UNIX's -sort -n.) A message with no spam attributes at all -- that is, one -that didn't match any of your spam patterns -- is sorted at +sort -n.) A message with no spam attributes at all — that is, one +that didn't match any of your spam patterns — is sorted at lowest priority. Numbers are sorted next, beginning with 0 and ranging -upward. Finally, non-numeric strings are sorted, with ``a'' taking lower -priority than ``z''. Clearly, in general, sorting by spam tags is most +upward. Finally, non-numeric strings are sorted, with a taking lower +priority than z. Clearly, in general, sorting by spam tags is most effective when you can coerce your filter to give you a raw number. But -in case you can't, mutt can still do something useful. +in case you can't, Mutt can still do something useful. -The nospam command can be used to write exceptions to spam -patterns. If a header pattern matches something in a spam command, +The nospam command can be used to write exceptions to spam +patterns. If a header pattern matches something in a spam command, but you nonetheless do not want it to receive a spam tag, you can list a -more precise pattern under a nospam command. +more precise pattern under a nospam command. -If the pattern given to nospam is exactly the same as the -pattern on an existing spam list entry, the effect will be to +If the pattern given to nospam is exactly the same as the +pattern on an existing spam list entry, the effect will be to remove the entry from the spam list, instead of adding an exception. -Likewise, if the pattern for a spam command matches an entry -on the nospam list, that nospam entry will be removed. If the -pattern for nospam is ``*'', all entries on both lists -will be removed. This might be the default action if you use spam -and nospam in conjunction with a folder-hook. +Likewise, if the pattern for a spam command matches an entry +on the nospam list, that nospam entry will be removed. If the +pattern for nospam is *, all entries on both lists +will be removed. This might be the default action if you use spam +and nospam in conjunction with a folder-hook. -You can have as many spam or nospam commands as you like. -You can even do your own primitive spam detection within mutt -- for +You can have as many spam or nospam commands as you like. +You can even do your own primitive spam detection within Mutt — for example, if you consider all mail from MAILER-DAEMON to be spam, -you can use a spam command like this: +you can use a spam command like this: - - spam "^From: .*MAILER-DAEMON" "999" - - Setting and Querying Variables - -Commands + +Variable Types -The following commands are available to manipulate and query variables: +Mutt supports these types of configuration variables: + + +boolean + - -Usage: set [no|inv]variable[=value] [ variable ... ] -Usage: toggle variable [variable ... ] -Usage: unset variable [variable ... ] -Usage: reset variable [variable ... ] - +A boolean expression, either yes or no. - + + + +number + -This command is used to set (and unset) configuration variables. There are four basic types of variables: -boolean, number, string and quadoption. boolean variables can be -set (true) or unset (false). number variables can be -assigned a positive integer value. +A signed integer number in the range -32768 to 32767. + + + + +string + + +Arbitrary text. + + + + +path + + +A specialized string for representing paths including support for +mailbox shortcuts (see ) as well as tilde +(˜) for a user's home directory and more. + + + + +quadoption + + +Like a boolean but triggers a prompt when set to ask-yes +or ask-no with yes and no +preselected respectively. + + + + +sort order + + +A specialized string allowing only particular words as values depending +on the variable. + + + + +regular expression + + +A regular expression, see for an introduction. + + + + +folder magic + + +Specifies the type of folder to use: mbox, +mmdf, mh +or maildir. +Currently only used to determine the type for newly created folders. + + + + +e-mail address + + +An e-mail address either with or without +realname. The older user@example.org (Joe User) +form is supported but strongly deprecated. + + + + +user-defined + + +Arbitrary text, see for details. + + + + + + + +Commands -string variables consist of any number of printable characters. -strings must be enclosed in quotes if they contain spaces or tabs. You -may also use the ``C'' escape sequences \n and \t for -newline and tab, respectively. +The following commands are available to manipulate and query variables: +Usage: + + +set + + + + + + +variable + + +variable=value + + + + +toggle + +variable + + +variable + + +unset + +variable + + +variable + + +reset + +variable + + +variable + + + +This command is used to set (and unset) configuration variables. There are four basic types of variables: +boolean, number, string and quadoption. boolean variables can be +set (true) or unset (false). number variables can be +assigned a positive integer value. +string variables consist of any number of printable characters and +must be enclosed in quotes if they contain spaces or tabs. You +may also use the escape sequences \n and \t for newline and tab, respectively. quadoption variables are used to control whether or not to be prompted for certain actions, or to specify a default action. A value of yes will cause the action to be carried out automatically as if you had answered yes to the question. Similarly, a value of no will cause the -action to be carried out as if you had answered ``no.'' A value of -ask-yes will cause a prompt with a default answer of ``yes'' and -ask-no will provide a default answer of ``no.'' +action to be carried out as if you had answered no. A value of +ask-yes will cause a prompt with a default answer of yes and +ask-no will provide a default answer of no. -Prefixing a variable with ``no'' will unset it. Example: set noaskbcc. +Prefixing a variable with no will unset it. Example: set noaskbcc. For boolean variables, you may optionally prefix the variable name with inv to toggle the value (on or off). This is useful when writing -macros. Example: set invsmart_wrap. +macros. Example: set invsmart_wrap. -The toggle command automatically prepends the inv prefix to all +The toggle command automatically prepends the inv prefix to all specified variables. -The unset command automatically prepends the no prefix to all +The unset command automatically prepends the no prefix to all specified variables. -Using the enter-command function in the index menu, you can query the +Using the <enter-command> function in the index menu, you can query the value of a variable by prefixing the name of the variable with a question mark: - - set ?allow_8bit - - -The question mark is actually only required for boolean and quadoption +The question mark is actually only required for boolean and quadoption variables. -The reset command resets all given variables to the compile time +The reset command resets all given variables to the compile time defaults (hopefully mentioned in this manual). If you use the command -set and prefix the variable with ``&'' this has the same -behavior as the reset command. +set and prefix the variable with & this has the same +behavior as the reset command. -With the reset command there exists the special variable ``all'', +With the reset command there exists the special variable all, which allows you to reset all variables to their system defaults. -User-defined variables +User-Defined Variables Introduction Along with the variables listed in the -Configuration variables section, mutt +Configuration variables section, Mutt supports user-defined variables with names starting with my_ as in, for example, my_cfgdir. -The set command creates a -custom $my_ variable and changes its -value. The unset and reset +The set command either creates a +custom my_ variable or changes its +value if it does exist already. The unset and reset commands remove the variable entirely. Since user-defined variables are expanded in the same way that environment variables are (except for -the shell-escape command), this -feature can be used to make configuration files more readable. +the shell-escape command and +backtick expansion), this feature can be used to make configuration +files more readable. @@ -3220,11 +3984,12 @@ feature can be used to make configuration files more readable. Examples -The following example defines and uses the variable my_cfgdir -to abbreviate the calls of the source command: +The following example defines and uses the variable my_cfgdir +to abbreviate the calls of the source command: - + +Using user-defined variables for config file readability set my_cfgdir = $HOME/mutt/config @@ -3232,18 +3997,19 @@ source $my_cfgdir/hooks source $my_cfgdir/macros # more source commands... - + A custom variable can also be used in macros to backup the current value -of another variable. In the following example, the value of the +of another variable. In the following example, the value of the $delete is changed temporarily while its original value is saved as my_delete. After the macro has executed all commands, the original value of $delete is restored. - + +Using user-defined variables for backing up other config option values macro pager ,x '\ <enter-command>set my_delete=$delete<enter>\ @@ -3251,21 +4017,22 @@ macro pager ,x '\ ...\ <enter-command>set delete=$my_delete<enter>' - + -Since mutt expands such values already when parsing the configuration +Since Mutt expands such values already when parsing the configuration file(s), the value of $my_delete in the -last example would be the value of $delete exactly +last example would be the value of $delete exactly as it was at that point during parsing the configuration file. If -another statement would change the value for $delete +another statement would change the value for $delete later in the same or another file, it would have no effect on $my_delete. However, the expansion can be deferred to runtime, as shown in the next example, when escaping the dollar sign. - + +Deferring user-defined variable expansion to runtime macro pager <PageDown> "\ <enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\ @@ -3273,13 +4040,13 @@ macro pager <PageDown> "\ <enter-command> set pager_stop=\$my_old_pager_stop<Enter>\ <enter-command> unset my_old_pager_stop<Enter>" - + Note that there is a space between <enter-command> and -the set configuration command, preventing mutt from -recording the macro's commands into its history. +the set configuration command, preventing Mutt from +recording the macro's commands into its history. @@ -3289,11 +4056,16 @@ recording the macro's commands into its history. -Reading initialization commands from another file +Reading Initialization Commands From Another File - -Usage: source filename - +Usage: + + +source + +filename + + This command allows the inclusion of initialization commands @@ -3303,30 +4075,40 @@ from other files. For example, I place all of my aliases in -If the filename begins with a tilde (``˜''), it will be expanded to the +If the filename begins with a tilde (˜), it will be expanded to the path of your home directory. -If the filename ends with a vertical bar (|), then filename is +If the filename ends with a vertical bar (|), then filename is considered to be an executable program from which to read input (eg. -source ˜/bin/myscript|). +source ˜/bin/myscript|). -Removing hooks +Removing Hooks - -Usage: unhook [ * | hook-type ] - +Usage: + + +unhook + + +* + + +hook-type + + + This command permits you to flush hooks you have previously defined. -You can either remove all hooks by giving the ``*'' character as an +You can either remove all hooks by giving the * character as an argument, or you can remove all hooks of a specific type by saying -something like unhook send-hook. +something like unhook send-hook. @@ -3334,16 +4116,16 @@ something like unhook send-hook. Format Strings - + Basic usage Format strings are a general concept you'll find in several locations -through the mutt configuration, especially in the -$index_format", -$pager_format", -$status_format", -and other ``*_format'' variables. These can be very straightforward, +through the Mutt configuration, especially in the +$index_format, +$pager_format, +$status_format, +and other related variables. These can be very straightforward, and it's quite possible you already know how to use them. @@ -3351,31 +4133,28 @@ and it's quite possible you already know how to use them. The most basic format string element is a percent symbol followed by another character. For example, %s represents a message's Subject: header in the $index_format" variable. The -``expandos'' available are documented with each format variable, but +linkend="index-format">$index_format variable. The +expandos available are documented with each format variable, but there are general modifiers available with all formatting expandos, too. Those are our concern here. -Some of the modifers are borrowed right out of C (though you might -know them from Perl, Python, shell, or another langugage). These are -the [-]m.n modifiers, as in %-12.12s. As with +Some of the modifiers are borrowed right out of C (though you might +know them from Perl, Python, shell, or another language). These are +the [-]m.n modifiers, as in %-12.12s. As with such programming languages, these modifiers allow you to specify the -minumum and maximum size of the resulting string, as well as its -justification. If the ``-'' sign follows the percent, the string will +minimum and maximum size of the resulting string, as well as its +justification. If the - sign follows the percent, the string will be left-justified instead of right-justified. If there's a number immediately following that, it's the minimum amount of space the -formatted string will occupy -- if it's naturally smaller than that, it +formatted string will occupy — if it's naturally smaller than that, it will be padded out with spaces. If a decimal point and another number -follow, that's the maximum space allowable -- the string will not be +follow, that's the maximum space allowable — the string will not be permitted to exceed that width, no matter its natural size. Each of these three elements is optional, so that all these are legal format -strings: -%-12s -%4c -%.15F -%-12.15L +strings: %-12s, %4c, +%.15F and %-12.15L. @@ -3383,28 +4162,76 @@ Mutt adds some other modifiers to format strings. If you use an equals symbol (=) as a numeric prefix (like the minus above), it will force the string to be centered within its minimum space range. For example, %=14y will reserve 14 -characters for the %y expansion -- that's the X-Label: header, in -$index_format. If the expansion +characters for the %y expansion — that's the X-Label: header, in +$index_format. If the expansion results in a string less than 14 characters, it will be centered in a -14-character space. If the X-Label for a message were "test", that -expansion would look like `` test ''. +14-character space. If the X-Label for a message were test, that +expansion would look like      test     . There are two very little-known modifiers that affect the way that an -expando is replaced. If there is an underline (``_'') character +expando is replaced. If there is an underline (_) character between any format modifiers (as above) and the expando letter, it will -expands in all lower case. And if you use a colon (``:''), it will +expands in all lower case. And if you use a colon (:), it will replace all decimal points with underlines. - + +Conditionals + + +Depending on the format string variable, some of its sequences can be +used to optionally print a string if their value is nonzero. For +example, you may only want to see the number of flagged messages if such +messages exist, since zero is not particularly meaningful. To optionally +print a string based upon one of the above sequences, the following +construct is used: + + + +%?<sequence_char>?<optional_string>? + + +where sequence_char is an expando, and +optional_string is the string you would like printed if +sequence_char is nonzero. +optional_string may contain other +sequences as well as normal text, but you may not nest optional +strings. + + + +Here is an example illustrating how to optionally print the number of +new messages in a mailbox in +$status_format: + + + +%?n?%n new messages.? + + +You can also switch between two strings using the following construct: + + + +%?<sequence_char>?<if_string>&<else_string>? + + +If the value of sequence_char is +non-zero, if_string will be expanded, +otherwise else_string will be expanded. + + + + + Filters -Any format string ending in a vertical bar (``|'') will be +Any format string ending in a vertical bar (|) will be expanded and piped through the first word in the string, using spaces as separator. The string returned will be used for display. If the returned string ends in %, it will be passed through @@ -3417,12 +4244,15 @@ All % expandos in a format string are expanded before the script is called so that: + +Using external filters in format strings set status_format="script.sh '%r %f (%L)'|" + -will make mutt expand %r, +will make Mutt expand %r, %f and %L before calling the script. The example also shows that arguments can be quoted: the script will receive the expanded string between the single quotes @@ -3432,13 +4262,77 @@ as the only argument. A practical example is the mutt_xtitle script installed in the samples -subdirectory of the mutt documentation: it can be used as filter for -$status_format to set the current +subdirectory of the Mutt documentation: it can be used as filter for +$status_format to set the current terminal's title, if supported. + +Padding + + +In most format strings, Mutt supports different types of padding using +special %-expandos: + + + + +%|X + + +When this occurs, Mutt will fill the rest of the +line with the character X. For +example, filling the rest of the line with dashes is +done by setting: + + +set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-" + + + + +%>X + + + +Since the previous expando stops at the end of line, there must be a way +to fill the gap between two items via the %>X +expando: it puts as many characters X in between two +items so that the rest of the line will be right-justified. For example, +to not put the version string and hostname the above example on the left +but on the right and fill the gap with spaces, one might use (note the +space after %>): + + +set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)" + + + +%*X + + + +Normal right-justification will print everything to the left of the +%>, displaying padding and whatever lies to the +right only if there's room. By contrast, soft-fill gives +priority to the right-hand side, guaranteeing space to display it and +showing padding only if there's still room. If necessary, soft-fill will +eat text leftwards to make room for rightward text. For example, to +right-justify the subject making sure as much as possible of it fits on +screen, one might use (note two spaces after %* +: the second ensures there's a space between the truncated +right-hand side and the subject): + + +set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" + + + + + + @@ -3452,17 +4346,23 @@ terminal's title, if supported. All string patterns in Mutt including those in more complex patterns must be specified -using regular expressions (regexp) in the ``POSIX extended'' syntax (which +using regular expressions (regexp) in the POSIX extended syntax (which is more or less the syntax used by egrep and GNU awk). For your convenience, we have included below a brief description of this syntax. The search is case sensitive if the pattern contains at least one upper -case letter, and case insensitive otherwise. Note that ``\'' +case letter, and case insensitive otherwise. + + + + +\ must be quoted if used for a regular expression in an initialization -command: ``\\''. +command: \\. + A regular expression is a pattern that describes a set of strings. @@ -3470,13 +4370,15 @@ Regular expressions are constructed analogously to arithmetic expressions, by using various operators to combine smaller expressions. + -Note that the regular expression can be enclosed/delimited by either " +The regular expression can be enclosed/delimited by either " or ' which is useful if the regular expression includes a white-space character. See for more information on " and ' delimiter processing. To match a literal " or ' you must preface it with \ (backslash). + The fundamental building blocks are the regular expressions that match @@ -3486,249 +4388,128 @@ special meaning may be quoted by preceding it with a backslash. -The period ``.'' matches any single character. The caret ``ˆ'' and -the dollar sign ``$'' are metacharacters that respectively match +The period . matches any single character. The caret ˆ and +the dollar sign $ are metacharacters that respectively match the empty string at the beginning and end of a line. -A list of characters enclosed by ``['' and ``]'' matches any +A list of characters enclosed by [ and ] matches any single character in that list; if the first character of the list -is a caret ``ˆ'' then it matches any character not in the -list. For example, the regular expression [0123456789] +is a caret ˆ then it matches any character not in the +list. For example, the regular expression [0123456789] matches any single digit. A range of ASCII characters may be specified by giving the first and last characters, separated by a hyphen -``-''. Most metacharacters lose their special meaning inside -lists. To include a literal ``]'' place it first in the list. -Similarly, to include a literal ``ˆ'' place it anywhere but first. -Finally, to include a literal hyphen ``-'' place it last. +-. Most metacharacters lose their special meaning inside +lists. To include a literal ] place it first in the list. +Similarly, to include a literal ˆ place it anywhere but first. +Finally, to include a literal hyphen - place it last. Certain named classes of characters are predefined. Character classes -consist of ``[:'', a keyword denoting the class, and ``:]''. -The following classes are defined by the POSIX standard: +consist of [:, a keyword denoting the class, and :]. +The following classes are defined by the POSIX standard in + + + + +POSIX regular expression character classes + + +Character classDescription + + +[:alnum:]Alphanumeric characters +[:alpha:]Alphabetic characters +[:blank:]Space or tab characters +[:cntrl:]Control characters +[:digit:]Numeric characters +[:graph:]Characters that are both printable and visible. (A space is printable, but not visible, while an a is both) +[:lower:]Lower-case alphabetic characters +[:print:]Printable characters (characters that are not control characters) +[:punct:]Punctuation characters (characters that are not letter, digits, control characters, or space characters) +[:space:]Space characters (such as space, tab and formfeed, to name a few) +[:upper:]Upper-case alphabetic characters +[:xdigit:]Characters that are hexadecimal digits + + +
+ + +A character class is only valid in a regular expression inside the +brackets of a character list. + + + + +Note that the brackets in these +class names are part of the symbolic names, and must be included +in addition to the brackets delimiting the bracket list. For +example, [[:digit:]] is equivalent to +[0-9]. + +Two additional special sequences can appear in character lists. These +apply to non-ASCII character sets, which can have single symbols (called +collating elements) that are represented with more than one character, +as well as several characters that are equivalent for collating or +sorting purposes: + + -[:alnum:] +Collating Symbols -Alphanumeric characters. +A collating symbol is a multi-character collating element enclosed in +[. and .]. For example, if ch is a collating +element, then [[.ch.]] is a regexp that matches +this collating element, while [ch] is a regexp that +matches either c or h. -[:alpha:] - - -Alphabetic characters. - - - - -[:blank:] - - -Space or tab characters. - - - - -[:cntrl:] - - -Control characters. - - - - -[:digit:] - - -Numeric characters. - - - - -[:graph:] - - -Characters that are both printable and visible. (A space is printable, -but not visible, while an ``a'' is both.) - - - - -[:lower:] - - -Lower-case alphabetic characters. - - - - -[:print:] - - -Printable characters (characters that are not control characters.) - - - - -[:punct:] - - -Punctuation characters (characters that are not letter, digits, control -characters, or space characters). - - - - -[:space:] - - -Space characters (such as space, tab and formfeed, to name a few). - - - - -[:upper:] - - -Upper-case alphabetic characters. - - - - -[:xdigit:] - - -Characters that are hexadecimal digits. - - - - - - - -A character class is only valid in a regular expression inside the -brackets of a character list. Note that the brackets in these -class names are part of the symbolic names, and must be included -in addition to the brackets delimiting the bracket list. For -example, [[:digit:]] is equivalent to -[0-9]. - - - -Two additional special sequences can appear in character lists. These -apply to non-ASCII character sets, which can have single symbols (called -collating elements) that are represented with more than one character, -as well as several characters that are equivalent for collating or -sorting purposes: - - - - - - -Collating Symbols - - -A collating symbol is a multi-character collating element enclosed in -``[.'' and ``.]''. For example, if ``ch'' is a collating -element, then [[.ch.]] is a regexp that matches -this collating element, while [ch] is a regexp that -matches either ``c'' or ``h''. - - - - -Equivalence Classes +Equivalence Classes An equivalence class is a locale-specific name for a list of -characters that are equivalent. The name is enclosed in ``[='' -and ``=]''. For example, the name ``e'' might be used to -represent all of ``è'' ``é'' and ``e''. In this case, -[[=e=]] is a regexp that matches any of -``è'', ``é'' and ``e''. +characters that are equivalent. The name is enclosed in [= +and =]. For example, the name e might be used to +represent all of è é and e. In this case, +[[=e=]] is a regexp that matches any of +è, é and e. - A regular expression matching a single character may be followed by one -of several repetition operators: +of several repetition operators described in . - - - - -? - - -The preceding item is optional and matched at most once. - - - - -* - - -The preceding item will be matched zero or more times. - - - - -+ - - -The preceding item will be matched one or more times. - - - - -{n} - - -The preceding item is matched exactly n times. - - - - -{n,} - - -The preceding item is matched n or more times. - - - - -{,m} - - -The preceding item is matched at most m times. - - - - -{n,m} - - -The preceding item is matched at least n times, but no more than -m times. - - - - - + +Regular expression repetition operators + + +OperatorDescription + + +?The preceding item is optional and matched at most once +*The preceding item will be matched zero or more times ++The preceding item will be matched one or more times +{n}The preceding item is matched exactly n times +{n,}The preceding item is matched n or more times +{,m}The preceding item is matched at most m times +{n,m}The preceding item is matched at least n times, but no more than m times + + +
Two regular expressions may be concatenated; the resulting regular @@ -3737,7 +4518,7 @@ that respectively match the concatenated subexpressions. -Two regular expressions may be joined by the infix operator ``|''; +Two regular expressions may be joined by the infix operator |; the resulting regular expression matches any string matching either subexpression. @@ -3748,80 +4529,31 @@ precedence over alternation. A whole subexpression may be enclosed in parentheses to override these precedence rules. + -Note: If you compile Mutt with the GNU rx package, the -following operators may also be used in regular expressions: +If you compile Mutt with the included regular expression engine, the +following operators may also be used in regular expressions as described in . + - - - - -\\y - - -Matches the empty string at either the beginning or the end of a word. - - - - -\\B - - -Matches the empty string within a word. - - - - -\\< - - -Matches the empty string at the beginning of a word. - - - - -\\> - - -Matches the empty string at the end of a word. - - - - -\\w - - -Matches any word-constituent character (letter, digit, or underscore). - - - - -\\W - - -Matches any character that is not word-constituent. - - - - -\\` - - -Matches the empty string at the beginning of a buffer (string). - - - - -\\' - - -Matches the empty string at the end of a buffer. - - - - - + +GNU regular expression extensions + + +ExpressionDescription + + +\\yMatches the empty string at either the beginning or the end of a word +\\BMatches the empty string within a word +\\<Matches the empty string at the beginning of a word +\\>Matches the empty string at the end of a word +\\wMatches any word-constituent character (letter, digit, or underscore) +\\WMatches any character that is not word-constituent +\\`Matches the empty string at the beginning of a buffer (string) +\\'Matches the empty string at the end of a buffer + + +
Please note however that these operators are not defined by POSIX, so @@ -3833,14 +4565,16 @@ they may or may not be available in stock libraries on various systems. Patterns: Searching, Limiting and Tagging + +Pattern Modifier + Many of Mutt's commands allow you to specify a pattern to match -(limit, tag-pattern, delete-pattern, etc.). +(limit, tag-pattern, +delete-pattern, etc.). shows several ways to select messages. - - Pattern modifiers @@ -3849,119 +4583,121 @@ shows several ways to select messages. ~Aall messages -~b EXPRmessages which contain EXPR in the message body -=b STRINGmessages which contain STRING in the message body. If IMAP is enabled, searches for STRING on the server, rather than downloading each message and searching it locally. -~B EXPRmessages which contain EXPR in the whole message -~c EXPRmessages carbon-copied to EXPR -%c GROUPmessages carbon-copied to any member of GROUP -~C EXPRmessage is either to: or cc: EXPR -%C GROUPmessage is either to: or cc: to any member of GROUP -~d [MIN]-[MAX]messages with ``date-sent'' in a Date range +~b EXPRmessages which contain EXPR in the message body +=b STRINGmessages which contain STRING in the message body. If IMAP is enabled, searches for STRING on the server, rather than downloading each message and searching it locally. +~B EXPRmessages which contain EXPR in the whole message +~c EXPRmessages carbon-copied to EXPR +%c GROUPmessages carbon-copied to any member of GROUP +~C EXPRmessages either to: or cc: EXPR +%C GROUPmessages either to: or cc: to any member of GROUP +~d [MIN]-[MAX]messages with date-sent in a Date range~Ddeleted messages -~e EXPRmessage which contains EXPR in the ``Sender'' field -%e GROUPmessage which contain a member of GROUP in the ``Sender'' field +~e EXPRmessages which contains EXPR in the Sender field +%e GROUPmessages which contain a member of GROUP in the Sender field~Eexpired messages~Fflagged messages -~f EXPRmessages originating from EXPR -%f GROUPmessages originating from any member of GROUP +~f EXPRmessages originating from EXPR +%f GROUPmessages originating from any member of GROUP~gcryptographically signed messages~Gcryptographically encrypted messages -~h EXPRmessages which contain EXPR in the message header -~H EXPRmessages with a spam attribute matching EXPR -~i EXPRmessage which match EXPR in the ``Message-ID'' field -~kmessage contains PGP key material -~L EXPRmessage is either originated or received by EXPR -%L GROUPmessage is either originated or received by any member of GROUP -~lmessage is addressed to a known mailing list -~m [MIN]-[MAX]message in the range MIN to MAX *) -~n [MIN]-[MAX]messages with a score in the range MIN to MAX *) +~h EXPRmessages which contain EXPR in the message header +~H EXPRmessages with a spam attribute matching EXPR +~i EXPRmessages which match EXPR in the Message-ID field +~kmessages which contain PGP key material +~L EXPRmessages either originated or received by EXPR +%L GROUPmessage either originated or received by any member of GROUP +~lmessages addressed to a known mailing list +~m [MIN]-[MAX]messages in the range MIN to MAX *) +~n [MIN]-[MAX]messages with a score in the range MIN to MAX *)~Nnew messages~Oold messages -~pmessage is addressed to you (consults alternates) -~Pmessage is from you (consults alternates) +~pmessages addressed to you (consults alternates) +~Pmessages from you (consults alternates)~Qmessages which have been replied to -~r [MIN]-[MAX]messages with ``date-received'' in a Date range +~r [MIN]-[MAX]messages with date-received in a Date range~Rread messages -~s EXPRmessages having EXPR in the ``Subject'' field. +~s EXPRmessages having EXPR in the Subject field.~Ssuperseded messages -~t EXPRmessages addressed to EXPR +~t EXPRmessages addressed to EXPR~Ttagged messages -~umessage is addressed to a subscribed mailing list +~umessages addressed to a subscribed mailing list~Uunread messages -~vmessage is part of a collapsed thread. +~vmessages part of a collapsed thread.~Vcryptographically verified messages -~x EXPRmessages which contain EXPR in the `References' field -~X [MIN]-[MAX]messages with MIN to MAX attachments *) -~y EXPRmessages which contain EXPR in the `X-Label' field -~z [MIN]-[MAX]messages with a size in the range MIN to MAX *) -~=duplicated messages (see $duplicate_threads) +~x EXPRmessages which contain EXPR in the References or In-Reply-To field +~X [MIN]-[MAX]messages with MIN to MAX attachments *) +~y EXPRmessages which contain EXPR in the X-Label field +~z [MIN]-[MAX]messages with a size in the range MIN to MAX *) **) +~=duplicated messages (see $duplicate_threads)~$unreferenced messages (requires threaded view) -~(PATTERN)messages in threads -containing messages matching a certain pattern, e.g. all +~(PATTERN)messages in threads +containing messages matching PATTERN, e.g. all threads containing messages from you: ~(~P)
+ +Where EXPR is a +regular expression. + + + +*) The forms <[MAX], >[MIN], +[MIN]- and -[MAX] +are allowed, too. + + + +**) The suffixes K and M are allowed to specify kilobyte and megabyte respectively. -Where EXPR is a -regular expression. Special attention has to be -made when using regular expressions inside of patterns. Specifically, -Mutt's parser for these patterns will strip one level of backslash (\), +Special attention has to be +payed when using regular expressions inside of patterns. Specifically, +Mutt's parser for these patterns will strip one level of backslash (\), which is normally used for quoting. If it is your intention to use a backslash in the regular expression, you will need to use two backslashes -instead (\\). You can force mutt to treat EXPR as a simple string +instead (\\). You can force Mutt to treat EXPR as a simple string instead of a regular expression by using = instead of ˜ in the -pattern name. For example, =b *.* will find all messages that contain -the literal string '*.*'. Simple string matches are less powerful than +pattern name. For example, =b *.* will find all messages that contain +the literal string *.*. Simple string matches are less powerful than regular expressions but can be considerably faster. This is especially true for IMAP folders, because string matches can be performed on the -server instead of by fetching every message. IMAP treats =h specially: -it must be of the form "header: substring" and will not partially +server instead of by fetching every message. IMAP treats =h specially: +it must be of the form header: substring and will not partially match header names. The substring part may be omitted if you simply wish to find messages containing a particular header without regard to its value. -*) The forms <[MAX], >[MIN], -[MIN]- and -[MAX] -are allowed, too. - - - -Pattern Modifier - - -Note that patterns matching 'lists' of addresses (notably c,C,p,P and t) +Patterns matching lists of addresses (notably c, C, p, P and t) match if there is at least one match in the whole list. If you want to make sure that all elements of that list match, you need to prefix your -pattern with ˆ. +pattern with ˆ. This example matches all mails which only has recipients from Germany. - - + +Matching all addresses in address lists ^~C \.de$ - - + - -Simple Patterns + +Simple Searches -Mutt supports two versions of so called ``simple searches'' which are +Mutt supports two versions of so called simple searches. These are issued if the query entered for searching, limiting and similar -operations does not seem to be a valid pattern (i.e. it does not contain -one of these characters: ``~'', ``='' or ``%''). If the query is +operations does not seem to contain a valid pattern modifier (i.e. it does not contain +one of these characters: ˜, = or %). If the query is supposed to contain one of these special characters, they must be escaped -by prepending a backslash (``\''). +by prepending a backslash (\). @@ -3970,10 +4706,10 @@ a keyword case-insensitively from : If that is the case, Mutt will use the shown pattern modifier instead. If a keyword would conflict with your search keyword, you need to turn it into a regular expression to avoid matching the keyword table. For -example, if you want to find all messages matching ``flag'' -(using $simple_search, -see below but not meaning flagged messages) simply search for -``[f]lag''. +example, if you want to find all messages matching flag +(using $simple_search) +but don't want to match flagged messages, simply search for +[f]lag. @@ -4007,25 +4743,21 @@ for the composed complex query. - -Complex Patterns + +Nesting and Boolean Operators Logical AND is performed by specifying more than one criterion. For example: - - ~t mutt ~f elkins - - -would select messages which contain the word ``mutt'' in the list of -recipients and that have the word ``elkins'' in the ``From'' header +would select messages which contain the word mutt in the list of +recipients and that have the word elkins in the From header field. @@ -4034,118 +4766,99 @@ Mutt also recognizes the following operators to create more complex search patterns: - - -! -- logical NOT operator +! — logical NOT operator -| -- logical OR operator +| — logical OR operator -() -- logical grouping operator +() — logical grouping operator - - Here is an example illustrating a complex search pattern. This pattern will -select all messages which do not contain ``mutt'' in the ``To'' or ``Cc'' -field and which are from ``elkins''. +select all messages which do not contain mutt in the To or Cc +field and which are from elkins. - - + +Using boolean operators in patterns !(~t mutt|~c mutt) ~f elkins - - + Here is an example using white space in the regular expression (note the ' and " delimiters). For this to match, the mail's subject must -match the ``ˆJunk +From +Me$'' and it must be from either ``Jim +Somebody'' -or ``Ed +SomeoneElse'': +match the ˆJunk +From +Me$ and it must be from either Jim +Somebody +or Ed +SomeoneElse: - - '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")' - - + -Note that if a regular expression contains parenthesis, or a vertical bar -("|"), you must enclose the expression in double or single quotes since +If a regular expression contains parenthesis, or a vertical bar +("|"), you must enclose the expression in double or single quotes since those characters are also used to separate different parts of Mutt's -pattern language. For example, +pattern language. For example: ~f "me@(mutt\.org|cs\.hmc\.edu)" +Without the quotes, the parenthesis wouldn't end. +This would be separated to two OR'd patterns: ˜f me@(mutt\.org +and cs\.hmc\.edu). They are never what you want. + - + - -~f "me@(mutt\.org|cs\.hmc\.edu)" - + +Searching by Date + +Mutt supports two types of dates, absolute and relative. - -Without the quotes, the parenthesis wouldn't end. -This would be seperated to two OR'd patterns: ˜f me@(mutt\.org -and cs\.hmc\.edu). They are never what you want. - - - - - -Searching by Date + +Absolute Dates -Mutt supports two types of dates, absolute and relative. - - - -Absolute. Dates must be in DD/MM/YY format (month and year are +Dates must be in DD/MM/YY format (month and year are optional, defaulting to the current month and year). An example of a valid range of dates is: - - Limit to messages matching: ~d 20/1/95-31/10 - - -If you omit the minimum (first) date, and just specify ``-DD/MM/YY'', all +If you omit the minimum (first) date, and just specify -DD/MM/YY, all messages before the given date will be selected. If you omit the maximum -(second) date, and specify ``DD/MM/YY-'', all messages after the given -date will be selected. If you specify a single date with no dash (``-''), -only messages sent on the given date will be selected. +(second) date, and specify DD/MM/YY-, all messages after the given +date will be selected. If you specify a single date with no dash (-), +only messages sent on the given date will be selected. -Error Margins. You can add error margins to absolute dates. +You can add error margins to absolute dates. An error margin is a sign (+ or -), followed by a digit, followed by one of the units in . As a special case, you can replace the -sign by a ``*'' character, which is equivalent to giving identical plus and minus error margins. +sign by a * character, which is equivalent to giving identical plus and minus error margins.
@@ -4165,62 +4878,67 @@ sign by a ``*'' character, which is equivalent to giving identical plus and minu Example: To select any messages two weeks around January 15, 2001, -you'd use the following pattern: +you'd use the following pattern: + - Limit to messages matching: ~d 15/1/2001*2w - + + + +Relative Dates -Relative. This type of date is relative to the current date, and may +This type of date is relative to the current date, and may be specified as: + ->offset (messages older than offset units) +>offset for messages older than offset units -<offset (messages newer than offset units) +<offset for messages newer than offset units -=offset (messages exactly offset units old) +=offset for messages exactly offset units old - - offset is specified as a positive number with one of the units from . Example: to select messages less than 1 month old, you would use + Limit to messages matching: ~d <1m - - + -Note: all dates used when searching are relative to the -local time zone, so unless you change the setting of your $index_format to include a -%[...] format, these are not the dates shown +All dates used when searching are relative to the +local time zone, so unless you change the setting of your $index_format to include a +%[...] format, these are not the dates shown in the main index. + + + @@ -4234,29 +4952,29 @@ Sometimes it is desirable to perform an operation on a group of messages all at once rather than one at a time. An example might be to save messages to a mailing list to a separate folder, or to delete all messages with a given subject. To tag all messages -matching a pattern, use the tag-pattern function, which is bound to -``shift-T'' by default. Or you can select individual messages by -hand using the ``tag-message'' function, which is bound to ``t'' by +matching a pattern, use the <tag-pattern> function, which is bound to +shift-T by default. Or you can select individual messages by +hand using the <tag-message> function, which is bound to t by default. See patterns for Mutt's pattern matching syntax. Once you have tagged the desired messages, you can use the -``tag-prefix'' operator, which is the ``;'' (semicolon) key by default. -When the ``tag-prefix'' operator is used, the next operation will +tag-prefix operator, which is the ; (semicolon) key by default. +When the tag-prefix operator is used, the next operation will be applied to all tagged messages if that operation can be used in that manner. If the $auto_tag variable is set, the next operation applies to the tagged messages -automatically, without requiring the ``tag-prefix''. +automatically, without requiring the tag-prefix. -In macros or push commands, -you can use the ``tag-prefix-cond'' operator. If there are no tagged -messages, mutt will "eat" the rest of the macro to abort it's execution. -Mutt will stop "eating" the macro when it encounters the ``end-cond'' -operator; after this operator the rest of the macro will be executed as +In macros or push commands, +you can use the <tag-prefix-cond> operator. If there are no tagged +messages, Mutt will eat the rest of the macro to abort it's execution. +Mutt will stop eating the macro when it encounters the <end-cond> +operator; after this operator the rest of the macro will be executed as normal. @@ -4266,55 +4984,91 @@ normal. Using Hooks -A hook is a concept borrowed from the EMACS editor which allows you to +A hook is a concept found in many other programs which allows you to execute arbitrary commands before performing some operation. For example, you may wish to tailor your configuration based upon which mailbox you are reading, or to whom you are sending mail. In the Mutt world, a hook consists of a regular expression or pattern along with a -configuration option/command. See +configuration option/command. See: - + -folder-hook +account-hook + + +charset-hook + + + -send-hook +crypt-hook + + +fcc-hook + + + -message-hook +fcc-save-hook + + +folder-hook + + + -save-hook +iconv-hook + + +mbox-hook + + + -mbox-hook +message-hook + + +reply-hook + + + -fcc-hook +save-hook + + +send-hook + + + -fcc-save-hook +send2-hook @@ -4323,29 +5077,38 @@ configuration option/command. See for specific details on each type of hook available. + -Note: if a hook changes configuration settings, these changes remain -effective until the end of the current mutt session. As this is generally -not desired, a default hook needs to be added before all other hooks to -restore configuration defaults. Here is an example with send-hook and the -my_hdr directive: +If a hook changes configuration settings, these changes remain +effective until the end of the current Mutt session. As this is generally +not desired, a default hook needs to be added before all +other hooks of that type to restore configuration defaults. + - - + +Specifying a <quote>default</quote> hook send-hook . 'unmy_hdr From:' send-hook ~C'^b@b\.b$' my_hdr from: c@c.c + + +In , by default the value of +$from +and $realname +is not overridden. When sending messages either To: or Cc: +to <b@b.b>, the From: header is changed to +<c@c.c>. Message Matching in Hooks -Hooks that act upon messages (message-hook, reply-hook, -send-hook, send2-hook, save-hook, fcc-hook) are evaluated in a +Hooks that act upon messages (message-hook, reply-hook, +send-hook, send2-hook, save-hook, fcc-hook) are evaluated in a slightly different manner. For the other types of hooks, a regular expression is sufficient. But in dealing with messages a finer grain of control is @@ -4358,18 +5121,20 @@ Mutt allows the use of the search pattern language for matching messages in hook commands. This works in exactly the same way as it would when limiting or searching the mailbox, except that you are restricted to those -operators which match information mutt extracts from the header of +operators which match information Mutt extracts from the header of the message (i.e., from, to, cc, date, subject, etc.). For example, if you wanted to set your return address based upon sending mail to a specific address, you could do something like: + send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>' + which would execute the given command when sending mail to me@cs.hmc.edu. @@ -4378,9 +5143,9 @@ which would execute the given command when sending mail to However, it is not required that you write the pattern to match using the full searching language. You can still specify a simple regular expression like the other hooks, in which case Mutt will translate your -pattern into the full language, using the translation specified by the +pattern into the full language, using the translation specified by the $default_hook variable. The -pattern is translated at the time the hook is declared, so the value of +pattern is translated at the time the hook is declared, so the value of $default_hook that is in effect at that time will be used. @@ -4394,19 +5159,15 @@ at that time will be used. Mutt supports connecting to external directory databases such as LDAP, -ph/qi, bbdb, or NIS through a wrapper script which connects to mutt +ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt using a simple interface. Using the $query_command variable, you specify the wrapper command to use. For example: - - set query_command = "mutt_ldap_query.pl '%s'" - - The wrapper script should accept the query on the command-line. It should return a one line message, then each matching response on a @@ -4417,6 +5178,7 @@ addresses, return a non-zero exit code and a one line error message. An example multiple response output: + Searching database ... 20 entries ... 3 matching: @@ -4425,11 +5187,9 @@ blong@fiction.net Brandon Long mutt and more roessler@does-not-exist.org Thomas Roessler mutt pgp - - -There are two mechanisms for accessing the query function of mutt. One -is to do a query from the index menu using the query function (default: Q). +There are two mechanisms for accessing the query function of Mutt. One +is to do a query from the index menu using the <query> function (default: Q). This will prompt for a query, then bring up the query menu which will list the matching responses. From the query menu, you can select addresses to create aliases, or to mail. You can tag multiple addresses @@ -4440,11 +5200,11 @@ responses. The other mechanism for accessing the query function is for address completion, similar to the alias completion. In any prompt for address -entry, you can use the complete-query function (default: ˆT) to run a -query based on the current address you have typed. Like aliases, mutt +entry, you can use the <complete-query> function (default: ˆT) to run a +query based on the current address you have typed. Like aliases, Mutt will look for what you have typed back to the last space or comma. If -there is a single response for that query, mutt will expand the address -in place. If there are multiple responses, mutt will activate the query +there is a single response for that query, Mutt will expand the address +in place. If there are multiple responses, Mutt will activate the query menu. At the query menu, you can select one or more addresses to be added to the prompt. @@ -4455,53 +5215,69 @@ added to the prompt. Mailbox Formats -Mutt supports reading and writing of four different mailbox formats: +Mutt supports reading and writing of four different local mailbox formats: mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there is no need to use a flag for different mailbox types. When creating new -mailboxes, Mutt uses the default specified with the $mbox_type variable. +mailboxes, Mutt uses the default specified with the +$mbox_type variable. A +short description of the formats follows. -mbox. This is the most widely used mailbox format for UNIX. All +mbox. This is a widely used mailbox format for UNIX. All messages are stored in a single file. Each message has a line of the form: - - From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST - - to denote the start of a new message (this is often referred to as the -``From_'' line). +From_ line). The mbox format requires mailbox +locking, is prone to mailbox corruption with concurrently writing +clients or misinterpreted From_ lines. Depending on the +environment, new mail detection can be unreliable. Mbox folders are fast +to open and easy to archive. -MMDF. This is a variant of the mbox format. Each message is -surrounded by lines containing ``ˆAˆAˆAˆA'' (four control-A's). +MMDF. This is a variant of +the mbox format. Each message is surrounded by +lines containing ˆAˆAˆAˆA (four +control-A's). The same problems as for mbox apply (also with finding the +right message separator as four control-A's may appear in message +bodies). -MH. A radical departure from mbox and MMDF, a mailbox +MH. A radical departure from mbox and MMDF, a mailbox consists of a directory and each message is stored in a separate file. The filename indicates the message number (however, this is may not correspond to the message number Mutt displays). Deleted messages are -renamed with a comma (,) prepended to the filename. Note: Mutt +renamed with a comma (,) prepended to the filename. Mutt detects this type of mailbox by looking for either .mh_sequences -or .xmhcache (needed to distinguish normal directories from MH -mailboxes). +or .xmhcache files (needed to distinguish normal directories from MH +mailboxes). MH is more robust with concurrent clients writing the mailbox, +but still may suffer from lost flags; message corruption is less likely +to occur than with mbox/mmdf. It's usually slower to open compared to +mbox/mmdf since many small files have to be read (Mutt provides + to greatly speed this process up). +Depending on the environment, MH is not very disk-space efficient. -Maildir. The newest of the mailbox formats, used by the Qmail MTA (a +Maildir. The newest of the mailbox formats, used by the Qmail MTA (a replacement for sendmail). Similar to MH, except that it adds three subdirectories of the mailbox: tmp, new and cur. Filenames for the messages are chosen in such a way they are unique, even when two programs are writing the mailbox over NFS, which means that no file locking -is needed. +is needed and corruption is very unlikely. Maildir maybe +slower to open without caching in Mutt, it too is not very +disk-space efficient depending on the environment. Since no additional +files are used for metadata (which is embedded in the message filenames) +and Maildir is locking-free, it's easy to sync across different machines +using file-level synchronization tools. @@ -4512,65 +5288,72 @@ is needed. There are a number of built in shortcuts which refer to specific mailboxes. These shortcuts can be used anywhere you are prompted for a file or mailbox -path. +path or in path-related configuration variables. Note that these only +work at the beginning of a string. - - -! -- refers to your $spoolfile (incoming) mailbox +! — refers to your $spoolfile (incoming) mailbox -> -- refers to your $mbox file +> — refers to your $mbox file -< -- refers to your $record file +< — refers to your $record file -ˆ -- refers to the current mailbox +ˆ — refers to the current mailbox -- or !! -- refers to the file you've last visited +- or !! — refers to the file you've last visited -˜ -- refers to your home directory +˜ — refers to your home directory -= or + -- refers to your $folder directory += or + — refers to your $folder directory -@alias -- refers to the default save folder as determined by the address of the alias +@alias — refers to the default save folder as determined by the address of the alias + +For example, to store a copy of outgoing messages in the folder they +were composed in, +a folder-hook can +be used to set $record: + +folder-hook . 'set record=ˆ' + @@ -4582,7 +5365,7 @@ amounts of mail easier. The first thing you must do is to let Mutt know what addresses you consider to be mailing lists (technically this does not have to be a mailing list, but that is what it is most often used for), and what lists you are subscribed to. This is -accomplished through the use of the lists and subscribe commands in your muttrc. +accomplished through the use of the lists and subscribe commands in your .muttrc. @@ -4590,18 +5373,18 @@ Now that Mutt knows what your mailing lists are, it can do several things, the first of which is the ability to show the name of a list through which you received a message (i.e., of a subscribed list) in the index menu display. This is useful to distinguish between -personal and list mail in the same mailbox. In the $index_format variable, the escape ``%L'' -will return the string ``To <list>'' when ``list'' appears in the -``To'' field, and ``Cc <list>'' when it appears in the ``Cc'' -field (otherwise it returns the name of the author). +personal and list mail in the same mailbox. In the $index_format variable, the expando %L +will print the string To <list> when list appears in the +To field, and Cc <list> when it appears in the Cc +field (otherwise it prints the name of the author). -Often times the ``To'' and ``Cc'' fields in mailing list messages +Often times the To and Cc fields in mailing list messages tend to get quite large. Most people do not bother to remove the -author of the message they are reply to from the list, resulting in -two or more copies being sent to that person. The ``list-reply'' -function, which by default is bound to ``L'' in the index menu +author of the message they reply to from the list, resulting in +two or more copies being sent to that person. The <list-reply> +function, which by default is bound to L in the index menu and pager, helps reduce the clutter by only replying to the known mailing list addresses instead of all recipients (except as specified by Mail-Followup-To, see below). @@ -4610,10 +5393,10 @@ specified by Mail-Followup-To, see below). Mutt also supports the Mail-Followup-To header. When you send a message to a list of recipients which includes one or several -subscribed mailing lists, and if the $followup_to option is set, mutt will generate +subscribed mailing lists, and if the $followup_to option is set, Mutt will generate a Mail-Followup-To header which contains all the recipients to whom you send this message, but not your address. This indicates that -group-replies or list-replies (also known as ``followups'') to this +group-replies or list-replies (also known as followups) to this message should only be sent to the original recipients of the message, and not separately to you - you'll receive your copy through one of the mailing lists you are subscribed to. @@ -4621,41 +5404,43 @@ one of the mailing lists you are subscribed to. Conversely, when group-replying or list-replying to a message which -has a Mail-Followup-To header, mutt will respect this header if +has a Mail-Followup-To header, Mutt will respect this header if the $honor_followup_to configuration -variable is set. Using list-reply will in this case also make sure +variable is set. Using list-reply will in this case also make sure that the reply goes to the mailing list, even if it's not specified in the list of recipients in the Mail-Followup-To. + -Note that, when header editing is enabled, you can create a +When header editing is enabled, you can create a Mail-Followup-To header manually. Mutt will only auto-generate this header if it doesn't exist when you send the message. + The other method some mailing list admins use is to generate a -``Reply-To'' field which points back to the mailing list address rather +Reply-To field which points back to the mailing list address rather than the author of the message. This can create problems when trying to reply directly to the author in private, since most mail clients -will automatically reply to the address given in the ``Reply-To'' +will automatically reply to the address given in the Reply-To field. Mutt uses the $reply_to variable to help decide which address to use. If set to ask-yes or ask-no, you will be prompted as to whether or not you would like to use the address given in -the ``Reply-To'' field, or reply directly to the address given in the -``From'' field. When set to yes, the ``Reply-To'' field will be used when +the Reply-To field, or reply directly to the address given in the +From field. When set to yes, the Reply-To field will be used when present. -The ``X-Label:'' header field can be used to further identify mailing +The X-Label: header field can be used to further identify mailing lists or list subject matter (or just to annotate messages -individually). The $index_format variable's ``%y'' and -``%Y'' escapes can be used to expand ``X-Label:'' fields in the +individually). The $index_format variable's %y and +%Y expandos can be used to expand X-Label: fields in the index, and Mutt's pattern-matcher can match regular expressions to -``X-Label:'' fields with the ``˜y'' selector. ``X-Label:'' is not a +X-Label: fields with the ˜y selector. X-Label: is not a standard message header field, but it can easily be inserted by procmail and other mail filtering agents. @@ -4672,44 +5457,94 @@ uninteresting threads and quickly find topics of value. + +Handling multiple folders + + +Mutt supports setups with multiple folders, allowing all of them to +be monitored for new mail (see for details). + + + +When in the index menu and being idle (also see +$timeout), Mutt periodically checks +for new mail in all folders which have been configured via the +mailboxes command. The interval depends on the folder +type: for local/IMAP folders it consults +$mail_check and +$pop_checkinterval +for POP folders. + + + +Outside the index menu the directory browser supports checking +for new mail using the <check-new> function which is +unbound by default. Pressing TAB will bring up a +menu showing the files specified by the mailboxes command, +and indicate which contain new messages. Mutt will automatically enter this +mode when invoked from the command line with the -y option. + + + +For the pager, index and directory browser menus, Mutt contains the +<buffy-list> function (bound to . by default) +which will print a list of folders with new mail in the command line at +the bottom of the screen. + + + +For the index, by default Mutt displays the number of mailboxes with new +mail in the status bar, please refer to the +$status_format +variable for details. + + + +When changing folders, Mutt fills the prompt with the first folder from +the mailboxes list containing new mail (if any), pressing +space will cycle through folders with new mail. + + + + -Editing threads +Editing Threads Mutt has the ability to dynamically restructure threads that are broken either by misconfigured software or bad behavior from some -correspondents. This allows to clean your mailboxes formats) from these +correspondents. This allows to clean your mailboxes from these annoyances which make it hard to follow a discussion. - -Linking threads + +Linking Threads -Some mailers tend to "forget" to correctly set the "In-Reply-To:" and -"References:" headers when replying to a message. This results in broken +Some mailers tend to forget to correctly set the In-Reply-To: and +References: headers when replying to a message. This results in broken discussions because Mutt has not enough information to guess the correct threading. You can fix this by tagging the reply, then moving to the parent message -and using the ``link-threads'' function (bound to & by default). The -reply will then be connected to this "parent" message. +and using the <link-threads> function (bound to & by default). The +reply will then be connected to this parent message. You can also connect multiple children at once, tagging them and using the -tag-prefix command (';') or the auto_tag option. +<tag-prefix> command (';') or the $auto_tag option. - -Breaking threads + +Breaking Threads On mailing lists, some people are in the bad habit of starting a new -discussion by hitting "reply" to any message from the list and changing +discussion by hitting reply to any message from the list and changing the subject to a totally unrelated one. -You can fix such threads by using the ``break-thread'' function (bound +You can fix such threads by using the <break-thread> function (bound by default to #), which will turn the subthread starting from the current message into a whole different thread. @@ -4724,7 +5559,7 @@ current message into a whole different thread. RFC1894 defines a set of MIME content types for relaying information about the status of electronic mail messages. These can be thought of as -``return receipts.'' +return receipts. @@ -4747,31 +5582,75 @@ whether DSN is supported. For SMTP delivery using $smtp_url, it depends on the -capabilities announced by the server whether mutt will attempt to +capabilities announced by the server whether Mutt will attempt to request DSN or not. -Start a WWW Browser on URLs (EXTERNAL) +Start a WWW Browser on URLs -If a message contains URLs (unified resource locator = address in the -WWW space like http://www.mutt.org/), it is efficient to get +If a message contains URLs, it is efficient to get a menu with all the URLs and start a WWW browser on one of them. This functionality is provided by the external urlview program which can be -retrieved at ftp://ftp.mutt.org/mutt/contrib/ and the configuration commands: +retrieved at +ftp://ftp.mutt.org/mutt/contrib/ +and the configuration commands: + macro index \cb |urlview\n macro pager \cb |urlview\n + + + +Miscellany + + +This section documents various features that fit nowhere else. + + + + + +Address normalization + + + +Mutt normalizes all e-mail addresses to the simplest form possible. If +an address contains a realname, the form +Joe User <joe@example.com> is used and the +pure e-mail address without angle brackets otherwise, i.e. just +joe@example.com. + + +This normalization affects all headers Mutt generates including aliases. + + + + + +Initial folder selection + + + +The folder Mutt opens at startup is determined as follows: the folder +specified in the $MAIL environment variable if +present. Otherwise, the value of $MAILDIR is taken +into account. If that isn't present either, Mutt takes the user's +mailbox in the mailspool as determined at compile-time (which may also +reside in the home directory). The +$spoolfile setting overrides +this selection. Highest priority has the mailbox given with the +-f command line option. + + + @@ -4786,7 +5665,7 @@ MIME MUA. Every effort has been made to provide the functionality that the discerning MIME user requires, and the conformance to the standards wherever possible. When configuring Mutt for MIME, there are two extra types of configuration files which Mutt uses. One is the -mime.types file, which contains the mapping of file extensions to +mime.types file, which contains the mapping of file extensions to IANA MIME types. The other is the mailcap file, which specifies the external commands to use for handling specific MIME types. @@ -4800,8 +5679,8 @@ pager (while viewing a message), the attachment menu and the compose menu. - -Viewing MIME messages in the pager + +Viewing MIME Messages in the Pager When you select a message from the index and view it in the pager, Mutt @@ -4815,12 +5694,14 @@ including PGP/MIME and application/pgp. Mutt will denote attachments with a couple lines describing them. These lines are of the form: + [-- Attachment #1: Description --] [-- Type: text/plain, Encoding: 7bit, Size: 10000 --] + Where the Description is the description or filename given for the attachment, and the Encoding is one of 7bit/8bit/quoted-printable/base64/binary. @@ -4828,34 +5709,34 @@ attachment, and the Encoding is one of If Mutt cannot deal with a MIME type, it will display a message like: + [-- image/gif is unsupported (use 'v' to view this part) --] - - The Attachment Menu -The default binding for view-attachments is `v', which displays the +The default binding for <view-attachments> is v, which displays the attachment menu for a message. The attachment menu displays a list of the attachments in a message. From the attachment menu, you can save, print, pipe, delete, and view attachments. You can apply these operations to a group of attachments at once, by tagging the attachments -and by using the ``tag-prefix'' operator. You can also reply to the +and by using the <tag-prefix> operator. You can also reply to the current message from this menu, and only the current attachment (or the attachments tagged) will be quoted in your reply. You can view attachments as text, or view them using the mailcap viewer definition. -Finally, you can apply the usual message-related functions (like -resend-message, and the reply -and forward functions) to attachments of type message/rfc822. +Finally, you can apply the usual message-related functions (like +<resend-message>, and the +<reply> and <forward> +functions) to attachments of type message/rfc822. @@ -4879,27 +5760,26 @@ information, notably the type, encoding and description. Attachments appear as follows: + - 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description> 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description> - - The '-' denotes that Mutt will delete the file after sending (or postponing, or canceling) the message. It can be toggled with the -toggle-unlink command (default: u). The next field is the MIME -content-type, and can be changed with the edit-type command +<toggle-unlink> command (default: u). The next field is the MIME +content-type, and can be changed with the <edit-type> command (default: ˆT). The next field is the encoding for the attachment, which allows a binary message to be encoded for transmission on 7bit -links. It can be changed with the edit-encoding command +links. It can be changed with the <edit-encoding> command (default: ˆE). The next field is the size of the attachment, rounded to kilobytes or megabytes. The next field is the filename, -which can be changed with the rename-file command (default: R). +which can be changed with the <rename-file> command (default: R). The final field is the description of the attachment, and can be -changed with the edit-description command (default: d). +changed with the <edit-description> command (default: d). @@ -4907,18 +5787,19 @@ changed with the edit-description command (default: d). -MIME Type configuration with <literal>mime.types</literal> +MIME Type Configuration with <literal>mime.types</literal> When you add an attachment to your mail message, Mutt searches your -personal mime.types file at ${HOME}/.mime.types, and then -the system mime.types file at /usr/local/share/mutt/mime.types or +personal mime.types file at ${HOME}/.mime.types, and then +the system mime.types file at /usr/local/share/mutt/mime.types or /etc/mime.types -The mime.types file consist of lines containing a MIME type and a space +The mime.types file consist of lines containing a MIME type and a space separated list of extensions. For example: + application/postscript ps eps @@ -4926,6 +5807,7 @@ application/pgp pgp audio/x-aiff aif aifc aiff + A sample mime.types file comes with the Mutt distribution, and should contain most of the MIME types you are likely to use. @@ -4936,22 +5818,22 @@ attach, it will look at the file. If the file is free of binary information, Mutt will assume that the file is plain text, and mark it as text/plain. If the file contains binary information, then Mutt will mark it as application/octet-stream. You can change the MIME -type that Mutt assigns to an attachment by using the edit-type +type that Mutt assigns to an attachment by using the <edit-type> command from the compose menu (default: ˆT). The MIME type is actually a major mime type followed by the sub-type, separated by a '/'. 6 major types: application, text, image, video, audio, and model have been approved -after various internet discussions. Mutt recognizes all of these if the -appropriate entry is found in the mime.types file. It also recognizes other -major mime types, such as the chemical type that is widely used in the -molecular modeling community to pass molecular data in various forms to -various molecular viewers. Non-recognized mime types should only be used +after various internet discussions. Mutt recognizes all of these if the +appropriate entry is found in the mime.types file. It also recognizes other +major mime types, such as the chemical type that is widely used in the +molecular modeling community to pass molecular data in various forms to +various molecular viewers. Non-recognized mime types should only be used if the recipient of the message is likely to be expecting such attachments. - -MIME Viewer configuration with <literal>mailcap</literal> + +MIME Viewer Configuration with Mailcap Mutt supports RFC 1524 MIME Configuration, in particular the Unix @@ -4959,7 +5841,7 @@ specific format specified in Appendix A of RFC 1524. This file format is commonly referred to as the mailcap format. Many MIME compliant programs utilize the mailcap format, allowing you to specify handling for all MIME types in one place for all programs. Programs known to -use this format include Netscape, XMosaic, lynx and metamail. +use this format include Firefox, lynx and metamail. @@ -4967,6 +5849,7 @@ In order to handle various MIME types that Mutt can not handle internally, Mutt parses a series of external configuration files to find an external handler. The default search string for these files is a colon delimited list containing the following files: + $HOME/.mailcap @@ -4977,9 +5860,10 @@ is a colon delimited list containing the following files: /usr/local/etc/mailcap + where $HOME is your home directory. The $PKGDATADIR and the -$SYSCONFDIR directories depend on where mutt +$SYSCONFDIR directories depend on where Mutt is installed: the former is the default for shared data, the latter for system configuration files. @@ -4999,8 +5883,8 @@ usually as /usr/local/etc/mailcap, which contains some baseli entries. - -The Basics of the mailcap file + +The Basics of the Mailcap File A mailcap file consists of a series of lines which are comments, blank, @@ -5047,59 +5931,71 @@ will remove the temporary file if it exists. So, in the simplest form, you can send a text/plain message to the external pager more on stdin: + text/plain; more + Or, you could send the message as a file: + text/plain; more %s -Perhaps you would like to use lynx to interactively view a text/html + +Perhaps you would like to use lynx to interactively view a text/html message: + text/html; lynx %s + In this case, lynx does not support viewing a file from stdin, so you must use the %s syntax. -Note: Some older versions of lynx contain a bug where they + + + + +Some older versions of lynx contain a bug where they will check the mailcap file for a viewer for text/html. They will find the line which calls lynx, and run it. This causes lynx to continuously spawn itself to view the object. + On the other hand, maybe you don't want to use lynx interactively, you just want to have it convert the text/html to text/plain, then you can use: + text/html; lynx -dump %s | more - - Perhaps you wish to use lynx to view text/html files, and a pager on all other text formats, then you would use the following: + text/html; lynx %s text/*; more + This is the simplest form of a mailcap file. - -Secure use of mailcap + +Secure Use of Mailcap The interpretation of shell meta-characters embedded in MIME parameters @@ -5109,7 +6005,7 @@ substituting them, see the $mailcap&lowb -Although mutt's procedures to invoke programs with mailcap seem to be +Although Mutt's procedures to invoke programs with mailcap seem to be safe, there are other applications parsing mailcap, maybe taking less care of it. Therefore you should pay attention to the following rules: @@ -5132,27 +6028,25 @@ example (using $charset inside the backtick expansion since it is not itself subject to any further expansion): - - text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \ && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1 - - - -Advanced mailcap Usage + +Advanced Mailcap Usage - + Optional Fields In addition to the required content-type and view command fields, you can add semi-colon ';' separated fields to set flags and other options. Mutt recognizes the following optional fields: + + @@ -5165,11 +6059,13 @@ pager or the external pager defined by the pager variable) on the output of the view command. Without this flag, Mutt assumes that the command is interactive. One could use this to replace the pipe to more in the lynx -dump example in the Basic section: + text/html; lynx -dump %s ; copiousoutput + This will cause lynx to format the text/html output as text/plain and Mutt will use your standard pager to display the results. @@ -5179,7 +6075,7 @@ and Mutt will use your standard pager to display the results. needsterminal -Mutt uses this flag when viewing attachments with auto_view, in order to decide whether it should honor the setting +Mutt uses this flag when viewing attachments with auto_view, in order to decide whether it should honor the setting of the $wait_key variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap entry has a needsterminal flag, Mutt will use @@ -5205,7 +6101,7 @@ specific MIME type. Mutt supports this from the compose menu. This flag specifies the command to use to create a new attachment of a specific MIME type. This command differs from the compose command in -that mutt will expect standard MIME headers on the data. This can be +that Mutt will expect standard MIME headers on the data. This can be used to specify parameters, filename, description, etc. for a new attachment. Mutt supports this from the compose menu. @@ -5241,12 +6137,12 @@ for instance, to correctly view a file. For instance, lynx will only interpret a file as text/html if the file ends in .html. So, you would specify lynx as a text/html viewer with a line in the mailcap file like: + text/html; lynx %s; nametemplate=%s.html - @@ -5258,28 +6154,29 @@ entry should be used. The command is defined with the command expansion rules defined in the next section. If the command returns 0, then the test passed, and Mutt uses this entry. If the command returns non-zero, then the test failed, and Mutt continues searching for the right entry. -Note: the content-type must match before Mutt performs the test. +Note that the content-type must match before Mutt performs the test. For example: + -text/html; netscape -remote 'openURL(%s)' ; test=RunningX +text/html; firefox -remote 'openURL(%s)' ; test=RunningX text/html; lynx %s + In this example, Mutt will run the program RunningX which will return 0 if the X Window manager is running, and non-zero if it isn't. If -RunningX returns 0, then Mutt will call netscape to display the -text/html object. If RunningX doesn't return 0, then Mutt will go on -to the next entry and use lynx to display the text/html object. +RunningX returns 0, then Mutt will call firefox to display the +text/html object. If RunningX doesn't return 0, then Mutt will go on +to the next entry and use lynx to display the text/html object. - - + Search Order @@ -5288,6 +6185,7 @@ the most useful entry for its purpose. For instance, if you are attempting to print an image/gif, and you have the following entries in your mailcap file, Mutt will search for an entry with the print command: + image/*; xv %s @@ -5295,24 +6193,27 @@ image/gif; ; print= anytopnm %s | pnmtops | lpr; \ nametemplate=%s.gif + Mutt will skip the image/* entry and use the image/gif entry with the print command. -In addition, you can use this with auto_view +In addition, you can use this with auto_view to denote two commands for viewing an attachment, one to be viewed automatically, the other to be viewed interactively from the attachment menu. In addition, you can then use the test feature to determine which viewer to use interactively depending on your environment. + -text/html; netscape -remote 'openURL(%s)' ; test=RunningX +text/html; firefox -remote 'openURL(%s)' ; test=RunningX text/html; lynx %s; nametemplate=%s.html text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput -For auto_view, Mutt will choose the third + +For auto_view, Mutt will choose the third entry because of the copiousoutput tag. For interactive viewing, Mutt will run the program RunningX to determine if it should use the first entry. If the program returns non-zero, Mutt will use the second entry @@ -5321,15 +6222,17 @@ for interactive viewing. - + Command Expansion The various commands defined in the mailcap files are passed to the -/bin/sh shell using the system() function. Before the +/bin/sh shell using the system(3) function. Before the command is passed to /bin/sh -c, it is parsed to expand various special parameters with information from Mutt. The keywords Mutt expands are: + + @@ -5363,11 +6266,13 @@ mailcap definition line, ie text/html or Mutt will expand this to the value of the specified parameter from the Content-Type: line of the mail message. For instance, if Your mail message contains: + Content-Type: text/plain; charset=iso-8859-1 + then Mutt will expand %{charset} to iso-8859-1. The default metamail mailcap file uses this feature to test the charset to spawn an xterm using the right charset to view the message. @@ -5383,6 +6288,8 @@ This will be replaced by a % + + Mutt does not currently support the %F and %n keywords specified in RFC 1524. The main purpose of these parameters is for multipart messages, which is handled internally by Mutt. @@ -5392,40 +6299,37 @@ multipart messages, which is handled internally by Mutt. - -Example mailcap files + +Example Mailcap Files This mailcap file is fairly simple and standard: + - + # I'm always running X :) video/*; xanim %s > /dev/null image/*; xv %s > /dev/null -# I'm always running netscape (if my computer had more memory, maybe) -text/html; netscape -remote 'openURL(%s)' - - - +# I'm always running firefox (if my computer had more memory, maybe) +text/html; firefox -remote 'openURL(%s)' + This mailcap file shows quite a number of examples: - - - + # Use xanim to view all videos Xanim produces a header on startup, # send that to /dev/null so I don't see it video/*; xanim %s > /dev/null -# Send html to a running netscape by remote -text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape +# Send html to a running firefox by remote +text/html; firefox -remote 'openURL(%s)'; test=RunningFirefox -# If I'm not running netscape but I am running X, start netscape on the +# If I'm not running firefox but I am running X, start firefox on the # object -text/html; netscape %s; test=RunningX +text/html; firefox %s; test=RunningX # Else use lynx to view it as text text/html; lynx %s @@ -5436,7 +6340,7 @@ text/html; lynx -dump %s; copiousoutput # I use enscript to print text in two columns to a page text/*; more %s; print=enscript -2Gr %s -# Netscape adds a flag to tell itself to view jpegs internally +# Firefox adds a flag to tell itself to view jpegs internally image/jpeg;xv %s; x-mozilla-flags=internal # Use xv to view images if I'm running X @@ -5451,9 +6355,7 @@ pbmtoascii -1x2 ) 2>&1 ; copiousoutput # Send excel spreadsheets to my NT box application/ms-excel; open.pl %s - - - + @@ -5462,6 +6364,30 @@ application/ms-excel; open.pl %s MIME Autoview + +Usage: + + + +auto-view + +mimetype + + +mimetype + + +unauto-view + + +* + + +mimetype + + + + In addition to explicitly telling Mutt to view an attachment with the MIME viewer defined in the mailcap file, Mutt has support for @@ -5469,30 +6395,27 @@ automatically viewing MIME attachments while in the pager. -To work, you must define a viewer in the mailcap file which uses the +To work, you must define a viewer in the mailcap file which uses the copiousoutput option to denote that it is non-interactive. Usually, you also use the entry to convert the attachment to a text representation which you can view in the pager. -You then use the auto_view muttrc command to list the -content-types that you wish to view automatically. +You then use the auto_view .muttrc command to list the +content-types that you wish to view automatically. For instance, if you +set it to: - -For instance, if you set auto_view to: - auto_view text/html application/x-gunzip \ application/postscript image/gif application/x-tar-gz - - Mutt could use the following mailcap entries to automatically view attachments of these types. + text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html @@ -5503,12 +6426,10 @@ application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput application/postscript; ps2ascii %s; copiousoutput - - -``unauto_view'' can be used to remove previous entries from the autoview list. -This can be used with message-hook to autoview messages based on size, etc. -``unauto_view *'' will remove all previous entries. +unauto_view can be used to remove previous entries from the autoview list. +This can be used with message-hook to autoview messages based on size, etc. +unauto_view * will remove all previous entries. @@ -5518,28 +6439,27 @@ This can be used with message-hook to autoview messages based on size, etc. Mutt has some heuristics for determining which attachment of a -multipart/alternative type to display. First, mutt will check the -alternative_order list to determine if one of the available types -is preferred. The alternative_order list consists of a number of -mimetypes in order, including support for implicit and explicit -wildcards, for example: +multipart/alternative type to display. First, Mutt will check the +alternative_order list +to determine if one of the available types is preferred. It consists of +a number of mimetypes in order, including support for implicit and +explicit wildcards, for example: + alternative_order text/enriched text/plain text application/postscript image/* - - -Next, mutt will check if any of the types have a defined -auto_view, and use that. Failing -that, Mutt will look for any text type. As a last attempt, mutt will +Next, Mutt will check if any of the types have a defined +auto_view, and use that. Failing +that, Mutt will look for any text type. As a last attempt, Mutt will look for any type it knows how to handle. -To remove a MIME type from the alternative_order list, use the -unalternative_order command. +To remove a MIME type from the alternative_order list, use the +unalternative_order command. @@ -5553,11 +6473,11 @@ attachment-counting and -searching support might be for you. You can make your message index display the number of qualifying attachments in each message, or search for messages by attachment count. You also can configure what kinds of attachments qualify for this feature with the -attachments and unattachments commands. +attachments and unattachments commands. -In order to provide this information, mutt needs to fully MIME-parse +In order to provide this information, Mutt needs to fully MIME-parse all messages affected first. This can slow down operation especially for remote mail folders such as IMAP because all messages have to be downloaded first regardless whether the user really wants to view them @@ -5567,19 +6487,38 @@ or not. The syntax is: - -attachments {+|-}disposition mime-type -unattachments {+|-}disposition mime-type -attachments ? - + + +attachments + +{ + | - }disposition + + +mime-type + + +unattachments + +{ + | - }disposition + + +mime-type + + +attachments + +? + + -Disposition is the attachment's Content-disposition type -- either -"inline" or "attachment". You can abbreviate this to I or A. +disposition is the attachment's Content-Disposition type — either +inline or attachment. +You can abbreviate this to I or A. -Disposition is prefixed by either a + symbolor a - symbol. If it's +Disposition is prefixed by either a + symbol or a - symbol. If it's a +, you're saying that you want to allow this disposition and MIME type to qualify. If it's a -, you're saying that this disposition and MIME type is an exception to previous + rules. There are examples @@ -5587,21 +6526,21 @@ below of how this is useful. -Mime-type is, unsurprisingly, the MIME type of the attachment you want -to affect. A MIME type is always of the format "major/minor", where -"major" describes the broad category of document you're looking at, and -"minor" describes the specific type within that category. The major -part of mim-type must be literal text (or the special token "*"), but -the minor part may be a regular expression. (Therefore, "*/.*" matches +mime-type is, unsurprisingly, the MIME type of the attachment you want +to affect. A MIME type is always of the format major/minor, where +major describes the broad category of document you're looking at, and +minor describes the specific type within that category. The major +part of mime-type must be literal text (or the special token *), but +the minor part may be a regular expression. (Therefore, */.* matches any MIME type.) -The MIME types you give to the attachments directive are a kind of -pattern. When you use the attachments directive, the patterns you -specify are added to a list. When you use unattachments, the pattern +The MIME types you give to the attachments directive are a kind of +pattern. When you use the attachments directive, the patterns you +specify are added to a list. When you use unattachments, the pattern is removed from the list. The patterns are not expanded and matched -to specific MIME types at this time -- they're just text in a list. +to specific MIME types at this time — they're just text in a list. They're only matched when actually evaluating a message. @@ -5610,6 +6549,8 @@ Some examples might help to illustrate. The examples that are not commented out define the default configuration of the lists. + +Attachment counting ## Removing a pattern from a list removes that pattern literally. It ## does not remove any type matching the pattern. @@ -5658,10 +6599,12 @@ attachments +I text/plain attachments -A message/external-body attachments -I message/external-body + -"attachments ?" will list your current settings in Muttrc format, so -that it can be pasted elsewhere. +Entering the command attachments ? +as a command will list your current settings in Muttrc format, so that +it can be pasted elsewhere. @@ -5669,26 +6612,49 @@ that it can be pasted elsewhere. MIME Lookup + +Usage: + + + +mime-lookup + +mimetype + + +mimetype + + +unmime-lookup + + +* + + +mimetype + + + + Mutt's mime_lookup list specifies a list of mime-types that should not be treated according to their mailcap entry. This option is designed to -deal with binary types such as application/octet-stream. When an attachment's +deal with binary types such as application/octet-stream. When an attachment's mime-type is listed in mime_lookup, then the extension of the filename will -be compared to the list of extensions in the mime.types file. The mime-type +be compared to the list of extensions in the mime.types file. The mime-type associated with this extension will then be used to process the attachment according to the rules in the mailcap file and according to any other configuration -options (such as auto_view) specified. Common usage would be: +options (such as auto_view) specified. Common usage would be: + mime_lookup application/octet-stream application/X-Lotus-Manuscript - - -In addition, the unmime_lookup command may be used to disable this feature -for any particular mime-type if it had been set, for example, in a global -muttrc. +In addition, the unmime_lookup command may be +used to disable this feature for any particular mime-type if it had been +set, for example, in a global .muttrc. @@ -5696,26 +6662,26 @@ muttrc. -Optional features +Optional Features - -General notes + +General Notes - -Enabling/disabling features + +Enabling/Disabling Features Mutt supports several of optional features which can be enabled or disabled at compile-time by giving the configure script -certain arguments. These are listed in the ``Optional features'' section of +certain arguments. These are listed in the Optional features section of the configure --help output. Which features are enabled or disabled can later be determined from the output of mutt -v. If a compile option starts with -``+'' it is enabled and disabled if prefixed with ``-''. For example, if -mutt was compiled using GnuTLS for encrypted communication instead of ++ it is enabled and disabled if prefixed with -. For example, if +Mutt was compiled using GnuTLS for encrypted communication instead of OpenSSL, mutt -v would contain: @@ -5725,12 +6691,12 @@ OpenSSL, mutt -v would contain: -URL syntax +URL Syntax Mutt optionally supports the IMAP, POP3 and SMTP protocols which require to access servers using URLs. The canonical syntax for specifying URLs -in mutt is (an item enclosed in [] means it is optional and +in Mutt is (an item enclosed in [] means it is optional and may be omitted): @@ -5739,36 +6705,42 @@ proto[s]://[username[:password]@]server[:port]/[path] -proto is the communication protocol: +proto is the communication protocol: imap for IMAP, pop for POP3 and -smtp for SMTP. If ``s'' for ``secure communication'' -is appended, mutt will attempt to establish an encrypted communication -using SSL or TLS. If no explicit port is given, mutt will use the -system's default for the given protocol. +smtp for SMTP. If s for secure +communication is appended, Mutt will attempt to establish an +encrypted communication using SSL or TLS. -Since all protocols by mutt support authentication, the username may be -given directly in the URL instead of using the pop_user or -imap_user variables. A password can be given, too but -is not recommended if the URL is specified in a configuration file on -disk. +Since all protocols supported by Mutt support/require authentication, +login credentials may be specified in the URL. This has the advantage +that multiple IMAP, POP3 or SMTP servers may be specified (which isn't +possible using, for example, +$imap_user). The username +may contain the @ symbol being used by many mail systems +as part of the login name. A password can be given, too but is not +recommended if the URL is specified in a configuration file on disk. -The optional path is only relevant for IMAP. +If no port number is given, Mutt will use the system's default for the +given protocol (usually consulting /etc/services). -For IMAP for example, you can select an alternative port by specifying it with the -server: imap://imapserver:port/INBOX. You can also specify different -username for each folder: imap://username@imapserver[:port]/INBOX -or imap://username2@imapserver[:port]/path/to/folder. -Replacing imap:// by imaps:// -would make mutt attempt to conect using SSL or TLS on a different port -to encrypt the communication. +The optional path is only relevant for IMAP. + +URLs + +pops://host/ +imaps://user@host/INBOX/Sent +smtp://user@host:587/ + + + @@ -5777,13 +6749,13 @@ to encrypt the communication. SSL/TLS Support -If mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be +If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( -by running the configure script with the +by running the configure script with the --enable-ssl=... option for OpenSSL or --enable-gnutls=... for GnuTLS). Mutt can then attempt to encrypt communication with remote servers if these protocols -are suffixed with ``s'' for ``secure communication''. +are suffixed with s for secure communication. @@ -5792,7 +6764,7 @@ are suffixed with ``s'' for ``secure communication''. POP3 Support -If Mutt was compiled with POP3 support (by running the configure +If Mutt is compiled with POP3 support (by running the configure script with the --enable-pop flag), it has the ability to work with mailboxes located on a remote POP3 server and fetch mail for local browsing. @@ -5813,17 +6785,31 @@ variable, which defaults to every 60 seconds. -Another way to access your POP3 mail is the fetch-mail function +POP is read-only which doesn't allow for some features like editing +messages or changing flags. However, using + and +Mutt simulates the new/old/read flags as well as flagged and replied. +Mutt applies some logic on top of remote messages but cannot change +them so that modifications of flags are lost when +messages are downloaded from the POP server (either by Mutt or other +tools). + + + + +Another way to access your POP3 mail is the <fetch-mail> function (default: G). It allows to connect to $pop_host, fetch all your new mail and place it in the local $spoolfile. After this point, Mutt runs exactly as if the mail had always been local. + -Note: If you only need to fetch all messages to a +If you only need to fetch all messages to a local mailbox you should consider using a specialized program, such as -fetchmail, getmail or similar. +fetchmail(1), getmail(1) or similar. + @@ -5845,7 +6831,7 @@ Alternatively, a pine-compatible notation is also supported, ie -Note that not all servers use ``/'' as the hierarchy separator. Mutt should +Note that not all servers use / as the hierarchy separator. Mutt should correctly notice which separator is being used by the server and convert paths accordingly. @@ -5853,7 +6839,7 @@ paths accordingly. When browsing folders on an IMAP server, you can toggle whether to look at only the folders you are subscribed to, or all folders with the -toggle-subscribed command. See also the +toggle-subscribed command. See also the $imap_list_subscribed variable. @@ -5863,39 +6849,44 @@ want to carefully tune the $mail_check and $timeout -variables. Personally I use +variables. Reasonable values are: + set mail_check=90 set timeout=15 -with relatively good results over my slow modem line. + +with relatively good results even over slow modem lines. + Note that if you are using mbox as the mail store on UW servers prior to v12.250, the server has been reported to disconnect a client if another client selects the same folder. + - -The Folder Browser + +The IMAP Folder Browser -As of version 1.2, mutt supports browsing mailboxes on an IMAP +As of version 1.2, Mutt supports browsing mailboxes on an IMAP server. This is mostly the same as the local file browser, with the following differences: + -In lieu of file permissions, mutt displays the string "IMAP", -possibly followed by the symbol "+", indicating +In lieu of file permissions, Mutt displays the string IMAP, +possibly followed by the symbol +, indicating that the entry contains both messages and subfolders. On Cyrus-like servers folders will often contain both messages and -subfolders. +subfolders. @@ -5912,21 +6903,19 @@ the messages in that folder, you must use view-file instead You can create, delete and rename mailboxes with the -create-mailbox, delete-mailbox, and -rename-mailbox commands (default bindings: C, +<create-mailbox>, <delete-mailbox>, and +<rename-mailbox> commands (default bindings: C, d and r, respectively). You may also -subscribe and unsubscribe to mailboxes (normally +<subscribe> and <unsubscribe> to mailboxes (normally these are bound to s and u, respectively). - - - + Authentication @@ -5936,7 +6925,7 @@ NTLM authentication for you poor exchange users out there, but it has yet to be integrated into the main tree). There is also support for the pseudo-protocol ANONYMOUS, which allows you to log in to a public IMAP server without having an account. To use ANONYMOUS, simply make -your username blank or "anonymous". +your username blank or anonymous. @@ -5946,7 +6935,7 @@ method available on your host and the server. Using some of these methods (including DIGEST-MD5 and possibly GSSAPI), your entire session will be encrypted and invisible to those teeming network snoops. It is the best option if you have it. To use it, you must have the Cyrus SASL library -installed on your system and compile mutt with the --with-sasl flag. +installed on your system and compile Mutt with the --with-sasl flag. @@ -5955,7 +6944,8 @@ in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN. -There are a few variables which control authentication: +There are a few variables which control authentication: + @@ -5981,15 +6971,13 @@ a password is needed. $imap_authenticators - a colon-delimited list of IMAP authentication methods to try, in the order you wish to try them. If -specified, this overrides mutt's default (attempt everything, in the order +specified, this overrides Mutt's default (attempt everything, in the order listed above). - - @@ -5999,15 +6987,15 @@ listed above). Besides supporting traditional mail delivery through a -sendmail-compatible program, mutt supports delivery through SMTP if it +sendmail-compatible program, Mutt supports delivery through SMTP if it was configured and built with --enable-smtp. -If the configuration variable -$smtp_url is set, mutt -will contact the given SMTP server to deliver messages; if it is unset, -mutt will use the program specified by $sendmail. +If the configuration variable +$smtp_url is set, Mutt +will contact the given SMTP server to deliver messages; if it is unset, +Mutt will use the program specified by $sendmail. @@ -6018,30 +7006,47 @@ For details on the URL syntax, please see . The built-in SMTP support supports encryption (the smtps protocol using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms for SASL are specified in $smtp_authenticators -defaulting to an empty list which makes mutt try all available methods +defaulting to an empty list which makes Mutt try all available methods from most-secure to least-secure. -Managing multiple accounts +Managing Multiple Accounts + + +Usage: + + + +account-hook + +pattern + + +command + + If you happen to have accounts on multiple IMAP, POP and/or SMTP servers, you may find managing all the authentication settings inconvenient and -error-prone. The account-hook command may help. This hook works like -folder-hook but is invoked whenever you access a remote mailbox +error-prone. The account-hook command may help. This hook works like +folder-hook but is invoked whenever Mutt needs to access a remote mailbox (including inside the folder browser), not just when you open the -mailbox. +mailbox. This includes (for example) polling for new mail, storing Fcc +messages and saving messages to a folder. As a consequence, +account-hook should only be used to set connection-related settings such +as passwords or tunnel commands but not settings such as sender +address or name (because in general it should be considered unpredictable +which account-hook was last used). Some examples: - - account-hook . 'unset imap_user; unset imap_pass; unset tunnel' account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo' @@ -6049,27 +7054,64 @@ account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"' account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"' + +To manage multiple accounts with, for example, different values of +$record or sender addresses, +folder-hook +has to be be used together with +the mailboxes command. + + + +Managing multiple accounts + +mailboxes imap://user@host1/INBOX +folder-hook imap://user@host1/ 'set folder=imap://host1/ ; set record=+INBOX/Sent' + +mailboxes imap://user@host2/INBOX +folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sent' + + + + +In example + the folders are defined using +mailboxes so Mutt polls them for new +mail. Each folder-hook triggers when +one mailbox below each IMAP account is opened and sets +$folder to the account's root +folder. Next, it sets $record to +the INBOX/Sent folder below the newly +set $folder. Please notice that the +value the + +mailbox shortcut refers to depends on +the current value +of $folder and therefore has to be set +separatedly per account. Setting other values +like $from +or $signature is analogous to setting +$record. -Local caching +Local Caching Mutt contains two types of local caching: (1) -the so-called ``header caching'' and (2) the -so-called ``body caching'' which are both described in this section. +the so-called header caching and (2) the +so-called body caching which are both described in this section. Header caching is optional as it depends on external libraries, body -caching is always enabled if mutt is compiled with POP and/or IMAP +caching is always enabled if Mutt is compiled with POP and/or IMAP support as these use it (body caching requires no external library). -Header caching +Header Caching Mutt provides optional support for caching message headers for the @@ -6084,7 +7126,7 @@ thousands of single files (since Maildir and MH use one file per message.) Header caching can be enabled via the configure script and the --enable-hcache option. It's not turned on by default because external database libraries are required: one -of qdbm, gdbm or bdb must be present. +of tokyocabinet, qdbm, gdbm or bdb must be present. @@ -6096,40 +7138,20 @@ result in lower performance), but one file per folder if it points to a directory. - -For the one-file-per-folder case, database files for remote folders -will be named according to their URL while database files for local -folders will be named by the MD5 checksums of their path. These database -files may be safely removed if a system is short on space. You -can compute the name of the header cache file for a particular local folder -through a command like the following: - + + + +Body Caching - -$ printf '%s' '/path/to/folder' | md5sum - - - - -The md5sum command may also be -named md5, depending on your operating system. - - - - - -Body caching - - -Both cache methods can be combined using the same directory for storage -(and for IMAP/POP even provide meaningful file names) which simplifies -manual maintenance tasks. +Both cache methods can be combined using the same directory for storage +(and for IMAP/POP even provide meaningful file names) which simplifies +manual maintenance tasks. -In addition to caching message headers only, mutt can also cache +In addition to caching message headers only, Mutt can also cache whole message bodies. This results in faster display of messages for POP and IMAP folders because messages usually have to be downloaded only once. @@ -6138,17 +7160,12 @@ downloaded only once. For configuration, the variable $message_cachedir must point to a -directory. There, mutt will create a hierarchy of subdirectories +directory. There, Mutt will create a hierarchy of subdirectories named like: proto:user@hostname where -proto is either ``pop'' or ``imap.'' Within -there for each folder, mutt stores messages in single files (just -like Maildir) so that with manual symlink creation these cache -directories can be examined with mutt as read-only Maildir folders. - - - +proto is either pop or imap. Within +there for each folder, Mutt stores messages in single files. All files can be removed as needed if the consumed disk space -becomes an issue as mutt will silently fetch missing items again. +becomes an issue as Mutt will silently fetch missing items again. @@ -6164,12 +7181,12 @@ disk space freed by removing messages is re-used. -For body caches, mutt can keep the local cache in sync with the +For body caches, Mutt can keep the local cache in sync with the remote mailbox if the $message_cache_clean variable is set. Cleaning means to remove messages from the cache which are no longer present in the mailbox which only happens when other mail -clients or instances of mutt using a different body cache location +clients or instances of Mutt using a different body cache location delete messages (Mutt itself removes deleted messages from the cache when syncing a mailbox). As cleaning can take a noticeable amount of time, it should not be set in general but only occasionally. @@ -6180,11 +7197,11 @@ it should not be set in general but only occasionally. -Exact address generation +Exact Address Generation -Mutt supports the ``Name <user@host>'' address syntax for reading and -writing messages, the older ``user@host (Name)'' syntax is only supported when +Mutt supports the Name <user@host> address syntax for reading and +writing messages, the older user@host (Name) syntax is only supported when reading messages. The --enable-exact-address switch can be given to configure to build it with write-support for the latter syntax. EXACT_ADDRESS in the output of @@ -6193,33 +7210,210 @@ for the latter syntax. EXACT_ADDRESS in the output of + +Sending Anonymous Messages via Mixmaster + + +You may also have compiled Mutt to co-operate with Mixmaster, an +anonymous remailer. Mixmaster permits you to send your messages +anonymously using a chain of remailers. Mixmaster support in Mutt is for +mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03. +It does not support earlier versions or the later so-called version 3 betas, +of which the latest appears to be called 2.9b23. + + + +To use it, you'll have to obey certain restrictions. Most +important, you cannot use the Cc and Bcc headers. To tell +Mutt to use mixmaster, you have to select a remailer chain, using +the mix function on the compose menu. + + + +The chain selection screen is divided into two parts. In the +(larger) upper part, you get a list of remailers you may use. In +the lower part, you see the currently selected chain of remailers. + + + +You can navigate in the chain using the <chain-prev> and +<chain-next> functions, which are by default bound to the left +and right arrows and to the h and l keys (think vi +keyboard bindings). To insert a remailer at the current chain +position, use the <insert> function. To append a remailer behind +the current chain position, use <select-entry> or <append>. +You can also delete entries from the chain, using the corresponding +function. Finally, to abandon your changes, leave the menu, or +<accept> them pressing (by default) the Return key. + + + +Note that different remailers do have different capabilities, +indicated in the %c entry of the remailer menu lines (see +$mix_entry_format). Most important is +the middleman capability, indicated by a capital M: This +means that the remailer in question cannot be used as the final +element of a chain, but will only forward messages to other +mixmaster remailers. For details on the other capabilities, please +have a look at the mixmaster documentation. + + + + + +Security Considerations + + +First of all, Mutt contains no security holes included by intention but +may contain unknown security holes. As a consequence, please run Mutt +only with as few permissions as possible. Especially, do not run Mutt as +the super user. + + + +When configuring Mutt, there're some points to note about secure setups +so please read this chapter carefully. + + + +Passwords + + +Although Mutt can be told the various passwords for accounts, please +never store passwords in configuration files. Besides the fact that the +system's operator can always read them, you could forget to mask it out +when reporting a bug or asking for help via a mailing list. Even worse, +your mail including your password could be archived by internet search +engines, mail-to-news gateways etc. It may already be too late before +you notice your mistake. + + + + + +Temporary Files + + +Mutt uses many temporary files for viewing messages, verifying digital +signatures, etc. As long as being used, these files are visible by other +users and maybe even readable in case of misconfiguration. Also, a +different location for these files may be desired which can be changed +via the $tmpdir variable. + + + + + +Information Leaks + + +Message-Id: headers + + +Message-Id: headers contain a local part that is to be created in a +unique fashion. In order to do so, Mutt will leak some +information to the outside world when sending messages: the generation +of this header includes a step counter which is increased (and rotated) +with every message sent. In a longer running mutt session, others can +make assumptions about your mailing habbits depending on the number of +messages sent. If this is not desired, the header can be manually +provided using $edit_headers (though not +recommended). + + + + + +<literal>mailto:</literal>-style Links + + +As Mutt be can be set up to be the mail client to handle +mailto: style links in websites, there're security +considerations, too. Arbitrary header fields can be embedded in these +links which could override existing header fields or attach arbitrary +files using the Attach: +psuedoheader. This may be problematic if the $edit-headers variable is +unset, i.e. the user doesn't want to see header +fields while editing the message and doesn't pay enough attention to the +compose menu's listing of attachments. + + + +For example, following a link like + + + +mailto:joe@host?Attach=~/.gnupg/secring.gpg + + +will send out the user's private gnupg keyring to +joe@host if the user doesn't follow the information +on screen carefully enough. + + + + + + + +External Applications + + +Mutt in many places has to rely on external applications or for +convenience supports mechanisms involving external applications. + + + +One of these is the mailcap mechanism as defined by +RfC1524. Details about a secure use of the mailcap mechanisms is given +in . + + + +Besides the mailcap mechanism, Mutt uses a number of other external +utilities for operation, for example to provide crypto support, in +backtick expansion in configuration files or format string filters. The +same security considerations apply for these as for tools involved via +mailcap. + + + + + + + -Performance tuning +Performance Tuning -Reading and writing mailboxes +Reading and Writing Mailboxes Mutt's performance when reading mailboxes can be improved in two ways: - - + + + For remote folders (IMAP and POP) as well as folders using -one-file-per message storage (Maildir and MH), mutt's +one-file-per message storage (Maildir and MH), Mutt's performance can be greatly improved using header caching. -Using a single database per folder may further increase -performance. - - +using a single database per folder. + + + + + Mutt provides the $read_inc and $write_inc variables to specify at which rate to update progress -counters. If these values are too low, mutt may spend more +counters. If these values are too low, Mutt may spend more time on updating the progress counter than it spends on actually reading/writing folders. @@ -6228,7 +7422,8 @@ For example, when opening a maildir folder with a few thousand messages, the default value for $read_inc may be too low. It can be tuned on on a folder-basis using -folder-hooks: +folder-hooks: + # use very high $read_inc to speed up reading hcache'd maildirs @@ -6237,10 +7432,9 @@ folder-hook . 'set read_inc=1000' folder-hook ^imap 'set read_inc=100' # use even lower value for reading even slower remote POP folders folder-hook ^pop 'set read_inc=1' - + - These settings work on a per-message basis. However, as messages may greatly differ in size and certain operations are much faster than others, @@ -6253,36 +7447,36 @@ actually send to the terminal using the -Reading messages from remote folders +Reading Messages from Remote Folders Reading messages from remote folders such as IMAP an POP can be -slow especially for large mailboxes since mutt only caches a very +slow especially for large mailboxes since Mutt only caches a very limited number of recently viewed messages (usually 10) per session (so that it will be gone for the next session.) To improve performance and permanently cache whole messages, -please refer to mutt's so-called +please refer to Mutt's so-called body caching for details. -Searching and limiting +Searching and Limiting When searching mailboxes either via a search or a limit action, for -some patterns mutt distinguishes between regular expression and string +some patterns Mutt distinguishes between regular expression and string searches. For regular expressions, patterns are prefixed with -``˜'' and with ``='' for string searches. +˜ and with = for string searches. Even though a regular expression search is fast, it's several times -slower than a pure string search which is noticable especially on large +slower than a pure string search which is noticeable especially on large folders. As a consequence, a string search should be used instead of a regular expression search if the user already knows enough about the search pattern. @@ -6297,9 +7491,9 @@ message bodies since a larger amount of input has to be searched. -Please note that string search is an exact case-sensitive search -while a regular expression search with only lower-case letters performs -a case-insensitive search. +As for regular expressions, a lower case string search pattern makes +Mutt perform a case-insensitive search except for IMAP (because for IMAP +Mutt performs server-side searches which don't support case-insensivity). @@ -6310,7 +7504,7 @@ a case-insensitive search. Reference -Command line options +Command-Line Options Running mutt with no arguments will make Mutt attempt to read your spool @@ -6318,9 +7512,7 @@ mailbox. However, it is possible to read other mailboxes and to send messages from the command line as well. - - -
+
Command line options @@ -6331,7 +7523,7 @@ to send messages from the command line as well. -aattach a file to a message-bspecify a blind carbon-copy (BCC) address-cspecify a carbon-copy (Cc) address --Dprint the value of all mutt variables to stdout +-Dprint the value of all Mutt variables to stdout-especify a config command to be run after initialization files are read-fspecify a mailbox to load-Fspecify an alternate file to read initialization commands @@ -6346,384 +7538,891 @@ to send messages from the command line as well. -sspecify a subject (enclose in quotes if it contains spaces)-vshow version number and compile-time definitions-xsimulate the mailx(1) compose mode --yshow a menu containing the files specified by the mailboxes command +-yshow a menu containing the files specified by the mailboxes command-zexit immediately if there are no messages in the mailbox --Zopen the first folder with new message,exit immediately if none +-Zopen the first folder with new message, exit immediately if none
- - To read messages in a mailbox - -mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ] - + +mutt + + +muttrc + + +type + + +mailbox + + To compose a new message - -mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s subject ] -[ [ file ... ] -- ] address [ address ... ] - - - -Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect + +mutt + + +muttrc + + +address + + +filename + + +subject + + + +file + +-- + + +address + + + + +Mutt also supports a batch mode to send prepared messages. Simply redirect input from the file you wish to send. For example, - -mutt -s "data set for run #2" professor@bigschool.edu -< ˜/run2.dat - - - -This command will send a message to ``professor@bigschool.edu'' with a subject -of ``data set for run #2''. In the body of the message will be the contents -of the file ``˜/run2.dat''. - - - -All files passed with -a file will be attached as a MIME -part to the message. To attach several files, use ``--'' to separate files and -recipient addresses: mutt -a *.png -- some@one.org - - - - - -Configuration Commands - - -The following are the commands understood by mutt. - - - - - - - - -account-hook pattern command - - - - - -alias [ -group name [ ... ] ] key address [ , address, ... ] - - - - - -unalias [ * | key ... ] - - - - - -alternates [ -group name [ ... ] ] regexp [ regexp ... ] - - - - - -unalternates [ * | regexp ... ] - - - - - -alternative-order mimetype [ mimetype ... ] - - - - - -unalternative-order mimetype [ mimetype ... ] - - - - - -auto_view mimetype [ mimetype ... ] - - - - - -unauto_view mimetype [ mimetype ... ] - - - - - -bind map key function - - - - - -charset-hook alias charset - - - - - -iconv-hook charset local-charset - - - - - -color object foreground background [ regexp ] - - - - - -uncolor index pattern [ pattern ... ] - - - - - -exec function [ function ... ] - - - - - -fcc-hook pattern mailbox - - - - - -fcc-save-hook pattern mailbox - - - - - -folder-hook pattern command - - - - - -hdr_order header [ header ... ] - - - - - -unhdr_order header [ header ... ] - - - - - -ignore pattern [ pattern ... ] - - - - - -unignore pattern [ pattern ... ] - - - - - -lists [ -group name [ ... ] ] regexp [ regexp ... ] - - - - - -unlists regexp [ regexp ... ] - - - - - -macro menu key sequence [ description ] - - - - - -mailboxes filename [ filename ... ] - - - - - -mbox-hook pattern mailbox - - - - - -message-hook pattern command - - - - - -mime_lookup mimetype [ mimetype ... ] - - - - - -unmime_lookup mimetype [ mimetype ... ] - - - - - -mono object attribute [ regexp ] - - - - - -unmono index pattern [ pattern ... ] - - - - - -my_hdr string - - - - - -unmy_hdr field [ field ... ] - - - - - -crypt-hook pattern key-id - - - - - -push string - - - - - -reset variable [variable ... ] - - - - - -save-hook regexp filename - - - - - -score pattern value - - - + +mutt -s "data set for run #2" professor@bigschool.edu < ˜/run2.dat -unscore pattern [ pattern ... ] +will send a message to <professor@bigschool.edu> with a subject +of data set for run #2. In the body of the message will be the contents +of the file ˜/run2.dat. - - -reply-hook pattern command +All files passed with -a file will be attached as a MIME +part to the message. To attach a single or several files, use -- to separate files and +recipient addresses: - - - -send-hook pattern command - - - - - -send2-hook pattern command - - - + +mutt -a image.png -- some@one.org -set [no|inv]variable[=value] [ variable ... ] +or - - - -unset variable [variable ... ] - - - + +mutt -a *.png -- some@one.org + -source filename +The -a option must be last in the option list. - - + - -spam pattern format - - - + - -nospam pattern - - - + +Configuration Commands -subscribe [ -group name [ ... ] ] regexp [ regexp ... ] +The following are the commands understood by Mutt: - - - -unsubscribe regexp [ regexp ... ] - - - + - -toggle variable [variable ... ] - - - - -unhook hook-type - + +account-hook + +pattern +command + + + + + + +alias + + +name + + +key + + +address + + +address + + +unalias + + +name + + + +* + + +key + + + + + + + +alternates + + +name + + +regexp + + +regexp + + +unalternates + + +name + + + +* + + +regexp + + + + + + + +alternative-order + +mimetype + + +mimetype + + +unalternative-order + + +* + + +mimetype + + + + + + + +attachments + +{ + | - }disposition + + +mime-type + + +unattachments + +{ + | - }disposition + + +mime-type + + + + + + +auto-view + +mimetype + + +mimetype + + +unauto-view + + +* + + +mimetype + + + + + + + +bind + +map + + +key + + +function + + + + + + +charset-hook + +alias + + +charset + + + + + + +iconv-hook + +charset + + +local-charset + + + + + + +color + +object + + +foreground + + +background + + +color + + + + + + + + + +foreground + + +background + + +regexp + + +color + + + + +foreground + + +background + + +pattern + + +uncolor + + + + + + + + + + + + + +* + + +pattern + + + + + + + +crypt-hook + +pattern + + +keyid + + + + + + +exec + +function + + +function + + + + + + +fcc-hook + +[!]pattern + + +mailbox + + + + + + +fcc-save-hook + +[!]pattern + + +mailbox + + + + + + +folder-hook + +[!]regexp + + +command + + + + + + +group + + +name + + + + +expr + + + +expr + + + +ungroup + + +name + + + +* + + + +expr + + + +expr + + + + + + + +hdr_order + +header + + +header + + +unhdr_order + + +* + + +header + + + + + + + +ignore + +pattern + + +pattern + + +unignore + + +* + + +pattern + + + + + + + +lists + + +name + + +regexp + + +regexp + + +unlists + + +name + + + +* + + +regexp + + + + + + + +macro + +menu + + +key + + +sequence + + +description + + + + + + +mailboxes + +mailbox + + +mailbox + + +unmailboxes + + +* + + +mailbox + + + + + + + +mbox-hook + +[!]pattern + + +mailbox + + + + + + +message-hook + +[!]pattern + + +command + + + + + + +mime-lookup + +mimetype + + +mimetype + + +unmime-lookup + + +* + + +mimetype + + + + + + + +mono + +object + + +attribute + + +mono + + + + + + + + + +attribute + + +regexp + + +mono + + + + +attribute + + +pattern + + +unmono + + + + + + + + + + + + + +* + + +pattern + + + + + + + +my_hdr + +string + + +unmy_hdr + + +* + + +field + + + + + + + +push + +string + + + + + + +save-hook + +[!]pattern + + +mailbox + + + + + + +score + +pattern + + +value + + +unscore + + +* + + +pattern + + + + + + + +reply-hook + +[!]pattern + + +command + + + + + + +send-hook + +[!]pattern + + +command + + + + + + +send2-hook + +[!]pattern + + +command + + + + + + +set + + + + + + +variable + + +variable=value + + + + +toggle + +variable + + +variable + + +unset + +variable + + +variable + + +reset + +variable + + +variable + + + + + + +source + +filename + + + + + + +spam + +pattern + + +format + + +nospam + + +* + + +pattern + + + + + + + +subscribe + + +name + + +regexp + + +regexp + + +unsubscribe + + +name + + + +* + + +regexp + + + + + + + +unhook + + +* + + +hook-type + + + - - -Configuration variables +Configuration Variables