X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=doc%2Fmanual.txt;h=9e59608d27c52afdce8c30e588365a65496a1f30;hp=c1f451e00dd80218a13845f0ed56bac4d7ee0c4b;hb=7132fe3b1612c153f3638d1f9664ba9eab9063d6;hpb=e4ebc9b0ae5de07d53d8b0ecf594244e1bc44d0a diff --git a/doc/manual.txt b/doc/manual.txt index c1f451e..9e59608 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -4,7 +4,7 @@ by Andreas Krennmair and others originally based on _m_u_t_t by Michael Elkins and others - version devel-r446 + version devel-r471 AAbbssttrraacctt @@ -316,7 +316,7 @@ ^G n/a abort n/a finish editing - You can remap the _e_d_i_t_o_r functions using the _b_i_n_d (section 3.5 , page 25) com- + You can remap the _e_d_i_t_o_r functions using the _b_i_n_d (section 3.5 , page 27) com- mand. For example, to make the _D_e_l_e_t_e key delete the character in front of the cursor rather than under, you could use @@ -413,7 +413,7 @@ +o cclleeaarr--ffllaagg (default: W) Furthermore, the following flags reflect who the message is addressed to. They - can be customized with the _$_t_o___c_h_a_r_s (section 7.4.328 , page 168) variable. + can be customized with the _$_t_o___c_h_a_r_s (section 7.4.339 , page 172) variable. + message is to you and you only @@ -461,7 +461,7 @@ letter again for bold or the letter, backspace, ``_'' for denoting underline. Mutt-ng will attempt to display these in bold and underline respectively if your terminal supports them. If not, you can use the bold and underline _c_o_l_o_r - (section 3.9 , page 29) objects to specify a color or mono attribute for them. + (section 3.9 , page 31) objects to specify a color or mono attribute for them. Additionally, the internal pager supports the ANSI escape sequences for charac- ter attributes. Mutt-ng translates them into the correct color and character @@ -490,14 +490,14 @@ The Mutt Next Generation E-Mail Client 11 Mutt-ng uses these attributes for handling text/enriched messages, and they can - also be used by an external _a_u_t_o_v_i_e_w (section 5.4 , page 77) script for high- + also be used by an external _a_u_t_o_v_i_e_w (section 5.4 , page 79) script for high- lighting purposes. NNoottee:: If you change the colors for your display, for exam- ple by changing the color associated with color2 for your xterm, then that color will be used instead of green. _2_._5_._3 _T_h_r_e_a_d_e_d _M_o_d_e - When the mailbox is _s_o_r_t_e_d (section 7.4.296 , page 158) by _t_h_r_e_a_d_s, there are + When the mailbox is _s_o_r_t_e_d (section 7.4.307 , page 163) by _t_h_r_e_a_d_s, there are a few additional functions available in the _i_n_d_e_x and _p_a_g_e_r modes. ^D delete-thread delete all messages in the current thread @@ -518,11 +518,11 @@ NNoottee:: 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 _$_i_n_d_e_x___f_o_r_m_a_t (sec- - tion 7.4.114 , page 114). For example, you could use "%?M?(#%03M)&(%4l)?" in - _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.114 , page 114) to optionally display the number of + tion 7.4.116 , page 116). For example, you could use "%?M?(#%03M)&(%4l)?" in + _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.116 , page 116) to optionally display the number of hidden messages if the thread is collapsed. - See also: _$_s_t_r_i_c_t___t_h_r_e_a_d_s (section 7.4.317 , page 166). + See also: _$_s_t_r_i_c_t___t_h_r_e_a_d_s (section 7.4.328 , page 170). _2_._5_._4 _M_i_s_c_e_l_l_a_n_e_o_u_s _F_u_n_c_t_i_o_n_s @@ -530,11 +530,11 @@ (default: a) Creates a new alias based upon the current message (or prompts for a new one). - Once editing is complete, an _a_l_i_a_s (section 3.4 , page 24) command is added to - the file specified by the _$_a_l_i_a_s___f_i_l_e (section 7.4.5 , page 88) variable for - future use. NNoottee:: Specifying an _$_a_l_i_a_s___f_i_l_e (section 7.4.5 , page 88) does not + Once editing is complete, an _a_l_i_a_s (section 3.4 , page 26) command is added to + the file specified by the _$_a_l_i_a_s___f_i_l_e (section 7.4.5 , page 90) variable for + future use. NNoottee:: Specifying an _$_a_l_i_a_s___f_i_l_e (section 7.4.5 , page 90) does not add the aliases specified there-in, you must also _s_o_u_r_c_e (section 3.29 , page - 44) the file. + 46) the file. cchheecckk--ttrraaddiittiioonnaall--ppggpp (default: ESC P) @@ -552,7 +552,7 @@ (default: h) Toggles the weeding of message header fields specified by _i_g_n_o_r_e (section - 3.10 , page 31) commands. + 3.10 , page 33) commands. eeddiitt (default: e) @@ -570,12 +570,12 @@ This command is used to temporarily edit an attachment's content type to fix, for instance, bogus character set parameters. When invoked from the index or from the pager, you'll have the opportunity to edit the top-level attachment's - content type. On the _a_t_t_a_c_h_m_e_n_t _m_e_n_u (section 5.1.2 , page 69), you can + content type. On the _a_t_t_a_c_h_m_e_n_t _m_e_n_u (section 5.1.2 , page 71), you can change any attachment's content type. These changes are not persistent, and get lost upon changing folders. Note that this command is also available on the _c_o_m_p_o_s_e _m_e_n_u (section 5.1.3 , - page 70). There, it's used to fine-tune the properties of attachments you are + page 72). There, it's used to fine-tune the properties of attachments you are going to send. eenntteerr--ccoommmmaanndd @@ -583,7 +583,7 @@ This command is used to execute any command you would normally put in a config- uration file. A common use is to check the settings of variables, or in con- - junction with _m_a_c_r_o_s (section 3.8 , page 28) to change settings on the fly. + junction with _m_a_c_r_o_s (section 3.8 , page 30) to change settings on the fly. eexxttrraacctt--kkeeyyss (default: ^K) @@ -604,8 +604,8 @@ Reply to the current or tagged message(s) by extracting any addresses which match the regular expressions given by the _l_i_s_t_s _o_r _s_u_b_s_c_r_i_b_e (section 3.13 , - page 34) commands, but also honor any Mail-Followup-To header(s) if the - _$_h_o_n_o_r___f_o_l_l_o_w_u_p___t_o (section 7.4.92 , page 109) configuration variable is set. + page 36) commands, but also honor any Mail-Followup-To header(s) if the + _$_h_o_n_o_r___f_o_l_l_o_w_u_p___t_o (section 7.4.94 , page 111) configuration variable is set. Using this when replying to messages posted to mailing lists helps avoid dupli- cate copies being sent to the author of the message you are replying to. @@ -613,9 +613,9 @@ (default: |) Asks for an external Unix command and pipes the current or tagged message(s) to - it. The variables _$_p_i_p_e___d_e_c_o_d_e (section 7.4.205 , page 138), _$_p_i_p_e___s_p_l_i_t - (section 7.4.207 , page 138), _$_p_i_p_e___s_e_p (section 7.4.206 , page 138) and - _$_w_a_i_t___k_e_y (section 7.4.339 , page 170) control the exact behavior of this + it. The variables _$_p_i_p_e___d_e_c_o_d_e (section 7.4.216 , page 142), _$_p_i_p_e___s_p_l_i_t + (section 7.4.218 , page 142), _$_p_i_p_e___s_e_p (section 7.4.217 , page 142) and + _$_w_a_i_t___k_e_y (section 7.4.350 , page 174) control the exact behavior of this function. rreesseenndd--mmeessssaaggee @@ -625,7 +625,7 @@ message. This function is best described as "recall from arbitrary folders". It can conveniently be used to forward MIME messages while preserving the orig- inal mail structure. Note that the amount of headers included here depends on - the value of the _$_w_e_e_d (section 7.4.340 , page 171) variable. + the value of the _$_w_e_e_d (section 7.4.351 , page 175) 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 mes- @@ -635,14 +635,14 @@ (default: !) Asks for an external Unix command and executes it. The _$_w_a_i_t___k_e_y (section - 7.4.339 , page 170) can be used to control whether Mutt-ng will wait for a key + 7.4.350 , page 174) can be used to control whether Mutt-ng 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. ttooggggllee--qquuootteedd (default: T) - The _p_a_g_e_r uses the _$_q_u_o_t_e___r_e_g_e_x_p (section 7.4.230 , page 143) variable to + The _p_a_g_e_r uses the _$_q_u_o_t_e___r_e_g_e_x_p (section 7.4.241 , page 147) variable to detect quoted text when displaying the body of the message. This function tog- gles 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 @@ -755,7 +755,7 @@ sages from. You can now tag messages in that folder and they will be attached to the message you are sending. Note that certain operations like composing a new mail, replying, forwarding, etc. are not permitted when you are in that - folder. The %r in _$_s_t_a_t_u_s___f_o_r_m_a_t (section 7.4.313 , page 163) will change to a + folder. The %r in _$_s_t_a_t_u_s___f_o_r_m_a_t (section 7.4.324 , page 167) will change to a 'A' to indicate that you are in attach-message mode. The Mutt Next Generation E-Mail Client 16 @@ -863,7 +863,7 @@ field, Mutt-ng will not generate a _R_e_f_e_r_e_n_c_e_s_: field, which allows you to cre- ate a new message thread. - Also see _e_d_i_t___h_e_a_d_e_r_s (section 7.4.58 , page 101). + Also see _e_d_i_t___h_e_a_d_e_r_s (section 7.4.59 , page 103). _2_._6_._4 _U_s_i_n_g _M_u_t_t_-_n_g _w_i_t_h _P_G_P @@ -872,7 +872,7 @@ Pgp: [ E | S | S_<_i_d_> ] ``E'' encrypts, ``S'' signs and ``S'' signs with the given key, setting - _$_p_g_p___s_i_g_n___a_s (section 7.4.197 , page 136) permanently. + _$_p_g_p___s_i_g_n___a_s (section 7.4.208 , page 140) permanently. If you have told mutt to PGP encrypt a message, it will guide you through a key selection process when you try to send the message. Mutt-ng will not ask you @@ -890,7 +890,7 @@ encrypted using the selected public keys, and sent out. Most fields of the entries in the key selection menu (see also _$_p_g_p___e_n_t_r_y___f_o_r_- - _m_a_t (section 7.4.184 , page 133)) have obvious meanings. But some explana- + _m_a_t (section 7.4.195 , page 137)) have obvious meanings. But some explana- tions on the capabilities, flags, and validity fields are in order. The flags sequence (%f) will expand to one of the following flags: @@ -947,8 +947,8 @@ 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 _$_m_i_x___e_n_t_r_y___f_o_r_m_a_t (section 7.4.144 , - page 122)). Most important is the ``middleman'' capability, indicated by a + %c entry of the remailer menu lines (see _$_m_i_x___e_n_t_r_y___f_o_r_m_a_t (section 7.4.146 , + page 125)). 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 @@ -1001,7 +1001,7 @@ At times it is desirable to delay sending a message that you have already begun to compose. When the _p_o_s_t_p_o_n_e_-_m_e_s_s_a_g_e function is used in the _c_o_m_p_o_s_e menu, the body of your message and attachments are stored in the mailbox specified by - the _$_p_o_s_t_p_o_n_e_d (section 7.4.219 , page 141) variable. This means that you can + the _$_p_o_s_t_p_o_n_e_d (section 7.4.230 , page 145) variable. This means that you can recall the message even if you exit Mutt-ng and then restart it at a later time. @@ -1019,7 +1019,7 @@ be in the same folder with the message you replied to for the status of the message to be updated. - See also the _$_p_o_s_t_p_o_n_e (section 7.4.218 , page 141) quad-option. + See also the _$_p_o_s_t_p_o_n_e (section 7.4.229 , page 145) quad-option. _3_. _C_o_n_f_i_g_u_r_a_t_i_o_n @@ -1029,7 +1029,7 @@ out of the box, it is often desirable to tailor Mutt-ng to suit your own tastes. When Mutt-ng is first invoked, it will attempt to read the ``system'' configuration file (defaults set by your local system administrator), unless - the ``-n'' _c_o_m_m_a_n_d _l_i_n_e (section 7.1 , page 81) option is specified. This + the ``-n'' _c_o_m_m_a_n_d _l_i_n_e (section 7.1 , page 83) option is specified. This file is typically /usr/local/share/muttng/Muttngrc or /etc/Muttngrc, Mutt-ng users will find this file in /usr/local/share/muttng/Muttrc or /etc/Muttngrc. Mutt will next look for a file named .muttrc in your home directory, Mutt-ng @@ -1037,12 +1037,12 @@ has a subdirectory named .mutt, mutt try to load a file named .muttng/muttngrc. .muttrc (or .muttngrc for Mutt-ng) is the file where you will usually place - your _c_o_m_m_a_n_d_s (section 7.3 , page 84) to configure Mutt-ng. + your _c_o_m_m_a_n_d_s (section 7.3 , page 86) to configure Mutt-ng. _3_._2 _B_a_s_i_c _S_y_n_t_a_x _o_f _I_n_i_t_i_a_l_i_z_a_t_i_o_n _F_i_l_e_s An initialization file consists of a series of _c_o_m_m_a_n_d_s (section 7.3 , page - 84). Each line of the file may contain one or more commands. When multiple + 86). Each line of the file may contain one or more commands. When multiple commands are used, they must be separated by a semicolon (;). set realname='Mutt-ng user' ; ignore x- @@ -1103,11 +1103,14 @@ interpreted again. The commands understood by mutt are explained in the next paragraphs. For a - complete list, see the _c_o_m_m_a_n_d _r_e_f_e_r_e_n_c_e (section 7.3 , page 84). + complete list, see the _c_o_m_m_a_n_d _r_e_f_e_r_e_n_c_e (section 7.3 , page 86). The Mutt Next Generation E-Mail Client 23 - _3_._3 _V_a_r_i_a_b_l_e _E_x_p_a_n_s_i_o_n + _3_._3 _E_x_p_a_n_s_i_o_n _w_i_t_h_i_n _v_a_r_i_a_b_l_e_s + + Besides just assign static content to variables, there's plenty of ways of + adding external and more or less dynamic content. _3_._3_._1 _C_o_m_m_a_n_d_s_' _O_u_t_p_u_t @@ -1128,7 +1131,7 @@ set record=+sent_on_$HOSTNAME - sets the _$_r_e_c_o_r_d (section 7.4.235 , page 144) variable to the string _+_s_e_n_t___o_n__ + sets the _$_r_e_c_o_r_d (section 7.4.246 , page 148) variable to the string _+_s_e_n_t___o_n__ and appends the value of the evironment variable $HOSTNAME. NNoottee:: There will be no warning if an environment variable is not defined. The @@ -1141,47 +1144,131 @@ set imap_home_namespace = $folder - would set the value of _$_i_m_a_p___h_o_m_e___n_a_m_e_s_p_a_c_e (section 7.4.99 , page 110) to the - value to which _$_f_o_l_d_e_r (section 7.4.68 , page 103) is _c_u_r_r_e_n_t_l_y set to. + would set the value of _$_i_m_a_p___h_o_m_e___n_a_m_e_s_p_a_c_e (section 7.4.101 , page 113) to + the value to which _$_f_o_l_d_e_r (section 7.4.70 , page 105) is _c_u_r_r_e_n_t_l_y set to. NNoottee:: There're no logical links established in such cases so that the the value - for _$_i_m_a_p___h_o_m_e___n_a_m_e_s_p_a_c_e (section 7.4.99 , page 110) won't change even if - _$_f_o_l_d_e_r (section 7.4.68 , page 103) gets changed. + for _$_i_m_a_p___h_o_m_e___n_a_m_e_s_p_a_c_e (section 7.4.101 , page 113) won't change even if + _$_f_o_l_d_e_r (section 7.4.70 , page 105) gets changed. NNoottee:: There will be no warning if a configuration variable is not defined or is empty. The result will of the expansion will then be empty. + The Mutt Next Generation E-Mail Client 24 + _3_._3_._4 _S_e_l_f_-_D_e_f_i_n_e_d _V_a_r_i_a_b_l_e_s Mutt-ng flexibly allows users to define their own variables. To avoid conflicts with the standard set and to prevent misleading error messages, there's a - - The Mutt Next Generation E-Mail Client 24 - - reserved namespace for them. All user-defined variables must be prefixed with + reserved namespace for them: all user-defined variables must be prefixed with user_ and can be used just like any ordinary configuration or environment vari- able. - For example, to view the manual, users can either define three macros like the + For example, to view the manual, users can either define two macros like the following macro generic "!less -r /path/to/manual" "Show manual" macro pager "!less -r /path/to/manual" "Show manual" - macro index "!less -r /path/to/manual" "Show manual" for generic, pager and index. The alternative is to define a custom variable like so: - set user_manualcmd = '!less -r /path/to_manual" + set user_manualcmd = "!less -r /path/to_manual" macro generic "$user_manualcmd" "Show manual" macro pager "$user_manualcmd" "Show manual" macro index "$user_manualcmd" "Show manual" + to re-use the command sequence as in: + + macro index "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns" + Using this feature, arbitrary sequences can be defined once and recalled and reused where necessary. More advanced scenarios could include to save a vari- able's value at the beginning of macro sequence and restore it at end. - _3_._3_._5 _T_y_p_e _C_o_n_v_e_r_s_i_o_n_s + When the variable is first defined, the first value it gets assigned is also + the initial value to which it can be reset using the reset command. + + The complete removal is done via the unset keyword. + + After the following sequence: + + set user_foo = 42 + set user_foo = 666 + + the variable $user_foo has a current value of 666 and an initial of 42. The + query + + set ?user_foo + + The Mutt Next Generation E-Mail Client 25 + + will show 666. After doing the reset via + + reset user_foo + + a following query will give 42 as the result. After unsetting it via + + unset user_foo + + any query or operation (except the noted expansion within other statements) + will lead to an error message. + + _3_._3_._5 _P_r_e_-_D_e_f_i_n_e_d _V_a_r_i_a_b_l_e_s + + In order to allow users to share one setup over a number of different machines + without having to change its contents, there's a number of pre-defined vari- + ables. These are prefixed with muttng_ and are read-only, i.e. they cannot be + set, unset or reset. The reference chapter lists all available variables. + + _P_l_e_a_s_e _c_o_n_s_u_l_t _t_h_e _l_o_c_a_l _c_o_p_y _o_f _y_o_u_r _m_a_n_u_a_l _f_o_r _t_h_e_i_r _v_a_l_u_e_s _a_s _t_h_e_y _m_a_y _d_i_f_- + _f_e_r _f_r_o_m _d_i_f_f_e_r_e_n_t _m_a_n_u_a_l _s_o_u_r_c_e_s_. Where the manual is installed in can be + queried (already using such a variable) by running: + + muttng -Q muttng_docdir + + To extend the example for viewing the manual via self-defined variables, it can + be made more readable and more portable by changing the real path in: + + set user_manualcmd = '!less -r /path/to_manual' + + to: + + set user_manualcmd = "!less -r $muttng_docdir/manual.txt" + + which works everywhere if a manual is installed. + + Please note that by the type of quoting, muttng determines when to expand these + values: when it finds double quotes, the value will be expanded during reading + the setup files but when it finds single quotes, it'll expand it at runtime as + needed. + + For example, the statement + + folder-hook . "set user_current_folder = $muttng_folder_name" + + The Mutt Next Generation E-Mail Client 26 + + will be already be translated to the following when reading the startup files: + + folder-hook . "set user_current_folder = some_folder" + + with some_folder being the name of the first folder muttng opens. On the con- + trary, + + folder-hook . 'set user_current_folder = $muttng_folder_name' + + will be executed at runtime because of the single quotes so that user_cur- + rent_folder will always have the value of the currently opened folder. + + A more practical example is: + + folder-hook . 'source ~/.mutt/score-$muttng_folder_name' + + which can be used to source files containing score commands depending on the + folder the user enters. + + _3_._3_._6 _T_y_p_e _C_o_n_v_e_r_s_i_o_n_s A note about variable's types during conversion: internally values are stored in internal types but for any dump/query or set operation they're converted to @@ -1191,7 +1278,7 @@ set read_inc = 100 set folder = $read_inc - set $read_inc = $folder + set read_inc = $folder set user_magic_number = 42 set folder = $user_magic_number @@ -1206,10 +1293,10 @@ NNoottee:: if you want to create an alias for a group (by specifying more than one address), you mmuusstt separate the addresses with a comma (``,''). - The Mutt Next Generation E-Mail Client 25 - To remove an alias or aliases (``*'' means all aliases): + The Mutt Next Generation E-Mail Client 27 + unalias [ * | _k_e_y _._._. ] alias muttdude me@cs.hmc.edu (Michael Elkins) @@ -1217,15 +1304,15 @@ Unlike other mailers, Mutt-ng doesn't require aliases to be defined in a spe- cial file. The alias command can appear anywhere in a configuration file, as - long as this file is _s_o_u_r_c_e_d (section 3.29 , page 44). Consequently, you can + long as this file is _s_o_u_r_c_e_d (section 3.29 , page 46). Consequently, you can have multiple alias files, or you can have all aliases defined in your muttrc. On the other hand, the _c_r_e_a_t_e_-_a_l_i_a_s (section 2.5.4 , page 11) function can use - only one file, the one pointed to by the _$_a_l_i_a_s___f_i_l_e (section 7.4.5 , page 88) + only one file, the one pointed to by the _$_a_l_i_a_s___f_i_l_e (section 7.4.5 , page 90) variable (which is ~/.muttrc by default). This file is not special either, in the sense that Mutt-ng will happily append aliases to any file, but in order for the new aliases to take effect you need to explicitly _s_o_u_r_c_e (section - 3.29 , page 44) this file too. + 3.29 , page 46) this file too. For example: @@ -1236,7 +1323,7 @@ To use aliases, you merely use the alias at any place in mutt where mutt prompts for addresses, such as the _T_o_: or _C_c_: prompt. You can also enter aliases in your editor at the appropriate headers if you have the _$_e_d_i_t___h_e_a_d_e_r_s - (section 7.4.58 , page 101) variable set. + (section 7.4.59 , page 103) variable set. 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 @@ -1255,12 +1342,11 @@ This command allows you to change the default key bindings (operation invoked when pressing a key). - _m_a_p specifies in which menu the binding belongs. Multiple maps may be + _m_a_p specifies in which menu the binding belongs. Multiple maps may be speci- + fied by separating them with commas (no additional whitespace is allowed). The + currently defined maps are: - The Mutt Next Generation E-Mail Client 26 - - specified by separating them with commas (no additional whitespace is allowed). - The currently defined maps are: + The Mutt Next Generation E-Mail Client 28 generic This is not a real menu, but is used as a fallback for all of the @@ -1311,10 +1397,10 @@ alternative form is to specify the key as a three digit octal number prefixed with a ``\'' (for example _\_1_7_7 is equivalent to _\_c_?). - The Mutt Next Generation E-Mail Client 27 - In addition, _k_e_y may consist of: + The Mutt Next Generation E-Mail Client 29 + \t tab tab backtab / shift-tab @@ -1342,7 +1428,7 @@ _k_e_y does not need to be enclosed in quotes unless it contains a space (`` ''). _f_u_n_c_t_i_o_n specifies which action to take when _k_e_y is pressed. For a complete - list of functions, see the _r_e_f_e_r_e_n_c_e (section 7.5 , page 172). The special + list of functions, see the _r_e_f_e_r_e_n_c_e (section 7.5 , page 177). The special function noop unbinds the specified key sequence. _3_._6 _D_e_f_i_n_i_n_g _a_l_i_a_s_e_s _f_o_r _c_h_a_r_a_c_t_e_r _s_e_t_s @@ -1361,18 +1447,19 @@ _3_._7 _S_e_t_t_i_n_g _v_a_r_i_a_b_l_e_s _b_a_s_e_d _u_p_o_n _m_a_i_l_b_o_x - The Mutt Next Generation E-Mail Client 28 - Usage: folder-hook [!]_r_e_g_e_x_p _c_o_m_m_a_n_d - It is often desirable to change settings based on which mailbox you are read- - ing. The folder-hook command provides a method by which you can execute any - configuration command. _r_e_g_e_x_p is a regular expression specifying in which + It is often desirable to change settings based on which mailbox you are + + The Mutt Next Generation E-Mail Client 30 + + reading. The folder-hook command provides a method by which you can execute + any configuration command. _r_e_g_e_x_p is a regular expression specifying in which mailboxes to execute _c_o_m_m_a_n_d before loading. If a mailbox matches multiple folder-hook's, they are executed in the order given in the muttrc. - NNoottee:: if you use the ``!'' shortcut for _$_s_p_o_o_l_f_i_l_e (section 7.4.302 , page - 160) at the beginning of the pattern, you must place it inside of double or + NNoottee:: if you use the ``!'' shortcut for _$_s_p_o_o_l_f_i_l_e (section 7.4.313 , page + 165) at the beginning of the pattern, you must place it inside of double or single quotes in order to distinguish it from the logical _n_o_t operator for the expression. @@ -1396,27 +1483,27 @@ typed _s_e_q_u_e_n_c_e. So if you have a common sequence of commands you type, you can create a macro to execute those commands with a single key. - _m_e_n_u is the _m_a_p (section 3.5 , page 26) which the macro will be bound. Multi- + _m_e_n_u is the _m_a_p (section 3.5 , page 28) which the macro will be bound. Multi- ple maps may be specified by separating multiple menu arguments by commas. Whitespace may not be used in between the menu arguments and the commas sepa- rating them. _k_e_y and _s_e_q_u_e_n_c_e are expanded by the same rules as the _k_e_y _b_i_n_d_i_n_g_s (section - 3.5 , page 25). There are some additions however. The first is that control + 3.5 , page 27). There are some additions however. The first is that control characters in _s_e_q_u_e_n_c_e can also be specified as _^_x. In order to get a caret (`^'') you need to use _^_^. Secondly, to specify a certain key such as _u_p or to invoke a function directly, you can use the format _<_k_e_y _n_a_m_e_> and _<_f_u_n_c_t_i_o_n _n_a_m_e_>. For a listing of key names see the section on _k_e_y _b_i_n_d_i_n_g_s (section - 3.5 , page 25). Functions are listed in the _f_u_n_c_t_i_o_n _r_e_f_e_r_e_n_c_e (section - 7.5 , page 172). + 3.5 , page 27). Functions are listed in the _f_u_n_c_t_i_o_n _r_e_f_e_r_e_n_c_e (section + 7.5 , page 177). The advantage with using function names directly is that the macros will work - - The Mutt Next Generation E-Mail Client 29 - regardless of the current key bindings, so they are not dependent on the user having particular key definitions. This makes them more robust and portable, and also facilitates defining of macros in files used by more than one user + + The Mutt Next Generation E-Mail Client 31 + (eg. the system Muttngrc). Optionally you can specify a descriptive text after _s_e_q_u_e_n_c_e, which is shown in @@ -1462,15 +1549,15 @@ +o normal - +o quoted (text matching _$_q_u_o_t_e___r_e_g_e_x_p (section 7.4.230 , page 143) in the + +o quoted (text matching _$_q_u_o_t_e___r_e_g_e_x_p (section 7.4.241 , page 147) in the body of a message) - The Mutt Next Generation E-Mail Client 30 - +o quoted1, quoted2, ..., quotedNN (higher levels of quoting) +o search (highlighting of words in the pager) + The Mutt Next Generation E-Mail Client 32 + +o signature +o status (mode lines used to display info about the mailbox or message) @@ -1519,13 +1606,12 @@ instead of _w_h_i_t_e and _y_e_l_l_o_w when setting this variable. NNoottee:: The uncolor command can be applied to the index object only. It removes - - The Mutt Next Generation E-Mail Client 31 - entries from the list. You mmuusstt 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 Mutt Next Generation E-Mail Client 33 + Mutt-ng also recognizes the keywords _c_o_l_o_r_0, _c_o_l_o_r_1, ..., _c_o_l_o_rNN--11 (NN 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 @@ -1573,14 +1659,14 @@ For example: - The Mutt Next Generation E-Mail Client 32 - # Sven's draconian header weeding ignore * unignore from date subject to cc unignore organization organisation x-mailer: x-newsreader: x-mailing-list: unignore posted-to: + The Mutt Next Generation E-Mail Client 34 + _3_._1_1 _A_l_t_e_r_n_a_t_i_v_e _a_d_d_r_e_s_s_e_s Usage: [un]alternates _r_e_g_e_x_p [ _r_e_g_e_x_p ... ] @@ -1590,7 +1676,7 @@ 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 yourself won't make much sense in many cases. (See - _$_r_e_p_l_y___t_o (section 7.4.238 , page 145).) + _$_r_e_p_l_y___t_o (section 7.4.249 , page 149).) Many users receive e-mail under a number of different addresses. To fully use mutt's features here, the program must be able to recognize what e-mail @@ -1624,9 +1710,6 @@ fixed-size terminals. For introductory information on format=flowed messages, see - - The Mutt Next Generation E-Mail Client 33 - . _3_._1_2_._2 _R_e_c_e_i_v_i_n_g_: _D_i_s_p_l_a_y _S_e_t_u_p @@ -1636,6 +1719,8 @@ your terminal. If you want a fixed margin on the right side of your terminal, you can set the following: + The Mutt Next Generation E-Mail Client 35 + set wrapmargin = 10 The code above makes the line break 10 columns before the right side of the @@ -1669,8 +1754,6 @@ > production server that we want to set up before our customer's > project will go live. - The Mutt Next Generation E-Mail Client 34 - _3_._1_2_._3 _S_e_n_d_i_n_g If you want mutt-ng to send emails with format=flowed set, you need to explic- @@ -1678,6 +1761,8 @@ set text_flowed + The Mutt Next Generation E-Mail Client 36 + Additionally, you have to use an editor which supports writing format=flowed- conforming emails. For vim, this is done by adding w to the formatoptions (see :h formatoptions and :h fo-table) when writing emails. @@ -1702,7 +1787,7 @@ " - For completeness, the _$_d_e_l_e_t_e___s_p_a_c_e (section 7.4.50 , page 99) variable pro- + For completeness, the _$_d_e_l_e_t_e___s_p_a_c_e (section 7.4.51 , page 101) variable pro- vides the mechanism to generate a DelSp=yes parameter on _o_u_t_g_o_i_n_g messages. According to the standard, clients receiving a format=flowed messages should delete the last space of a flowed line but still interpret the line as flowed. @@ -1719,10 +1804,7 @@ Usage: [un]subscribe _r_e_g_e_x_p [ _r_e_g_e_x_p ... ] Mutt-ng has a few nice features for _h_a_n_d_l_i_n_g _m_a_i_l_i_n_g _l_i_s_t_s (section 4.10 , - page 59). In order to take advantage of them, you must specify which addresses - - The Mutt Next Generation E-Mail Client 35 - + page 61). 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 _l_i_s_t_-_r_e_p_l_y (section 2.5.4 , page 12) function will work for all known lists. Additionally, when you send a message to a sub- @@ -1731,9 +1813,11 @@ 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 per- sonal CCs of list messages. Also note that the generation of the Mail-Fol- - lowup-To header is controlled by the _$_f_o_l_l_o_w_u_p___t_o (section 7.4.70 , page 104) + lowup-To header is controlled by the _$_f_o_l_l_o_w_u_p___t_o (section 7.4.72 , page 106) configuration variable. + The Mutt Next Generation E-Mail Client 37 + More precisely, Mutt-ng 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, @@ -1772,8 +1856,6 @@ Unlike some of the other _h_o_o_k commands, only the _f_i_r_s_t matching pattern is used (it is not possible to save read mail in more than a single mailbox). - The Mutt Next Generation E-Mail Client 36 - _3_._1_5 _D_e_f_i_n_i_n_g _m_a_i_l_b_o_x_e_s _w_h_i_c_h _r_e_c_e_i_v_e _m_a_i_l Usage: [un]mailboxes [!]_f_i_l_e_n_a_m_e [ _f_i_l_e_n_a_m_e ... ] @@ -1786,6 +1868,9 @@ 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. + + The Mutt Next Generation E-Mail Client 38 + Mutt-ng will automatically enter this mode when invoked from the command line with the -y option. @@ -1800,9 +1885,9 @@ NNoottee:: the filenames in the mailboxes command are resolved when the command is executed, so if these names contain _s_h_o_r_t_c_u_t _c_h_a_r_a_c_t_e_r_s (section 4.9 , page - 59) (such as ``='' and ``!''), any variable definition that affect these char- - acters (like _$_f_o_l_d_e_r (section 7.4.68 , page 103) and _$_s_p_o_o_l_f_i_l_e (section - 7.4.302 , page 160)) should be executed before the mailboxes command. + 61) (such as ``='' and ``!''), any variable definition that affect these char- + acters (like _$_f_o_l_d_e_r (section 7.4.70 , page 105) and _$_s_p_o_o_l_f_i_l_e (section + 7.4.313 , page 165)) should be executed before the mailboxes command. _3_._1_6 _U_s_e_r _d_e_f_i_n_e_d _h_e_a_d_e_r_s @@ -1824,13 +1909,10 @@ NNoottee:: space characters are _n_o_t allowed between the keyword and the colon (``:''). The standard for electronic mail (RFC822) says that space is illegal - - The Mutt Next Generation E-Mail Client 37 - there, so Mutt-ng enforces the rule. If you would like to add a header field to a single message, you should either - set the _e_d_i_t___h_e_a_d_e_r_s (section 7.4.58 , page 101) variable, or use the _e_d_i_t_- + set the _e_d_i_t___h_e_a_d_e_r_s (section 7.4.59 , page 103) variable, or use the _e_d_i_t_- _h_e_a_d_e_r_s function (default: ``E'') in the send-menu so that you can edit the header of your message along with the body. @@ -1839,6 +1921,8 @@ remove. For example, to remove all ``To'' and ``Cc'' header fields, you could use: + The Mutt Next Generation E-Mail Client 39 + unmy_hdr to cc _3_._1_7 _D_e_f_i_n_i_n_g _t_h_e _o_r_d_e_r _o_f _h_e_a_d_e_r_s _w_h_e_n _v_i_e_w_i_n_g _m_e_s_s_a_g_e_s @@ -1862,7 +1946,7 @@ an address matching _r_e_g_e_x_p or if you are the author and the message is addressed _t_o_: something matching _r_e_g_e_x_p. - See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 56) for information on the + See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 58) for information on the exact format of _p_a_t_t_e_r_n. Examples: @@ -1870,35 +1954,35 @@ save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins save-hook aol\\.com$ +spam - Also see the _f_c_c_-_s_a_v_e_-_h_o_o_k (section 3.20 , page 38) command. - - The Mutt Next Generation E-Mail Client 38 + Also see the _f_c_c_-_s_a_v_e_-_h_o_o_k (section 3.20 , page 40) command. _3_._1_9 _S_p_e_c_i_f_y _d_e_f_a_u_l_t _F_c_c_: _m_a_i_l_b_o_x _w_h_e_n _c_o_m_p_o_s_i_n_g Usage: fcc-hook [!]_p_a_t_t_e_r_n _m_a_i_l_b_o_x This command is used to save outgoing mail in a mailbox other than _$_r_e_c_o_r_d - (section 7.4.235 , page 144). Mutt-ng searches the initial list of message + (section 7.4.246 , page 148). Mutt-ng searches the initial list of message recipients for the first matching _r_e_g_e_x_p and uses _m_a_i_l_b_o_x as the default Fcc: mailbox. If no match is found the message will be saved to _$_r_e_c_o_r_d (section - 7.4.235 , page 144) mailbox. + 7.4.246 , page 148) mailbox. - See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 56) for information on the + The Mutt Next Generation E-Mail Client 40 + + See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 58) for information on the exact format of _p_a_t_t_e_r_n. Example: 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 _f_c_c_-_s_a_v_e_-_h_o_o_k (section 3.20 , - page 38) command. + page 40) command. _3_._2_0 _S_p_e_c_i_f_y _d_e_f_a_u_l_t _s_a_v_e _f_i_l_e_n_a_m_e _a_n_d _d_e_f_a_u_l_t _F_c_c_: _m_a_i_l_b_o_x _a_t _o_n_c_e Usage: fcc-save-hook [!]_p_a_t_t_e_r_n _m_a_i_l_b_o_x This command is a shortcut, equivalent to doing both a _f_c_c_-_h_o_o_k (section - 3.19 , page 38) and a _s_a_v_e_-_h_o_o_k (section 3.18 , page 37) with its arguments. + 3.19 , page 39) and a _s_a_v_e_-_h_o_o_k (section 3.18 , page 39) with its arguments. _3_._2_1 _C_h_a_n_g_e _s_e_t_t_i_n_g_s _b_a_s_e_d _u_p_o_n _m_e_s_s_a_g_e _r_e_c_i_p_i_e_n_t_s @@ -1921,24 +2005,25 @@ 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 can, e.g., be used to set parameters such as the - _$_s_e_n_d_m_a_i_l (section 7.4.252 , page 148) variable depending on the message's + _$_s_e_n_d_m_a_i_l (section 7.4.263 , page 152) variable depending on the message's sender address. - The Mutt Next Generation E-Mail Client 39 - 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 _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 56) for information on the + See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 58) for information on the exact format of _p_a_t_t_e_r_n. Example: send-hook mutt 'set mime_forward signature=''' - Another typical use for this command is to change the values of the _$_a_t_t_r_i_b_u_- - _t_i_o_n (section 7.4.18 , page 92), _$_s_i_g_n_a_t_u_r_e (section 7.4.264 , page 151) and - _$_l_o_c_a_l_e (section 7.4.118 , page 117) variables in order to change the language - of the attributions and signatures based upon the recipients. + Another typical use for this command is to change the values of the + + The Mutt Next Generation E-Mail Client 41 + + _$_a_t_t_r_i_b_u_t_i_o_n (section 7.4.18 , page 94), _$_s_i_g_n_a_t_u_r_e (section 7.4.275 , page + 155) and _$_l_o_c_a_l_e (section 7.4.120 , page 120) variables in order to change the + language of the attributions and signatures based upon the recipients. NNoottee:: 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 @@ -1956,7 +2041,7 @@ tiple matches occur, commands are executed in the order they are specified in the muttrc. - See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 56) for information on the + See _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s (section 4.5.1 , page 58) for information on the exact format of _p_a_t_t_e_r_n. Example: @@ -1975,8 +2060,6 @@ 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 Mutt Next Generation E-Mail Client 40 - The meaning of "key id" 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. @@ -1984,17 +2067,21 @@ Usage: push _s_t_r_i_n_g - This command adds the named string to the keyboard buffer. The string may con- - tain control characters, key names and function names like the sequence string - in the _m_a_c_r_o (section 3.8 , page 28) command. You may use it to automatically - run a sequence of commands at startup, or when entering certain folders. + This command adds the named string to the keyboard buffer. The string may + + The Mutt Next Generation E-Mail Client 42 + + contain control characters, key names and function names like the sequence + string in the _m_a_c_r_o (section 3.8 , page 30) command. You may use it to auto- + matically run a sequence of commands at startup, or when entering certain fold- + ers. _3_._2_5 _E_x_e_c_u_t_i_n_g _f_u_n_c_t_i_o_n_s Usage: exec _f_u_n_c_t_i_o_n [ _f_u_n_c_t_i_o_n ... ] This command can be used to execute any function. Functions are listed in the - _f_u_n_c_t_i_o_n _r_e_f_e_r_e_n_c_e (section 7.5 , page 172). ``exec function'' is equivalent + _f_u_n_c_t_i_o_n _r_e_f_e_r_e_n_c_e (section 7.5 , page 177). ``exec function'' is equivalent to ``push ''. _3_._2_6 _M_e_s_s_a_g_e _S_c_o_r_i_n_g @@ -2022,8 +2109,6 @@ score "~f santaclaus@northpole\.int" =666 - The Mutt Next Generation E-Mail Client 41 - What is important to note is that negative score values will be rounded up to 0. @@ -2033,6 +2118,8 @@ +o flag threshold: when a message has a score value equal or higher than the flag threshold, it will be flagged. + The Mutt Next Generation E-Mail Client 43 + +o read threshold: when a message has a score value equal or lower than the read threshold, it will be marked as read. @@ -2040,17 +2127,17 @@ delete threshold, it will be marked as deleted. These three thresholds can be set via the variables _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___f_l_a_g (sec- - tion 7.4.249 , page 148), _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___r_e_a_d (section 7.4.250 , page 148), - _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___d_e_l_e_t_e (section 7.4.248 , page 148) and. By default, - _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___r_e_a_d (section 7.4.250 , page 148) and _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___d_e_l_e_t_e - (section 7.4.248 , page 148) are set to -1, which means that in the default + tion 7.4.260 , page 152), _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___r_e_a_d (section 7.4.261 , page 152), + _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___d_e_l_e_t_e (section 7.4.259 , page 152) and. By default, + _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___r_e_a_d (section 7.4.261 , page 152) and _$_s_c_o_r_e___t_h_r_e_s_h_o_l_d___d_e_l_e_t_e + (section 7.4.259 , page 152) are set to -1, which means that in the default threshold configuration no message will ever get marked as read or deleted. Scoring gets especially interesting when combined with the color command and the ~n pattern: - color black yellow "~n 10-" - color red yellow "~n 100-" + color index black yellow "~n 10-" + color index red yellow "~n 100-" The rules above mark all messages with a score between 10 and 99 with black and yellow, and messages with a score greater or equal 100 with red and yellow. @@ -2067,16 +2154,13 @@ your spam patterns with the spam and nospam commands, you can _l_i_m_i_t, _s_e_a_r_c_h, and _s_o_r_t your mail based on its spam attributes, as determined by the external filter. You also can display the spam attributes in your index display using - the %H selector in the _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.114 , page 114) variable. + the %H selector in the _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.116 , page 116) variable. (Tip: try %?H?[%H] ? 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. _p_a_t_t_e_r_n should be a regular expression that matches a header in a mail message. If any message in the mailbox matches this regular expression, it - - The Mutt Next Generation E-Mail Client 42 - 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 _f_o_r_m_a_t parameter. _f_o_r_m_a_t can be any static text, @@ -2086,6 +2170,9 @@ with the second, etc. If you're using multiple spam filters, a message can have more than one spam- + + The Mutt Next Generation E-Mail Client 44 + related header. You can define spam patterns for each filter you use. If a mes- sage matches two or more of these patterns, and the $spam_separator variable is set to a string, then the message's spam tag will consist of all the _f_o_r_m_a_t @@ -2130,9 +2217,6 @@ still do something useful. The nospam command can be used to write exceptions to spam patterns. If a - - The Mutt Next Generation E-Mail Client 43 - 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. @@ -2142,6 +2226,9 @@ instead of adding an exception. Likewise, if the _p_a_t_t_e_r_n for a spam command matches an entry on the nospam list, that nospam entry will be removed. If the _p_a_t_t_e_r_n for nospam is ``*'', _a_l_l _e_n_t_r_i_e_s _o_n _b_o_t_h _l_i_s_t_s will be removed. This + + The Mutt Next Generation E-Mail Client 45 + might be the default action if you use spam and nospam in conjunction with a folder-hook. @@ -2162,7 +2249,7 @@ Usage: reset _v_a_r_i_a_b_l_e [_v_a_r_i_a_b_l_e ... ] This command is used to set (and unset) _c_o_n_f_i_g_u_r_a_t_i_o_n _v_a_r_i_a_b_l_e_s (section 7.4 , - page 86). There are four basic types of variables: boolean, number, string and + page 88). There are four basic types of variables: boolean, number, string and quadoption. _b_o_o_l_e_a_n variables can be _s_e_t (true) or _u_n_s_e_t (false). _n_u_m_b_e_r variables can be assigned a positive integer value. @@ -2183,8 +2270,6 @@ toggle the value (on or off). This is useful when writing macros. Example: set invsmart_wrap. - The Mutt Next Generation E-Mail Client 44 - The toggle command automatically prepends the inv prefix to all specified vari- ables. @@ -2194,6 +2279,8 @@ Using the enter-command function in the _i_n_d_e_x menu, you can query the value of a variable by prefixing the name of the variable with a question mark: + The Mutt Next Generation E-Mail Client 46 + set ?allow_8bit The question mark is actually only required for boolean and quadoption vari- @@ -2231,8 +2318,6 @@ _3_._3_1 _S_h_a_r_i_n_g _S_e_t_u_p_s - The Mutt Next Generation E-Mail Client 45 - _3_._3_1_._1 _C_h_a_r_a_c_t_e_r _S_e_t_s As users may run mutt-ng on different systems, the configuration must be main- @@ -2243,6 +2328,9 @@ specify in which character set their configuration files are encoded. Please note that while reading the configuration files, this is only respected after the corresponding declaration appears. It's advised to put the following at the + + The Mutt Next Generation E-Mail Client 47 + very beginning of a users muttngrc: set config_charset = "..." @@ -2277,8 +2365,6 @@ ...whereby can be one of: - The Mutt Next Generation E-Mail Client 46 - +o a function name +o a variable name @@ -2289,6 +2375,9 @@ All available functions, variables and menus are documented elsewhere in this manual but ``features'' is specific to these two commands. To test for one, + + The Mutt Next Generation E-Mail Client 48 + prefix one of the following keywords with feature_: ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl, @@ -2307,13 +2396,13 @@ An example for testing for variable names can be used if users use different revisions of mutt-ng whereby the older one may not have a certain variable. To - test for the availability of _$_i_m_a_p___m_a_i_l___c_h_e_c_k (section 7.4.103 , page 111), + test for the availability of _$_i_m_a_p___m_a_i_l___c_h_e_c_k (section 7.4.105 , page 114), use: ifdef imap_mail_check 'set imap_mail_check = 300' Provided for completeness is the test for menu names. To set _$_p_a_g_e_r___i_n_d_e_x___l_i_n_e_s - (section 7.4.174 , page 130) only if the pager menu is available, use: + (section 7.4.185 , page 134) only if the pager menu is available, use: ifdef pager 'set pager_index_lines = 10' @@ -2324,25 +2413,25 @@ ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses' ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang' - The Mutt Next Generation E-Mail Client 47 - ...and... ifdef feature_slang 'source ~/.mutt-ng/setup-slang' ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses' + The Mutt Next Generation E-Mail Client 49 + _3_._3_2 _O_b_s_o_l_e_t_e _V_a_r_i_a_b_l_e_s In the process of ensuring and creating more consistency, many variables have been renamed and some of the old names were already removed. Please see _O_b_s_o_- - _l_e_t_e _V_a_r_i_a_b_l_e_s (section 7.4 , page 86) for a complete list. + _l_e_t_e _V_a_r_i_a_b_l_e_s (section 7.4 , page 88) for a complete list. _4_. _A_d_v_a_n_c_e_d _U_s_a_g_e _4_._1 _R_e_g_u_l_a_r _E_x_p_r_e_s_s_i_o_n_s All string patterns in Mutt-ng including those in more complex _p_a_t_t_e_r_n_s (sec- - tion 7.2 , page 82) must be specified using regular expressions (regexp) in + tion 7.2 , page 84) must be specified 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. @@ -2370,8 +2459,6 @@ sign ``$'' are metacharacters that respectively match the empty string at the beginning and end of a line. - The Mutt Next Generation E-Mail Client 48 - 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 nnoott in the list. For example, the regular expression @@ -2382,6 +2469,8 @@ place it anywhere but first. Finally, to include a literal hyphen ``-'' place it last. + The Mutt Next Generation E-Mail Client 50 + 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: @@ -2426,9 +2515,6 @@ 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 - - The Mutt Next Generation E-Mail Client 49 - symbolic names, and must be included in addition to the brackets delimiting the bracket list. For example, [[[[::ddiiggiitt::]]]] is equivalent to [[00--99]]. @@ -2439,6 +2525,9 @@ Collating Symbols A collating symbol is a multi-character collating element enclosed + + The Mutt Next Generation E-Mail Client 51 + in ``[.'' and ``.]''. For example, if ``ch'' is a collating ele- ment, then [[[[..cchh..]]]] is a regexp that matches this collating ele- ment, while [[cchh]] is a regexp that matches either ``c'' or ``h''. @@ -2483,9 +2572,6 @@ ing regular expression matches any string matching either subexpression. Repetition takes precedence over concatenation, which in turn takes precedence - - The Mutt Next Generation E-Mail Client 50 - over alternation. A whole subexpression may be enclosed in parentheses to override these precedence rules. @@ -2496,6 +2582,8 @@ Matches the empty string at either the beginning or the end of a word. + The Mutt Next Generation E-Mail Client 52 + \\B Matches the empty string within a word. @@ -2527,7 +2615,7 @@ to match messages, e.g. for operations like tagging and scoring. A pattern con- sists of one or more sub-pattern, which can be logically grouped, ORed, and negated. For a complete listing of these patterns, please refer to table _P_a_t_- - _t_e_r_n_s (section 7.2 , page 82) in the Reference chapter. + _t_e_r_n_s (section 7.2 , page 84) in the Reference chapter. It must be noted that in this table, EXPR, USER, ID and SUBJECT are regular expressions. For ranges, the forms <[MAX], >>[MIN], [MIN]- and -[MAX] are also @@ -2539,8 +2627,6 @@ most simple possibility is to logically AND several patterns by stringing them together: - The Mutt Next Generation E-Mail Client 51 - ~s 'SPAM' ~U The pattern above matches all messages that contain ``SPAM'' in the subject and @@ -2549,6 +2635,8 @@ To logical OR patterns, simply use the | operator. This one especially useful when using local groups: + The Mutt Next Generation E-Mail Client 53 + ~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org") (~b mutt-ng|~s Mutt-ng) !~x '@synflood\.at' @@ -2588,8 +2676,6 @@ date ranges between a fixed number of units and the current date. How this works can be seen in the following example: - The Mutt Next Generation E-Mail Client 52 - ~d >2w # messages older than two weeks ~d <3d # messages newer than 3 days ~d =1m # messages that are exactly one month old @@ -2598,6 +2684,8 @@ _4_._3_._1 _I_n_t_r_o_d_u_c_t_i_o_n + The Mutt Next Generation E-Mail Client 54 + The so called _F_o_r_m_a_t _S_t_r_i_n_g_s offer great flexibility when configuring mutt-ng. In short, they describe what items to print out how in menus and status mes- sages. @@ -2614,7 +2702,7 @@ +o the current mutt-ng version number The setting for the status bar of the index is controlled via the _$_s_t_a_t_u_s___f_o_r_- - _m_a_t (section 7.4.313 , page 163) variable. For the hostname and version + _m_a_t (section 7.4.324 , page 167) variable. For the hostname and version string, there's an expando for $status_format: %h expands to the hostname and %v to the version string. When just configuring: @@ -2636,8 +2724,6 @@ To include the mailbox' name is as easy as: - The Mutt Next Generation E-Mail Client 53 - set status_format = "%v on %h: %B: ... When the currently opened mailbox is Inbox, this will be expanded to: @@ -2646,6 +2732,9 @@ For the number of certain types of messages, one more feature of the format strings is extremely useful. If there aren't messages of a certain type, it may + + The Mutt Next Generation E-Mail Client 55 + not be desired to print just that there aren't any but instead only print some- thing if there are any. @@ -2681,8 +2770,6 @@ +o and make it print ``no new messages'' if there aren't any - The Mutt Next Generation E-Mail Client 54 - The corresponding configuration is: set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ... @@ -2692,6 +2779,8 @@ set status_format = "%v on %h: %B: %?n?%n&no? new messages ... + The Mutt Next Generation E-Mail Client 56 + As you might see from this rather simple example, one can create very complex but fancy status messages. Please see the reference chapter for expandos and those which may be printed nonzero. @@ -2728,8 +2817,6 @@ set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)" - The Mutt Next Generation E-Mail Client 55 - _4_._4 _U_s_i_n_g _T_a_g_s Sometimes it is desirable to perform an operation on a group of messages all at @@ -2738,17 +2825,20 @@ ject. 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 mes- sages by hand using the ``tag-message'' function, which is bound to ``t'' by - default. See _p_a_t_t_e_r_n_s (section 7.2 , page 82) for Mutt-ng's pattern matching + + The Mutt Next Generation E-Mail Client 57 + + default. See _p_a_t_t_e_r_n_s (section 7.2 , page 84) for Mutt-ng's pattern matching syntax. Once you have tagged the desired messages, you can use the ``tag-prefix'' oper- ator, which is the ``;'' (semicolon) key by default. When the ``tag-prefix'' operator is used, the nneexxtt operation will be applied to all tagged messages if that operation can be used in that manner. If the _$_a_u_t_o___t_a_g (section 7.4.19 , - page 92) variable is set, the next operation applies to the tagged messages + page 94) variable is set, the next operation applies to the tagged messages automatically, without requiring the ``tag-prefix''. - In _m_a_c_r_o_s (section 3.8 , page 28) or _p_u_s_h (section 3.24 , page 40) commands, + In _m_a_c_r_o_s (section 3.8 , page 30) or _p_u_s_h (section 3.24 , page 41) 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-ng will stop "eating" the macro when it encounters the ``end-cond'' operator; after @@ -2760,45 +2850,44 @@ 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-ng world, a _h_o_o_k consists of a _r_e_g_u_l_a_r - _e_x_p_r_e_s_s_i_o_n (section 4.1 , page 47) or _p_a_t_t_e_r_n (section 7.2 , page 82) along + _e_x_p_r_e_s_s_i_o_n (section 4.1 , page 49) or _p_a_t_t_e_r_n (section 7.2 , page 84) along with a configuration option/command. See - +o _f_o_l_d_e_r_-_h_o_o_k (section 3.7 , page 28) + +o _f_o_l_d_e_r_-_h_o_o_k (section 3.7 , page 29) - +o _s_e_n_d_-_h_o_o_k (section 3.21 , page 38) + +o _s_e_n_d_-_h_o_o_k (section 3.21 , page 40) - +o _m_e_s_s_a_g_e_-_h_o_o_k (section 3.22 , page 39) + +o _m_e_s_s_a_g_e_-_h_o_o_k (section 3.22 , page 41) - +o _s_a_v_e_-_h_o_o_k (section 3.18 , page 37) + +o _s_a_v_e_-_h_o_o_k (section 3.18 , page 39) - +o _m_b_o_x_-_h_o_o_k (section 3.14 , page 35) + +o _m_b_o_x_-_h_o_o_k (section 3.14 , page 37) - +o _f_c_c_-_h_o_o_k (section 3.19 , page 38) + +o _f_c_c_-_h_o_o_k (section 3.19 , page 39) - +o _f_c_c_-_s_a_v_e_-_h_o_o_k (section 3.20 , page 38) + +o _f_c_c_-_s_a_v_e_-_h_o_o_k (section 3.20 , page 40) for specific details on each type of _h_o_o_k available. NNoottee:: 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 - - The Mutt Next Generation E-Mail Client 56 - defaults. Here is an example with send-hook and the my_hdr directive: send-hook . 'unmy_hdr From:' send-hook ~C'^b@b\.b$' my_hdr from: c@c.c + The Mutt Next Generation E-Mail Client 58 + _4_._5_._1 _M_e_s_s_a_g_e _M_a_t_c_h_i_n_g _i_n _H_o_o_k_s Hooks that act upon messages (send-hook, save-hook, fcc-hook, message-hook) are evaluated in a slightly different manner. For the other types of hooks, a _r_e_g_- - _u_l_a_r _e_x_p_r_e_s_s_i_o_n (section 4.1 , page 47) is sufficient. But in dealing with + _u_l_a_r _e_x_p_r_e_s_s_i_o_n (section 4.1 , page 49) is sufficient. But in dealing with messages a finer grain of control is needed for matching since for different purposes you want to match different criteria. - Mutt-ng allows the use of the _s_e_a_r_c_h _p_a_t_t_e_r_n (section 7.2 , page 82) language + Mutt-ng allows the use of the _s_e_a_r_c_h _p_a_t_t_e_r_n (section 7.2 , page 84) language for matching messages in hook commands. This works in exactly the same way as it would when _l_i_m_i_t_i_n_g or _s_e_a_r_c_h_i_n_g the mailbox, except that you are restricted to those operators which match information mutt extracts from the header of the @@ -2815,9 +2904,9 @@ searching language. You can still specify a simple _r_e_g_u_l_a_r _e_x_p_r_e_s_s_i_o_n like the other hooks, in which case Mutt-ng will translate your pattern into the full language, using the translation specified by the _$_d_e_f_a_u_l_t___h_o_o_k (section - 7.4.48 , page 98) variable. The pattern is translated at the time the hook is - declared, so the value of _$_d_e_f_a_u_l_t___h_o_o_k (section 7.4.48 , page 98) that is in - effect at that time will be used. + 7.4.49 , page 101) variable. The pattern is translated at the time the hook + is declared, so the value of _$_d_e_f_a_u_l_t___h_o_o_k (section 7.4.49 , page 101) that is + in effect at that time will be used. _4_._6 _U_s_i_n_g _t_h_e _s_i_d_e_b_a_r @@ -2831,8 +2920,6 @@ If you want to specify the mailboxes you can do so with: - The Mutt Next Generation E-Mail Client 57 - set mbox='=INBOX' mailboxes INBOX \ MBOX1 \ @@ -2841,6 +2928,8 @@ You can also specify the colors for mailboxes with new mails by using: + The Mutt Next Generation E-Mail Client 59 + color sidebar_new red black color sidebar white black @@ -2872,16 +2961,13 @@ Mutt-ng supports connecting to external directory databases such as LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to mutt using a - simple interface. Using the _$_q_u_e_r_y___c_o_m_m_a_n_d (section 7.4.226 , page 142) vari- + simple interface. Using the _$_q_u_e_r_y___c_o_m_m_a_n_d (section 7.4.237 , page 146) vari- able, 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 single line, each - - The Mutt Next Generation E-Mail Client 58 - line containing a tab separated address then name then some other optional information. On error, or if there are no matching addresses, return a non- zero exit code and a one line error message. @@ -2891,6 +2977,9 @@ Searching database ... 20 entries ... 3 matching: me@cs.hmc.edu Michael Elkins mutt dude blong@fiction.net Brandon Long mutt and more + + The Mutt Next Generation E-Mail Client 60 + roessler@guug.de Thomas Roessler mutt pgp There are two mechanisms for accessing the query function of mutt. One is to @@ -2914,7 +3003,7 @@ Mutt-ng supports reading and writing of four different 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-ng - uses the default specified with the _$_m_b_o_x___t_y_p_e (section 7.4.130 , page 119) + uses the default specified with the _$_m_b_o_x___t_y_p_e (section 7.4.132 , page 122) variable. mmbbooxx. This is the most widely used mailbox format for UNIX. All messages are @@ -2931,9 +3020,6 @@ MMHH. A radical departure from _m_b_o_x and _M_M_D_F, a mailbox consists of a directory and each message is stored in a separate file. The filename indicates the mes- sage number (however, this is may not correspond to the message number Mutt-ng - - The Mutt Next Generation E-Mail Client 59 - displays). Deleted messages are renamed with a comma (,) prepended to the file- name. NNoottee:: Mutt detects this type of mailbox by looking for either .mh_sequences or .xmhcache (needed to distinguish normal directories from MH @@ -2943,6 +3029,9 @@ ment for sendmail). Similar to _M_H, except that it adds three subdirectories of the mailbox: _t_m_p, _n_e_w and _c_u_r. Filenames for the messages are chosen in such a way they are unique, even when two programs are writing the mailbox over NFS, + + The Mutt Next Generation E-Mail Client 61 + which means that no file locking is needed. _4_._9 _M_a_i_l_b_o_x _S_h_o_r_t_c_u_t_s @@ -2951,12 +3040,12 @@ These shortcuts can be used anywhere you are prompted for a file or mailbox path. - +o ! -- refers to your _$_s_p_o_o_l_f_i_l_e (section 7.4.302 , page 160) (incoming) + +o ! -- refers to your _$_s_p_o_o_l_f_i_l_e (section 7.4.313 , page 165) (incoming) mailbox - +o > -- refers to your _$_m_b_o_x (section 7.4.129 , page 119) file + +o > -- refers to your _$_m_b_o_x (section 7.4.131 , page 122) file - +o < -- refers to your _$_r_e_c_o_r_d (section 7.4.235 , page 144) file + +o < -- refers to your _$_r_e_c_o_r_d (section 7.4.246 , page 148) file +o ^ -- refers to the current mailbox @@ -2964,9 +3053,9 @@ +o ~ -- refers to your home directory - +o = or + -- refers to your _$_f_o_l_d_e_r (section 7.4.68 , page 103) directory + +o = or + -- refers to your _$_f_o_l_d_e_r (section 7.4.70 , page 105) directory - +o @_a_l_i_a_s -- refers to the _d_e_f_a_u_l_t _s_a_v_e _f_o_l_d_e_r (section 3.18 , page 37) as + +o @_a_l_i_a_s -- refers to the _d_e_f_a_u_l_t _s_a_v_e _f_o_l_d_e_r (section 3.18 , page 39) as determined by the address of the alias _4_._1_0 _H_a_n_d_l_i_n_g _M_a_i_l_i_n_g _L_i_s_t_s @@ -2976,17 +3065,14 @@ you consider to be mailing lists (technically this does not have to be a mail- ing 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 _l_i_s_t_s _a_n_d _s_u_b_s_c_r_i_b_e - (section 3.13 , page 34) commands in your muttrc. + (section 3.13 , page 36) commands in your muttrc. Now that Mutt-ng 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 _i_n_d_e_x menu display. This is useful to distinguish between personal and list mail in the same mail- - box. In the _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.114 , page 114) variable, the escape + box. In the _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.116 , page 116) variable, the escape ``%L'' will return the string ``To '' when ``list'' appears in the ``To'' - - The Mutt Next Generation E-Mail Client 60 - field, and ``Cc '' when it appears in the ``Cc'' field (otherwise it returns the name of the author). @@ -2996,11 +3082,14 @@ person. The ``list-reply'' function, which by default is bound to ``L'' in the _i_n_d_e_x menu and _p_a_g_e_r, helps reduce the clutter by only replying to the known mailing list addresses instead of all recipients (except as specified by Mail- + + The Mutt Next Generation E-Mail Client 62 + Followup-To, see below). Mutt-ng 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 _$_f_o_l_l_o_w_u_p___t_o (section 7.4.70 , page 104) option is set, mutt will + and if the _$_f_o_l_l_o_w_u_p___t_o (section 7.4.72 , page 106) 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 message should only be @@ -3010,7 +3099,7 @@ Conversely, when group-replying or list-replying to a message which has a Mail- Followup-To header, mutt will respect this header if the _$_h_o_n_o_r___f_o_l_l_o_w_u_p___t_o - (section 7.4.92 , page 109) configuration variable is set. Using list-reply + (section 7.4.94 , page 111) configuration 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. @@ -3023,7 +3112,7 @@ 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'' field. Mutt-ng uses the _$_r_e_p_l_y___t_o (section - 7.4.238 , page 145) variable to help decide which address to use. If set to + 7.4.249 , page 149) variable to help decide which address to use. If set to _a_s_k_-_y_e_s or _a_s_k_-_n_o, 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 _y_e_s, the ``Reply-To'' field @@ -3031,26 +3120,26 @@ The ``X-Label:'' header field can be used to further identify mailing lists or list subject matter (or just to annotate messages individually). The - _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.114 , page 114) variable's ``%y'' and ``%Y'' + _$_i_n_d_e_x___f_o_r_m_a_t (section 7.4.116 , page 116) variable's ``%y'' and ``%Y'' escapes can be used to expand ``X-Label:'' fields in the index, and Mutt-ng's pattern-matcher can match regular expressions to ``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. - Lastly, Mutt-ng has the ability to _s_o_r_t (section 7.4.296 , page 158) the mail- + Lastly, Mutt-ng has the ability to _s_o_r_t (section 7.4.307 , page 163) the mail- box into _t_h_r_e_a_d_s (section 2.5.3 , page 11). A thread is a group of messages which all relate to the same subject. This is usually organized into a tree- - like structure where a message and all of its replies are represented - - The Mutt Next Generation E-Mail Client 61 - - graphically. If you've ever used a threaded news client, this is the same con- - cept. It makes dealing with large volume mailing lists easier because you can - easily delete uninteresting threads and quickly find topics of value. + like structure where a message and all of its replies are represented graphi- + cally. If you've ever used a threaded news client, this is the same concept. + It makes dealing with large volume mailing lists easier because you can easily + delete uninteresting threads and quickly find topics of value. _4_._1_1 _E_d_i_t_i_n_g _t_h_r_e_a_d_s Mutt-ng has the ability to dynamically restructure threads that are broken + + The Mutt Next Generation E-Mail Client 63 + either by misconfigured software or bad behavior from some correspondents. This allows to clean your mailboxes formats) from these annoyances which make it hard to follow a discussion. @@ -3091,18 +3180,18 @@ To support this, there are two variables: - +o _$_d_s_n___n_o_t_i_f_y (section 7.4.55 , page 100) is used to request receipts for + +o _$_d_s_n___n_o_t_i_f_y (section 7.4.56 , page 102) is used to request receipts for different results (such as failed message, message delivered, etc.). - The Mutt Next Generation E-Mail Client 62 - - +o _$_d_s_n___r_e_t_u_r_n (section 7.4.56 , page 100) requests how much of your message + +o _$_d_s_n___r_e_t_u_r_n (section 7.4.57 , page 103) requests how much of your message should be returned with the receipt (headers or full message). Please see the reference chapter for possible values. _4_._1_3 _P_O_P_3 _S_u_p_p_o_r_t _(_O_P_T_I_O_N_A_L_) + The Mutt Next Generation E-Mail Client 64 + If Mutt-ng was compiled with POP3 support (by running the _c_o_n_f_i_g_u_r_e script with the _-_-_e_n_a_b_l_e_-_p_o_p flag), it has the ability to work with mailboxes located on a remote POP3 server and fetch mail for local browsing. @@ -3118,7 +3207,7 @@ Polling for new mail is more expensive over POP3 than locally. For this reason the frequency at which Mutt-ng will check for mail remotely can be controlled - by the _$_p_o_p___m_a_i_l___c_h_e_c_k (section 7.4.213 , page 140) variable, which defaults + by the _$_p_o_p___m_a_i_l___c_h_e_c_k (section 7.4.224 , page 144) variable, which defaults to every 60 seconds. If Mutt-ng was compiled with SSL support (by running the _c_o_n_f_i_g_u_r_e script with @@ -3128,8 +3217,8 @@ name@]popserver[:port]/. Another way to access your POP3 mail is the _f_e_t_c_h_-_m_a_i_l function (default: G). - It allows to connect to _p_o_p___h_o_s_t (section 7.4.211 , page 139), fetch all your - new mail and place it in the local _s_p_o_o_l_f_i_l_e (section 7.4.302 , page 160). + It allows to connect to _p_o_p___h_o_s_t (section 7.4.222 , page 143), fetch all your + new mail and place it in the local _s_p_o_o_l_f_i_l_e (section 7.4.313 , page 165). After this point, Mutt-ng runs exactly as if the mail had always been local. NNoottee:: If you only need to fetch all messages to local mailbox you should con- @@ -3146,9 +3235,6 @@ INBOX is the special name for your spool mailbox on the IMAP server. If you want to access another mail folder at the IMAP server, you should use imap://imapserver/path/to/folder where path/to/folder is the path of the folder - - The Mutt Next Generation E-Mail Client 63 - you want to access. You can select an alternative port by specifying it with the server, i.e.: @@ -3158,6 +3244,9 @@ name@imapserver[:port]/INBOX. If Mutt-ng was compiled with SSL support (by running the _c_o_n_f_i_g_u_r_e script with + + The Mutt Next Generation E-Mail Client 65 + the _-_-_w_i_t_h_-_s_s_l flag), connections to IMAP servers can be encrypted. This natu- rally requires that the server supports SSL encrypted connections. To access a folder with IMAP/SSL, you should use imaps://[user- @@ -3172,12 +3261,12 @@ 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 _t_o_g_g_l_e_-_s_u_b_s_c_r_i_b_e_d - command. See also the _$_i_m_a_p___l_i_s_t___s_u_b_s_c_r_i_b_e_d (section 7.4.101 , page 111) + command. See also the _$_i_m_a_p___l_i_s_t___s_u_b_s_c_r_i_b_e_d (section 7.4.103 , page 114) variable. Polling for new mail on an IMAP server can cause noticeable delays. So, you'll - want to carefully tune the _$_i_m_a_p___m_a_i_l___c_h_e_c_k (section 7.4.103 , page 111) and - _$_t_i_m_e_o_u_t (section 7.4.326 , page 168) variables. + want to carefully tune the _$_i_m_a_p___m_a_i_l___c_h_e_c_k (section 7.4.105 , page 114) and + _$_t_i_m_e_o_u_t (section 7.4.337 , page 172) variables. 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 @@ -3203,8 +3292,6 @@ respectively). You may also subscribe and unsubscribe to mailboxes (nor- mally these are bound to s and u, respectively). - The Mutt Next Generation E-Mail Client 64 - _4_._1_4_._2 _A_u_t_h_e_n_t_i_c_a_t_i_o_n Mutt-ng supports four authentication methods with IMAP servers: SASL, GSSAPI, @@ -3214,6 +3301,8 @@ 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". + The Mutt Next Generation E-Mail Client 66 + SASL is a special super-authenticator, which selects among several protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure method available on your host and the server. Using some of these methods (including @@ -3227,15 +3316,15 @@ There are a few variables which control authentication: - +o _$_i_m_a_p___u_s_e_r (section 7.4.109 , page 113) - controls the username under + +o _$_i_m_a_p___u_s_e_r (section 7.4.111 , page 115) - controls the username under which you request authentication on the IMAP server, for all authentica- tors. This is overridden by an explicit username in the mailbox path (i.e. by using a mailbox name of the form {user@host}). - +o _$_i_m_a_p___p_a_s_s (section 7.4.104 , page 112) - a password which you may pre- + +o _$_i_m_a_p___p_a_s_s (section 7.4.106 , page 114) - a password which you may pre- set, used by all authentication methods where a password is needed. - +o _$_i_m_a_p___a_u_t_h_e_n_t_i_c_a_t_o_r_s (section 7.4.95 , page 109) - a colon-delimited list + +o _$_i_m_a_p___a_u_t_h_e_n_t_i_c_a_t_o_r_s (section 7.4.97 , page 112) - 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 listed above). @@ -3248,7 +3337,7 @@ The Default newsserver can be obtained from the $NNTPSERVER environment vari- able. Like other news readers, info about subscribed newsgroups is saved in a - file as specified by the _$_n_n_t_p___n_e_w_s_r_c (section 7.4.161 , page 127) variable. + file as specified by the _$_n_n_t_p___n_e_w_s_r_c (section 7.4.172 , page 131) variable. Article headers are cached and can be loaded from a file when a newsgroup is entered instead loading from newsserver; currently, this caching mechanism still is different from the header caching for maildir/IMAP. @@ -3257,11 +3346,8 @@ Especially for Usenet, people often ask for advanced filtering and scoring functionality. Of course, mutt-ng has scoring and allows a killfile, too. How - - The Mutt Next Generation E-Mail Client 65 - to use a killfile has been discussed in _M_e_s_s_a_g_e _s_c_o_r_i_n_g (section 3.26 , page - 40). + 42). What has not been discusses in detail is mutt-ng's built-in realname filter. For may newsreaders including those for ``advanced users'' like _s_l_r_n or _t_i_n, @@ -3270,6 +3356,8 @@ In mutt-ng this is as easy as + The Mutt Next Generation E-Mail Client 67 + score ~* =42 This tells mutt-ng to apply a score of 42 to all messages whose sender speci- @@ -3297,29 +3385,30 @@ functionality. When configure was called with --with-libesmtp or the output muttng -v contains +USE_LIBESMTP, this will be or is the case already. The SMTP support includes support for Delivery Status Notification (see _D_e_l_i_v_e_r_y _S_t_a_t_u_s - _N_o_t_i_f_i_c_a_t_i_o_n (section 4.12 , page 61) section) as well as handling the 8BIT- - MIME flag controlled via _$_u_s_e___8_b_i_t_m_i_m_e (section 7.4.333 , page 169). + _N_o_t_i_f_i_c_a_t_i_o_n (section 4.12 , page 63) section) as well as handling the 8BIT- + MIME flag controlled via _$_u_s_e___8_b_i_t_m_i_m_e (section 7.4.344 , page 173). To enable sending mail directly via SMTP without an MTA such as Postfix or - SSMTP and the like, simply set the _$_s_m_t_p___h_o_s_t (section 7.4.291 , page 157) + SSMTP and the like, simply set the _$_s_m_t_p___h_o_s_t (section 7.4.302 , page 161) variable pointing to your SMTP server. - The Mutt Next Generation E-Mail Client 66 - - Authentication mechanisms are available via the _$_s_m_t_p___u_s_e_r (section 7.4.295 , - page 158) and _$_s_m_t_p___p_a_s_s (section 7.4.292 , page 157) variables. + Authentication mechanisms are available via the _$_s_m_t_p___u_s_e_r (section 7.4.306 , + page 162) and _$_s_m_t_p___p_a_s_s (section 7.4.303 , page 162) variables. Transport Encryption via the StartTLS command is also available. For this to work, first of all Mutt-ng must be built with SSL or GNUTLS. Secondly, the - _$_s_m_t_p___u_s_e___t_l_s (section 7.4.294 , page 158) variable must be either set to + _$_s_m_t_p___u_s_e___t_l_s (section 7.4.305 , page 162) variable must be either set to ``enabled'' or ``required.'' In both cases, StartTLS will be used if the server supports it: for the second case, the connection will fail if it doesn't while switching back to unencrypted communication for the first one. Some mail providers require user's to set a particular envelope sender, i.e. + + The Mutt Next Generation E-Mail Client 68 + they allow for only one value which may not be what the user wants to send as - the From: header. In this case, the variable _$_s_m_t_p___e_n_v_e_l_o_p_e (section 7.4.290 , - page 157) may be used to set the envelope different from the From: header. + the From: header. In this case, the variable _$_s_m_t_p___e_n_v_e_l_o_p_e (section 7.4.301 , + page 161) may be used to set the envelope different from the From: header. _4_._1_7 _M_a_n_a_g_i_n_g _m_u_l_t_i_p_l_e _I_M_A_P_/_P_O_P_/_N_N_T_P _a_c_c_o_u_n_t_s _(_O_P_T_I_O_N_A_L_) @@ -3353,8 +3442,6 @@ an arbitrary format, provided that the user has a script to convert from/to this format to one of the accepted. - The Mutt Next Generation E-Mail Client 67 - The most common use is to open compressed archived folders e.g. with gzip. In addition, the user can provide a script that gets a folder in an accepted @@ -3362,11 +3449,13 @@ may be faster than converting the entire folder to the accepted format, append- ing to it and converting back to the user-defined format. - There are three hooks defined (_o_p_e_n_-_h_o_o_k (section 4.19.1 , page 67), _c_l_o_s_e_- - _h_o_o_k (section 4.19.2 , page 67) and _a_p_p_e_n_d_-_h_o_o_k (section 4.19.3 , page 68)) + There are three hooks defined (_o_p_e_n_-_h_o_o_k (section 4.19.1 , page 69), _c_l_o_s_e_- + _h_o_o_k (section 4.19.2 , page 69) and _a_p_p_e_n_d_-_h_o_o_k (section 4.19.3 , page 70)) which define commands to uncompress and compress a folder and to append mes- sages to an existing compressed folder respectively. + The Mutt Next Generation E-Mail Client 69 + For example: open-hook \\.gz$ "gzip -cd %f > %t" @@ -3374,17 +3463,17 @@ append-hook \\.gz$ "gzip -c %t >> %f" You do not have to specify all of the commands. If you omit _a_p_p_e_n_d_-_h_o_o_k (sec- - tion 4.19.3 , page 68), the folder will be open and closed again each time you - will add to it. If you omit _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , page 67) (or give + tion 4.19.3 , page 70), the folder will be open and closed again each time you + will add to it. If you omit _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , page 69) (or give empty command) , the folder will be open in the mode. If you specify _a_p_p_e_n_d_- - _h_o_o_k (section 4.19.3 , page 68) though you'll be able to append to the folder. + _h_o_o_k (section 4.19.3 , page 70) though you'll be able to append to the folder. Note that Mutt-ng will only try to use hooks if the file is not in one of the accepted formats. In particular, if the file is empty, mutt supposes it is not compressed. This is important because it allows the use of programs that do not have well defined extensions. Just use '.' as a regexp. But this may be sur- prising if your compressing script produces empty files. In this situation, - unset _$_s_a_v_e___e_m_p_t_y (section 7.4.245 , page 147), so that the compressed file + unset _$_s_a_v_e___e_m_p_t_y (section 7.4.256 , page 151), so that the compressed file will be removed if you delete all of the messages. _4_._1_9_._1 _O_p_e_n _a _c_o_m_p_r_e_s_s_e_d _m_a_i_l_b_o_x _f_o_r _r_e_a_d_i_n_g @@ -3407,8 +3496,6 @@ Example: - The Mutt Next Generation E-Mail Client 68 - open-hook \\.gz$ "gzip -cd %f > %t" If the _c_o_m_m_a_n_d is empty, this operation is disabled for this file type. @@ -3418,12 +3505,14 @@ Usage: close-hook _r_e_g_e_x_p '_c_o_m_m_a_n_d' This is used to close the folder that was open with the _o_p_e_n_-_h_o_o_k (section - 4.19.1 , page 67) command after some changes were made to it. + 4.19.1 , page 69) command after some changes were made to it. + + The Mutt Next Generation E-Mail Client 70 The _c_o_m_m_a_n_d string is the command that can be used for closing the folders whose names match _r_e_g_e_x_p. It has the same format as in the _o_p_e_n_-_h_o_o_k (section - 4.19.1 , page 67) command. Temporary folder in this case is the folder previ- - ously produced by the <_o_p_e_n_-_h_o_o_k (section 4.19.1 , page 67) command. + 4.19.1 , page 69) command. Temporary folder in this case is the folder previ- + ously produced by the <_o_p_e_n_-_h_o_o_k (section 4.19.1 , page 69) command. The _c_o_m_m_a_n_d should nnoott remove the decompressed file. The _c_o_m_m_a_n_d should return non-zero exit status if it fails, so mutt knows something's wrong. @@ -3435,7 +3524,7 @@ If the _c_o_m_m_a_n_d is empty, this operation is disabled for this file type, and the file can only be open in the readonly mode. - _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , page 67) is not called when you exit from the + _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , page 69) is not called when you exit from the folder if the folder was not changed. _4_._1_9_._3 _A_p_p_e_n_d _a _m_e_s_s_a_g_e _t_o _a _c_o_m_p_r_e_s_s_e_d _m_a_i_l_b_o_x @@ -3444,7 +3533,7 @@ This command is used for saving to an existing compressed folder. The _c_o_m_m_a_n_d is the command that can be used for appending to the folders whose names match - _r_e_g_e_x_p. It has the same format as in the _o_p_e_n_-_h_o_o_k (section 4.19.1 , page 67) + _r_e_g_e_x_p. It has the same format as in the _o_p_e_n_-_h_o_o_k (section 4.19.1 , page 69) command. The temporary folder in this case contains the messages that are being appended. @@ -3455,23 +3544,22 @@ append-hook \\.gz$ "gzip -c %t >> %f" - When _a_p_p_e_n_d_-_h_o_o_k (section 4.19.3 , page 68) is used, the folder is not opened, + When _a_p_p_e_n_d_-_h_o_o_k (section 4.19.3 , page 70) is used, the folder is not opened, which saves time, but this means that we can not find out what the folder type - is. Thus the default (_$_m_b_o_x___t_y_p_e (section 7.4.130 , page 119)) type is always - - The Mutt Next Generation E-Mail Client 69 - + is. Thus the default (_$_m_b_o_x___t_y_p_e (section 7.4.132 , page 122)) type is always supposed (i.e. this is the format used for the temporary folder). If the file does not exist when you save to it, _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , - page 67) is called, and not _a_p_p_e_n_d_-_h_o_o_k (section 4.19.3 , page 68). _a_p_p_e_n_d_- - _h_o_o_k (section 4.19.3 , page 68) is only for appending to existing folders. + page 69) is called, and not _a_p_p_e_n_d_-_h_o_o_k (section 4.19.3 , page 70). _a_p_p_e_n_d_- + _h_o_o_k (section 4.19.3 , page 70) is only for appending to existing folders. If the _c_o_m_m_a_n_d is empty, this operation is disabled for this file type. In this case, the folder will be open and closed again (using _o_p_e_n_-_h_o_o_k (section - 4.19.1 , page 67) and _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , page 67)respectively) each + 4.19.1 , page 69) and _c_l_o_s_e_-_h_o_o_k (section 4.19.2 , page 69)respectively) each time you will add to it. + The Mutt Next Generation E-Mail Client 71 + _4_._1_9_._4 _E_n_c_r_y_p_t_e_d _f_o_l_d_e_r_s The compressed folders support can also be used to handle encrypted folders. If @@ -3508,9 +3596,6 @@ the message to a text representation. Mutt-ng internally supports a number of MIME types, including text/plain, text/enriched, message/rfc822, and mes- sage/news. In addition, the export controlled version of Mutt-ng recognizes a - - The Mutt Next Generation E-Mail Client 70 - variety of PGP MIME types, including PGP/MIME and application/pgp. Mutt-ng will denote attachments with a couple lines describing them. These @@ -3522,6 +3607,8 @@ Where the Description is the description or filename given for the attachment, and the Encoding is one of 7bit/8bit/quoted-printable/base64/binary. + The Mutt Next Generation E-Mail Client 72 + If Mutt-ng cannot deal with a MIME type, it will display a message like: [-- image/gif is unsupported (use 'v' to view this part) --] @@ -3562,9 +3649,6 @@ 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 (default: ^T). The next field is the encoding for the - - The Mutt Next Generation E-Mail Client 71 - attachment, which allows a binary message to be encoded for transmission on 7bit 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 @@ -3575,6 +3659,9 @@ _5_._2 _M_I_M_E _T_y_p_e _c_o_n_f_i_g_u_r_a_t_i_o_n _w_i_t_h _m_i_m_e_._t_y_p_e_s When you add an attachment to your mail message, Mutt-ng searches your personal + + The Mutt Next Generation E-Mail Client 73 + 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 @@ -3614,9 +3701,6 @@ In order to handle various MIME types that Mutt-ng can not handle internally, Mutt-ng parses a series of external configuration files to find an external - - The Mutt Next Generation E-Mail Client 72 - handler. The default search string for these files is a colon delimited list set to @@ -3627,6 +3711,8 @@ In particular, the metamail distribution will install a mailcap file, usually as /usr/local/etc/mailcap, which contains some baseline entries. + The Mutt Next Generation E-Mail Client 74 + _5_._3_._1 _T_h_e _B_a_s_i_c_s _o_f _t_h_e _m_a_i_l_c_a_p _f_i_l_e A mailcap file consists of a series of lines which are comments, blank, or def- @@ -3669,8 +3755,6 @@ text/html; lynx %s - The Mutt Next Generation E-Mail Client 73 - In this case, lynx does not support viewing a file from stdin, so you must use the %s syntax. NNoottee:: _S_o_m_e _o_l_d_e_r _v_e_r_s_i_o_n_s _o_f _l_y_n_x _c_o_n_t_a_i_n _a _b_u_g _w_h_e_r_e _t_h_e_y _w_i_l_l _c_h_e_c_k _t_h_e _m_a_i_l_c_a_p _f_i_l_e _f_o_r _a _v_i_e_w_e_r _f_o_r _t_e_x_t_/_h_t_m_l_. _T_h_e_y _w_i_l_l _f_i_n_d _t_h_e _l_i_n_e @@ -3680,6 +3764,8 @@ 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: + The Mutt Next Generation E-Mail Client 75 + text/html; lynx -dump %s | more Perhaps you wish to use lynx to view text/html files, and a pager on all other @@ -3695,7 +3781,7 @@ The interpretation of shell meta-characters embedded in MIME parameters can lead to security problems in general. Mutt-ng tries to quote parameters in expansion of %s syntaxes properly, and avoids risky characters by substituting - them, see the _m_a_i_l_c_a_p___s_a_n_i_t_i_z_e (section 7.4.121 , page 118) variable. + them, see the _m_a_i_l_c_a_p___s_a_n_i_t_i_z_e (section 7.4.123 , page 120) variable. 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. @@ -3721,8 +3807,6 @@ _5_._3_._3_._1 _O_p_t_i_o_n_a_l _F_i_e_l_d_s - The Mutt Next Generation E-Mail Client 74 - 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-ng recog- nizes the following optional fields: @@ -3732,6 +3816,9 @@ amounts of text on stdout. This causes Mutt-ng to invoke a pager (either the internal pager or the external pager defined by the pager variable) on the output of the view command. Without this + + The Mutt Next Generation E-Mail Client 76 + flag, Mutt-ng 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: @@ -3743,11 +3830,11 @@ needsterminal Mutt-ng uses this flag when viewing attachments with _a_u_t_o_v_i_e_w (sec- - tion 5.4 , page 77), in order to decide whether it should honor - the setting of the _$_w_a_i_t___k_e_y (section 7.4.339 , page 170) variable + tion 5.4 , page 79), in order to decide whether it should honor + the setting of the _$_w_a_i_t___k_e_y (section 7.4.350 , page 174) variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap entry has a _n_e_e_d_s_t_e_r_m_i_n_a_l flag, Mutt- - ng will use _$_w_a_i_t___k_e_y (section 7.4.339 , page 170) and the exit + ng will use _$_w_a_i_t___k_e_y (section 7.4.350 , page 174) and the exit status of the program to decide if it will ask you to press a key after the external program has exited. In all other situations it will not prompt you for a key. @@ -3775,8 +3862,6 @@ it to compose new attachments. Mutt-ng will default to the defined editor for text attachments. - The Mutt Next Generation E-Mail Client 75 - nametemplate=