- The Mutt E-Mail Client
- by Michael Elkins <me@cs.hmc.edu>
- version 1.5.7
-
- ``All mail clients suck. This one just sucks less.'' -me, circa 1995
- ______________________________________________________________________
-
- Table of Contents
-
- 1. Introduction
-
- 1.1 Mutt Home Page
- 1.2 Mailing Lists
- 1.3 Software Distribution Sites
- 1.4 IRC
- 1.5 USENET
- 1.6 Copyright
-
- 2. Getting Started
-
- 2.1 Moving Around in Menus
- 2.2 Editing Input Fields
- 2.3 Reading Mail - The Index and Pager
- 2.3.1 The Message Index
- 2.3.1.1 Status Flags
- 2.3.2 The Pager
- 2.3.3 Threaded Mode
- 2.3.4 Miscellaneous Functions
- 2.4 Sending Mail
- 2.4.1 Editing the message header
- 2.4.2 Using Mutt with PGP
- 2.4.3 Sending anonymous messages via mixmaster.
- 2.5 Forwarding and Bouncing Mail
- 2.6 Postponing Mail
- 2.7 Reading news via NNTP
-
- 3. Configuration
-
- 3.1 Syntax of Initialization Files
- 3.2 Defining/Using aliases
- 3.3 Changing the default key bindings
- 3.4 Defining aliases for character sets
- 3.5 Setting variables based upon mailbox
- 3.6 Keyboard macros
- 3.7 Using color and mono video attributes
- 3.8 Ignoring (weeding) unwanted message headers
- 3.9 Alternative addresses
- 3.10 Mailing lists
- 3.11 Using Multiple spool mailboxes
- 3.12 Defining mailboxes which receive mail
- 3.13 User defined headers
- 3.14 Defining the order of headers when viewing messages
- 3.15 Specify default save filename
- 3.16 Specify default Fcc: mailbox when composing
- 3.17 Specify default save filename and default Fcc: mailbox at once
- 3.18 Change settings based upon message recipients
- 3.19 Change settings before formatting a message
- 3.20 Choosing the cryptographic key of the recipient
- 3.21 Adding key sequences to the keyboard buffer
- 3.22 Executing functions
- 3.23 Message Scoring
- 3.24 Spam detection
- 3.25 Setting variables
- 3.26 Reading initialization commands from another file
- 3.27 Removing hooks
-
- 4. Advanced Usage
-
- 4.1 Regular Expressions
- 4.2 Patterns
- 4.2.1 Pattern Modifier
- 4.2.2 Complex Patterns
- 4.2.3 Searching by Date
- 4.3 Using Tags
- 4.4 Using Hooks
- 4.4.1 Message Matching in Hooks
- 4.5 External Address Queries
- 4.6 Mailbox Formats
- 4.7 Mailbox Shortcuts
- 4.8 Handling Mailing Lists
- 4.9 Delivery Status Notification (DSN) Support
- 4.10 POP3 Support (OPTIONAL)
- 4.11 IMAP Support (OPTIONAL)
- 4.11.1 The Folder Browser
- 4.11.2 Authentication
- 4.12 Managing multiple IMAP/POP accounts (OPTIONAL)
- 4.13 Start a WWW Browser on URLs (EXTERNAL)
-
- 5. Mutt's MIME Support
-
- 5.1 Using MIME in Mutt
- 5.1.1 Viewing MIME messages in the pager
- 5.1.2 The Attachment Menu
- 5.1.3 The Compose Menu
- 5.2 MIME Type configuration with
- 5.3 MIME Viewer configuration with
- 5.3.1 The Basics of the mailcap file
- 5.3.2 Secure use of mailcap
- 5.3.3 Advanced mailcap Usage
- 5.3.3.1 Optional Fields
- 5.3.3.2 Search Order
- 5.3.3.3 Command Expansion
- 5.3.4 Example mailcap files
- 5.4 MIME Autoview
- 5.5 MIME Multipart/Alternative
- 5.6 MIME Lookup
-
- 6. Reference
-
- 6.1 Command line options
- 6.2 Configuration Commands
- 6.3 Configuration variables
- 6.3.1 abort_nosubject
- 6.3.2 abort_unmodified
- 6.3.3 alias_file
- 6.3.4 alias_format
- 6.3.5 allow_8bit
- 6.3.6 allow_ansi
- 6.3.7 arrow_cursor
- 6.3.8 ascii_chars
- 6.3.9 askbcc
- 6.3.10 askcc
- 6.3.11 ask_follow_up
- 6.3.12 ask_x_comment_to
- 6.3.13 attach_format
- 6.3.14 attach_sep
- 6.3.15 attach_split
- 6.3.16 attribution
- 6.3.17 autoedit
- 6.3.18 auto_tag
- 6.3.19 beep
- 6.3.20 beep_new
- 6.3.21 bounce
- 6.3.22 bounce_delivered
- 6.3.23 catchup_newsgroup
- 6.3.24 charset
- 6.3.25 check_new
- 6.3.26 collapse_unread
- 6.3.27 uncollapse_jump
- 6.3.28 compose_format
- 6.3.29 confirmappend
- 6.3.30 confirmcreate
- 6.3.31 connect_timeout
- 6.3.32 content_type
- 6.3.33 copy
- 6.3.34 crypt_autopgp
- 6.3.35 crypt_autosmime
- 6.3.36 date_format
- 6.3.37 default_hook
- 6.3.38 delete
- 6.3.39 delete_untag
- 6.3.40 digest_collapse
- 6.3.41 display_filter
- 6.3.42 dotlock_program
- 6.3.43 dsn_notify
- 6.3.44 dsn_return
- 6.3.45 duplicate_threads
- 6.3.46 edit_headers
- 6.3.47 editor
- 6.3.48 encode_from
- 6.3.49 envelope_from
- 6.3.50 escape
- 6.3.51 fast_reply
- 6.3.52 fcc_attach
- 6.3.53 fcc_clear
- 6.3.54 folder
- 6.3.55 folder_format
- 6.3.56 followup_to
- 6.3.57 followup_to_poster
- 6.3.58 force_name
- 6.3.59 forward_decode
- 6.3.60 forward_edit
- 6.3.61 forward_format
- 6.3.62 forward_quote
- 6.3.63 from
- 6.3.64 gecos_mask
- 6.3.65 group_index_format
- 6.3.66 hdrs
- 6.3.67 header
- 6.3.68 help
- 6.3.69 hidden_host
- 6.3.70 hide_limited
- 6.3.71 hide_missing
- 6.3.72 hide_top_limited
- 6.3.73 hide_top_missing
- 6.3.74 history
- 6.3.75 honor_followup_to
- 6.3.76 hostname
- 6.3.77 ignore_list_reply_to
- 6.3.78 imap_authenticators
- 6.3.79 imap_delim_chars
- 6.3.80 imap_force_ssl
- 6.3.81 imap_home_namespace
- 6.3.82 imap_keepalive
- 6.3.83 imap_list_subscribed
- 6.3.84 imap_pass
- 6.3.85 imap_passive
- 6.3.86 imap_peek
- 6.3.87 imap_servernoise
- 6.3.88 imap_user
- 6.3.89 implicit_autoview
- 6.3.90 include
- 6.3.91 indent_string
- 6.3.92 index_format
- 6.3.93 inews
- 6.3.94 ispell
- 6.3.95 keep_flagged
- 6.3.96 locale
- 6.3.97 mail_check
- 6.3.98 mailcap_path
- 6.3.99 mailcap_sanitize
- 6.3.100 maildir_trash
- 6.3.101 mark_old
- 6.3.102 markers
- 6.3.103 mask
- 6.3.104 mbox
- 6.3.105 mbox_type
- 6.3.106 metoo
- 6.3.107 menu_scroll
- 6.3.108 meta_key
- 6.3.109 mh_purge
- 6.3.110 mh_seq_flagged
- 6.3.111 mh_seq_replied
- 6.3.112 mh_seq_unseen
- 6.3.113 mime_forward
- 6.3.114 mime_forward_decode
- 6.3.115 mime_forward_rest
- 6.3.116 mime_subject
- 6.3.117 mix_entry_format
- 6.3.118 mixmaster
- 6.3.119 move
- 6.3.120 message_format
- 6.3.121 narrow_tree
- 6.3.122 news_cache_dir
- 6.3.123 news_server
- 6.3.124 newsrc
- 6.3.125 nntp_context
- 6.3.126 nntp_load_description
- 6.3.127 nntp_user
- 6.3.128 nntp_pass
- 6.3.129 nntp_poll
- 6.3.130 nntp_reconnect
- 6.3.131 pager
- 6.3.132 pager_context
- 6.3.133 pager_format
- 6.3.134 pager_index_lines
- 6.3.135 pager_stop
- 6.3.136 crypt_autosign
- 6.3.137 crypt_autoencrypt
- 6.3.138 pgp_ignore_subkeys
- 6.3.139 crypt_replyencrypt
- 6.3.140 crypt_replysign
- 6.3.141 crypt_replysignencrypted
- 6.3.142 crypt_timestamp
- 6.3.143 pgp_use_gpg_agent
- 6.3.144 crypt_verify_sig
- 6.3.145 smime_is_default
- 6.3.146 smime_ask_cert_label
- 6.3.147 smime_decrypt_use_default_key
- 6.3.148 pgp_entry_format
- 6.3.149 pgp_good_sign
- 6.3.150 pgp_check_exit
- 6.3.151 pgp_long_ids
- 6.3.152 pgp_retainable_sigs
- 6.3.153 pgp_show_unusable
- 6.3.154 pgp_sign_as
- 6.3.155 pgp_strict_enc
- 6.3.156 pgp_timeout
- 6.3.157 pgp_sort_keys
- 6.3.158 pgp_create_traditional
- 6.3.159 pgp_auto_traditional
- 6.3.160 pgp_decode_command
- 6.3.161 pgp_getkeys_command
- 6.3.162 pgp_verify_command
- 6.3.163 pgp_decrypt_command
- 6.3.164 pgp_clearsign_command
- 6.3.165 pgp_sign_command
- 6.3.166 pgp_encrypt_sign_command
- 6.3.167 pgp_encrypt_only_command
- 6.3.168 pgp_import_command
- 6.3.169 pgp_export_command
- 6.3.170 pgp_verify_key_command
- 6.3.171 pgp_list_secring_command
- 6.3.172 pgp_list_pubring_command
- 6.3.173 forward_decrypt
- 6.3.174 smime_timeout
- 6.3.175 smime_encrypt_with
- 6.3.176 smime_keys
- 6.3.177 smime_ca_location
- 6.3.178 smime_certificates
- 6.3.179 smime_decrypt_command
- 6.3.180 smime_verify_command
- 6.3.181 smime_verify_opaque_command
- 6.3.182 smime_sign_command
- 6.3.183 smime_sign_opaque_command
- 6.3.184 smime_encrypt_command
- 6.3.185 smime_pk7out_command
- 6.3.186 smime_get_cert_command
- 6.3.187 smime_get_signer_cert_command
- 6.3.188 smime_import_cert_command
- 6.3.189 smime_get_cert_email_command
- 6.3.190 smime_default_key
- 6.3.191 ssl_starttls
- 6.3.192 certificate_file
- 6.3.193 ssl_usesystemcerts
- 6.3.194 entropy_file
- 6.3.195 ssl_use_sslv2
- 6.3.196 ssl_use_sslv3
- 6.3.197 ssl_use_tlsv1
- 6.3.198 pipe_split
- 6.3.199 pipe_decode
- 6.3.200 pipe_sep
- 6.3.201 pop_authenticators
- 6.3.202 pop_auth_try_all
- 6.3.203 pop_checkinterval
- 6.3.204 pop_delete
- 6.3.205 pop_host
- 6.3.206 pop_last
- 6.3.207 pop_reconnect
- 6.3.208 pop_user
- 6.3.209 pop_pass
- 6.3.210 post_indent_string
- 6.3.211 post_moderated
- 6.3.212 postpone
- 6.3.213 postponed
- 6.3.214 preconnect
- 6.3.215 print
- 6.3.216 print_command
- 6.3.217 print_decode
- 6.3.218 print_split
- 6.3.219 prompt_after
- 6.3.220 query_command
- 6.3.221 quit
- 6.3.222 quote_regexp
- 6.3.223 read_inc
- 6.3.224 read_only
- 6.3.225 realname
- 6.3.226 recall
- 6.3.227 record
- 6.3.228 reply_regexp
- 6.3.229 reply_self
- 6.3.230 reply_to
- 6.3.231 resolve
- 6.3.232 reverse_alias
- 6.3.233 reverse_name
- 6.3.234 reverse_realname
- 6.3.235 rfc2047_parameters
- 6.3.236 save_address
- 6.3.237 save_empty
- 6.3.238 save_name
- 6.3.239 score
- 6.3.240 score_threshold_delete
- 6.3.241 score_threshold_flag
- 6.3.242 score_threshold_read
- 6.3.243 send_charset
- 6.3.244 sendmail
- 6.3.245 sendmail_wait
- 6.3.246 shell
- 6.3.247 save_unsubscribed
- 6.3.248 show_new_news
- 6.3.249 show_only_unread
- 6.3.250 sig_dashes
- 6.3.251 sig_on_top
- 6.3.252 signature
- 6.3.253 simple_search
- 6.3.254 smart_wrap
- 6.3.255 smileys
- 6.3.256 sleep_time
- 6.3.257 sort
- 6.3.258 sort_alias
- 6.3.259 sort_aux
- 6.3.260 sort_browser
- 6.3.261 sort_re
- 6.3.262 spoolfile
- 6.3.263 status_chars
- 6.3.264 status_format
- 6.3.265 status_on_top
- 6.3.266 strict_threads
- 6.3.267 suspend
- 6.3.268 text_flowed
- 6.3.269 thread_received
- 6.3.270 thorough_search
- 6.3.271 tilde
- 6.3.272 timeout
- 6.3.273 tmpdir
- 6.3.274 to_chars
- 6.3.275 tunnel
- 6.3.276 use_8bitmime
- 6.3.277 use_domain
- 6.3.278 use_from
- 6.3.279 use_ipv6
- 6.3.280 user_agent
- 6.3.281 visual
- 6.3.282 wait_key
- 6.3.283 weed
- 6.3.284 wrap_search
- 6.3.285 wrapmargin
- 6.3.286 write_inc
- 6.3.287 write_bcc
- 6.3.288 x_comment_to
- 6.4 Functions
- 6.4.1 generic
- 6.4.2 index
- 6.4.3 pager
- 6.4.4 alias
- 6.4.5 query
- 6.4.6 attach
- 6.4.7 compose
- 6.4.8 postpone
- 6.4.9 browser
- 6.4.10 pgp
- 6.4.11 editor
-
- 7. Miscellany
-
- 7.1 Acknowledgements
- 7.2 About this document
-
- ______________________________________________________________________
-
- \e[1m1. Introduction\e[0m
-
- \e[1mMutt \e[22mis a small but very powerful text-based MIME mail client. Mutt
- is highly configurable, and is well suited to the mail power user with
- advanced features like key bindings, keyboard macros, mail threading,
- regular expression searches and a powerful pattern matching language
- for selecting groups of messages.
-
- \e[1m1.1. Mutt Home Page\e[0m
-
- http://www.mutt.org/
-
- \e[1m1.2. Mailing Lists\e[0m
-
- To subscribe to one of the following mailing lists, send a message
- with the word \e[4msubscribe\e[24m in the body to list-name\e[4m-request\e[24m@mutt.org.
-
- · mutt-announce@mutt.org -- low traffic list for announcements
-
- · mutt-users@mutt.org -- help, bug reports and feature requests
-
- · mutt-dev@mutt.org -- development mailing list
-
- \e[1mNote: \e[22mall messages posted to \e[4mmutt-announce\e[24m are automatically forwarded
- to \e[4mmutt-users\e[24m, so you do not need to be subscribed to both lists.
-
- \e[1m1.3. Software Distribution Sites\e[0m
-
- · ftp://ftp.mutt.org/mutt/
-
- For a list of mirror sites, please refer to
- http://www.mutt.org/download.html.
-
- \e[1m1.4. IRC\e[0m
-
- Visit channel \e[4m#mutt\e[24m on OpenProjects.Net (www.openprojects.net) to chat
- with other people interested in Mutt.
-
- \e[1m1.5. USENET\e[0m
-
- See the newsgroup comp.mail.mutt.
-
- \e[1m1.6. Copyright\e[0m
-
- Mutt is Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu> and
- others
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or (at
- your option) any later version.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
-
- \e[1m2. Getting Started\e[0m
-
- 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.
-
- 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.
-
- 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''.
-
- \e[1m2.1. Moving Around in Menus\e[0m
-
- Information is presented in menus, very similar to ELM. Here is a
- table showing the common keys used to navigate menus in Mutt.
-
- 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
- 2\b2.\b.2\b2.\b. E\bEd\bdi\bit\bti\bin\bng\bg I\bIn\bnp\bpu\but\bt F\bFi\bie\bel\bld\bds\bs
+The Mutt Next Generation E-Mail Client
+
+by Andreas Krennmair and others originally based on mutt by Michael Elkins and others
+
+ version devel-r473
+
+ Abstract
+
+ Michael Elinks on mutt, circa 1995: ``All mail clients suck. This one just sucks less.'' - Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
+ _________________________________________________________________
+
+ Table of Contents
+
+ 1. Introduction
+
+ 1. Overview
+ 2. Mutt-ng Home Page
+ 3. Mailing Lists
+ 4. Software Distribution Sites
+ 5. IRC
+ 6. Weblog
+ 7. Copyright
+
+ 2. Getting Started
+
+ 1. Basic Concepts
+
+ 1.1. Screens and Menus
+ 1.2. Configuration
+ 1.3. Functions
+ 1.4. Interaction
+ 1.5. Modularization
+ 1.6. Patterns
+
+ 2. Screens and Menus
+
+ 2.1. Index
+ 2.2. Pager
+ 2.3. File Browser
+ 2.4. Sidebar
+ 2.5. Help
+ 2.6. Compose Menu
+ 2.7. Alias Menu
+ 2.8. Attachment Menu
+ 2.9. Key Menu
+
+ 3. Moving Around in Menus
+ 4. Editing Input Fields
+ 5. Reading Mail - The Index and Pager
+
+ 5.1. The Message Index
+ 5.2. The Pager
+ 5.3. Threaded Mode
+ 5.4. Miscellaneous Functions
+
+ 6. Sending Mail
+
+ 6.1. Composing new messages
+ 6.2. Replying
+ 6.3. Editing the message header
+ 6.4. Using Mutt-ng with PGP
+ 6.5. Sending anonymous messages via mixmaster
+
+ 7. Forwarding and Bouncing Mail
+ 8. Postponing Mail
- Mutt has a builtin line editor which is used as the primary way to
- input textual data such as email addresses or filenames. The keys
- used to move around while editing are very similar to those of Emacs.
+ 3. Configuration
+
+ 1. Locations of Configuration Files
+ 2. Basic Syntax of Initialization Files
+ 3. Expansion within variables
- ^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 ot 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
- ^G n/a abort
- <Return> n/a finish editing
+ 3.1. Commands' Output
+ 3.2. Environment Variables
+ 3.3. Configuration Variables
+ 3.4. Self-Defined Variables
+ 3.5. Pre-Defined Variables
+ 3.6. Type Conversions
- You can remap the _\be_\bd_\bi_\bt_\bo_\br functions using the ``bind'' command. For
- example, to make the _\bD_\be_\bl_\be_\bt_\be key delete the character in front of the
- cursor rather than under, you could use
+ 4. Defining/Using aliases
+ 5. Changing the default key bindings
+ 6. Defining aliases for character sets
+ 7. Setting variables based upon mailbox
+ 8. Keyboard macros
+ 9. Using color and mono video attributes
+ 10. Ignoring (weeding) unwanted message headers
+ 11. Alternative addresses
+ 12. Format = Flowed
- bind editor <delete> backspace
+ 12.1. Introduction
+ 12.2. Receiving: Display Setup
+ 12.3. Sending
+ 12.4. Additional Notes
- 2\b2.\b.3\b3.\b. R\bRe\bea\bad\bdi\bin\bng\bg M\bMa\bai\bil\bl -\b- T\bTh\bhe\be I\bIn\bnd\bde\bex\bx a\ban\bnd\bd P\bPa\bag\bge\ber\br
+ 13. Mailing lists
+ 14. Using Multiple spool mailboxes
+ 15. Defining mailboxes which receive mail
+ 16. User defined headers
+ 17. Defining the order of headers when viewing messages
+ 18. Specify default save filename
+ 19. Specify default Fcc: mailbox when composing
+ 20. Specify default save filename and default Fcc: mailbox at once
+ 21. Change settings based upon message recipients
+ 22. Change settings before formatting a message
+ 23. Choosing the cryptographic key of the recipient
+ 24. Adding key sequences to the keyboard buffer
+ 25. Executing functions
+ 26. Message Scoring
+ 27. Spam detection
+ 28. Setting variables
+ 29. Reading initialization commands from another file
+ 30. Removing hooks
+ 31. Sharing Setups
+
+ 31.1. Character Sets
+ 31.2. Modularization
+ 31.3. Conditional parts
+
+ 32. Obsolete Variables
+
+ 4. Advanced Usage
+
+ 1. Regular Expressions
+ 2. Patterns
+
+ 2.1. Complex Patterns
+ 2.2. Patterns and Dates
+
+ 3. Format Strings
+
+ 3.1. Introduction
+ 3.2. Conditional Expansion
+ 3.3. Modifications and Padding
+
+ 4. Using Tags
+ 5. Using Hooks
+
+ 5.1. Message Matching in Hooks
+
+ 6. Using the sidebar
+ 7. External Address Queries
+ 8. Mailbox Formats
+ 9. Mailbox Shortcuts
+ 10. Handling Mailing Lists
+ 11. Editing threads
- 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.''
+ 11.1. Linking threads
+ 11.2. Breaking threads
- The next few sections describe the functions provided in each of these
- modes.
+ 12. Delivery Status Notification (DSN) Support
+ 13. POP3 Support (OPTIONAL)
+ 14. IMAP Support (OPTIONAL)
- 2\b2.\b.3\b3.\b.1\b1.\b. T\bTh\bhe\be M\bMe\bes\bss\bsa\bag\bge\be I\bIn\bnd\bde\bex\bx
+ 14.1. The Folder Browser
+ 14.2. Authentication
- c change to a different mailbox
- ESC c change to a folder in read-only mode
- C copy the current message to another mailbox
- ESC C decode a message and copy it to a folder
- ESC s decode a message and save it to a folder
- D delete messages matching a pattern
- d delete the current message
- F mark as important
- l show messages matching a pattern
- N mark message as new
- o change the current sort method
- O reverse sort the mailbox
- q save changes and exit
- s save-message
- T tag messages matching a pattern
- t toggle the tag on a message
- ESC t toggle tag on entire message thread
- U undelete messages matching a pattern
- u undelete-message
- v view-attachments
- x abort changes and exit
- <Return> display-message
- <Tab> jump to the next new message
- @ show the author's full e-mail address
- $ save changes to mailbox
- / search
- ESC / search-reverse
- ^L clear and redraw the screen
- ^T untag messages matching a pattern
-
- 2\b2.\b.3\b3.\b.1\b1.\b.1\b1.\b. S\bSt\bta\bat\btu\bus\bs F\bFl\bla\bag\bgs\bs
-
- 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:
-
- D\bD message is deleted (is marked for deletion)
-
- d\bd message have attachments marked for deletion
-
- K\bK contains a PGP public key
-
- N\bN message is new
-
- O\bO message is old
-
- P\bP message is PGP encrypted
-
- r\br message has been replied to
-
- S\bS message is signed, and the signature is succesfully verified
-
- s\bs message is signed
-
- !\b! message is flagged
-
- *\b* message is tagged
-
- Some of the status flags can be turned on or off using
-
- · s\bse\bet\bt-\b-f\bfl\bla\bag\bg (default: w)
-
- · c\bcl\ble\bea\bar\br-\b-f\bfl\bla\bag\bg (default: W)
-
- Furthermore, the following flags reflect who the message is addressed
- to. They can be customized with the ``$to_chars'' variable.
-
- +\b+ message is to you and you only
-
- T\bT message is to you, but also to or cc'ed to others
-
- C\bC message is cc'ed to you
-
- F\bF message is from you
-
- L\bL message is sent to a subscribed mailing list
-
- 2\b2.\b.3\b3.\b.2\b2.\b. T\bTh\bhe\be P\bPa\bag\bge\ber\br
-
- By default, Mutt uses its builtin pager to display the body of
- messages. The pager is very similar to the Unix program _\bl_\be_\bs_\bs though
- not nearly as featureful.
-
- <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
- n search for next match
- S skip beyond quoted text
- T toggle 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, many of the functions from the \e[4mindex\e[24m are available in the
- pager, such as \e[4mdelete-message\e[24m or \e[4mcopy-message\e[24m (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:
-
- ESC [ Ps;Ps;Ps;...;Ps m
- where Ps =
- 0 All Attributes Off
- 1 Bold on
- 4 Underline on
- 5 Blink on
- 7 Reverse video on
- 3x Foreground color is x
- 4x Background color is x
+ 15. NNTP Support (OPTIONAL)
- Colors are
- 0 black
- 1 red
- 2 green
- 3 yellow
- 4 blue
- 5 magenta
- 6 cyan
- 7 white
+ 15.1. Again: Scoring
- Mutt uses these attributes for handling text/enriched messages, and
- they can also be used by an external ``autoview'' script for
- highlighting purposes. N\bNo\bot\bte\be:\b: 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.
+ 16. SMTP Support (OPTIONAL)
+ 17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)
+ 18. Start a WWW Browser on URLs (EXTERNAL)
+ 19. Compressed folders Support (OPTIONAL)
- 2\b2.\b.3\b3.\b.3\b3.\b. T\bTh\bhr\bre\bea\bad\bde\bed\bd M\bMo\bod\bde\be
+ 19.1. Open a compressed mailbox for reading
+ 19.2. Write a compressed mailbox
+ 19.3. Append a message to a compressed mailbox
+ 19.4. Encrypted folders
- When the mailbox is ``sorted'' by _\bt_\bh_\br_\be_\ba_\bd_\bs, there are a few additional
- functions available in the _\bi_\bn_\bd_\be_\bx and _\bp_\ba_\bg_\be_\br modes.
+ 5. Mutt-ng's MIME Support
- ^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
-
- N\bNo\bot\bte\be:\b: 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.
-
- See also: ``$strict_threads''.
-
- \e[1m2.3.4. Miscellaneous Functions\e[0m
-
- \e[1mcreate-alias \e[22m(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.
- \e[1mNote: \e[22mSpecifying an ``$alias_file'' does not add the aliases specified
- there-in, you must also ``source'' the file.
-
- \e[1mcheck-traditional-pgp \e[22m(default: ESC P)
-
- This function will search the current message for content signed or
- 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 effect.
-
- \e[1mdisplay-toggle-weed \e[22m(default: h)
-
- Toggles the weeding of message header fields specified by ``ignore''
- commands.
-
- \e[1medit \e[22m(default: e)
-
- 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.
-
- \e[1medit-type\e[0m
- (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 invoked
- from the index or from the pager, you'll have the opportunity to edit
- the top-level attachment's content type. On the ``attachment menu'',
- 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 ``compose menu''.
- There, it's used to fine-tune the properties of attachments you are
- going to send.
-
- \e[1menter-command \e[22m(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.
-
- \e[1mextract-keys \e[22m(default: ^K)
-
- This command extracts PGP public keys from the current or tagged
- message(s) and adds them to your PGP public key ring.
-
- \e[1mforget-passphrase \e[22m(default: ^F)
-
- This command wipes the passphrase(s) from memory. It is useful, if you
- misspelled the passphrase.
-
- \e[1mlist-reply \e[22m(default: L)
-
- Reply to the current or tagged message(s) by extracting any addresses
- which match the addresses 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.
-
- \e[1mpipe-message \e[22m(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 behaviour of this
- function.
-
- \e[1mresend-message \e[22m(default: ESC e)
-
- With resend-message, 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 included here depends on the value of the ``$weed''
- 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.
-
- s\bsh\bhe\bel\bll\bl-\b-e\bes\bsc\bca\bap\bpe\be (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.
-
- t\bto\bog\bgg\bgl\ble\be-\b-q\bqu\buo\bot\bte\bed\bd (default: T)
-
- The _\bp_\ba_\bg_\be_\br 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 quoted text in the way.
-
- s\bsk\bki\bip\bp-\b-q\bqu\buo\bot\bte\bed\bd (default: S)
-
- This function will go to the next line of non-quoted text which come
- after a line of quoted text in the internal pager.
-
- 2\b2.\b.4\b4.\b. S\bSe\ben\bnd\bdi\bin\bng\bg M\bMa\bai\bil\bl
-
- The following bindings are available in the _\bi_\bn_\bd_\be_\bx for sending
- messages.
-
- 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 modify
- the message you are forwarding. These items are discussed in greater
- detail in the next chapter ````Forwarding and Bouncing Mail''''.
-
- Mutt will then enter the _\bc_\bo_\bm_\bp_\bo_\bs_\be 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 ``$askcc'',
- ``$askbcc'', ``$autoedit'', ``$bounce'', and ``$fast_reply'' for
- changing how 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.
-
- Once you have finished editing the body of your mail message, you are
- returned to the _\bc_\bo_\bm_\bp_\bo_\bs_\be menu. The following options are available:
-
- 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
-
- N\bNo\bot\bte\be:\b: 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
- 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.
-
- \e[1m2.4.1. Editing the message header\e[0m
-
- When editing the header of your outgoing message, there are a couple
- of special features available.
-
- If you specify
- Fcc: \e[4mfilename\e[0m
- Mutt will pick up \e[4mfilename\e[24m just as if you had used the \e[4medit-fcc\e[0m
- function in the \e[4mcompose\e[24m menu.
-
- You can also attach files to your message by specifying
- Attach: \e[4mfilename\e[24m [ \e[4mdescription\e[24m ]
- where \e[4mfilename\e[24m is the file to attach and \e[4mdescription\e[24m is an optional
- string to use as the description of the attached file.
-
- When replying to messages, if you remove the \e[4mIn-Reply-To:\e[24m field from
- the header field, Mutt will not generate a \e[4mReferences:\e[24m field, which
- allows you to create a new message thread.
-
- Also see ``edit_headers''.
-
- \e[1m2.4.2. Using Mutt with PGP\e[0m
-
- If you want to use PGP, you can specify
-
- Pgp: [ E | S | S\e[4m<id>\e[24m ]
-
- ``E'' encrypts, ``S'' signs and ``S<id>'' signs with the given key,
- setting ``$pgp_sign_as'' 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 will not ask you any questions about keys which have a certified
- user ID matching one of the message recipients' mail addresses.
- However, there may be situations in which there are several keys,
- weakly certified user ID fields, or where no matching 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 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 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.
-
- 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 following flags:
-
- R The key has been revoked and can't be used.
- X The key is expired and can't be used.
- d You have marked the key as disabled.
- c There are unknown critical self-signature
- packets.
-
- 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 (\e[1m-\e[22m) means that the key
- cannot be used for encryption. A dot (\e[1m.\e[22m) 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[1me \e[22mindicates that this key can be used for
- encryption.
-
- The second character indicates the key's signing capabilities. Once
- again, a ``\e[1m-\e[22m'' implies ``not for signing'', ``\e[1m.\e[22m'' implies that the key
- is marked as an encryption key in one of the user-ids, and ``\e[1ms\e[22m''
- 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 (\e[1m?\e[22m) indicates undefined validity, a minus
- character (\e[1m-\e[22m) marks an untrusted association, a space character means
- a partially trusted association, and a plus character (\e[1m+\e[22m) indicates
- complete validity.
-
- \e[1m2.4.3. Sending anonymous messages via mixmaster.\e[0m
-
- 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.
-
- \e[1m2.5. Forwarding and Bouncing Mail\e[0m
-
- 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 following keys are bound by default:
-
- f forward forward message
- b bounce bounce (remail) message
-
- Forwarding can be done by including the original message in the new
- 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 \e[4m$mime_forward\e[24m is a quadoption which, for
- example, can be set to ``ask-no''.
-
- The inclusion of headers is controlled by the current setting of the
- ``$weed'' variable, unless ``mime_forward'' is set.
-
- Editing the message to forward follows the same procedure as sending
- or replying to a message does.
-
- 2\b2.\b.6\b6.\b. P\bPo\bos\bst\btp\bpo\bon\bni\bin\bng\bg M\bMa\bai\bil\bl
-
- At times it is desirable to delay sending a message that you have
- already begun to compose. When the _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be function is used
- in the _\bc_\bo_\bm_\bp_\bo_\bs_\be 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.
-
- 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 _\bc_\bo_\bm_\bp_\bo_\bs_\be
- a new message from the _\bi_\bn_\bd_\be_\bx or _\bp_\ba_\bg_\be_\br you will be prompted if
- postponed messages exist. If multiple messages are currently
- postponed, the _\bp_\bo_\bs_\bt_\bp_\bo_\bn_\be_\bd menu will pop up and you can select which
- message you would like to resume.
-
- N\bNo\bot\bte\be:\b: 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.
-
- 2\b2.\b.7\b7.\b. R\bRe\bea\bad\bdi\bin\bng\bg n\bne\bew\bws\bs v\bvi\bia\ba N\bNN\bNT\bTP\bP
-
- If compiled with ``--enable-nntp'' option, Mutt can read news from
- newsserver via NNTP. You can open a newsgroup with function ``change-
- newsgroup'' (default: i). Default newsserver can be obtained from
- _\bN_\bN_\bT_\bP_\bS_\bE_\bR_\bV_\bE_\bR environment variable. Like other news readers, info about
- subscribed newsgroups is saved in file by ``$newsrc'' variable.
- Article headers are cached and can be loaded from file when newsgroup
- entered instead loading from newsserver.
-
- 3\b3.\b. C\bCo\bon\bnf\bfi\big\bgu\bur\bra\bat\bti\bio\bon\bn
-
- 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 /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.
-
- .muttrc is the file where you will usually place your ``commands'' to
- configure Mutt.
- 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 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 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: V) from the index menu.
-
- \e[1m3.1. Syntax of Initialization Files\e[0m
-
- 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 (;).
-
- set realname='Mutt user' ; ignore x-
-
- The hash mark, or pound sign (``#''), is used as a ``comment'' charac
- ter. 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,
-
- 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
- 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 \e[1mnot \e[22mfor 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 character.
-
- set realname="Michael \"MuttDude\" Elkins"
-
- ``\\'' 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.
-
- 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,
-
- 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.
-
- UNIX environments can be accessed like the way it is done in shells
- like sh and bash: Prepend the name of the environment by a ``$''. For
- example,
-
- set record=+sent_on_$HOSTNAME
-
- The commands understood by mutt are explained in the next paragraphs.
- For a complete list, see the ``command reference''.
-
- \e[1m3.2. Defining/Using aliases\e[0m
-
- Usage: alias \e[4mkey\e[24m \e[4maddress\e[24m [ , \e[4maddress\e[24m, ... ]
-
- 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 a short string to a full address.
-
- \e[1mNote: \e[22mif you want to create an alias for a group (by specifying more
- than one address), you \e[1mmust \e[22mseparate the addresses with a comma
- (``,'').
-
- To remove an alias or aliases (``*'' means all aliases):
-
- unalias [ * | \e[4mkey\e[24m \e[4m...\e[24m ]
-
- 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.
-
- 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.
- For example:
-
- 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 prompts for addresses, such as the \e[4mTo:\e[24m or \e[4mCc:\e[24m prompt. You can
- also enter aliases in your editor at the appropriate headers if you
- have the ``$edit_headers'' 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 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 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
- \e[4mselect-entry\e[24m key (default: RET), and use the \e[4mexit\e[24m key (default: q) to
- return to the address prompt.
-
- \e[1m3.3. Changing the default key bindings\e[0m
-
- Usage: bind \e[4mmap\e[24m \e[4mkey\e[24m \e[4mfunction\e[0m
-
- This command allows you to change the default key bindings (operation
- invoked when pressing a key).
-
- \e[4mmap\e[24m specifies in which menu the binding belongs. Multiple maps may be
- specified by separating them with commas (no additional whitespace is
- allowed). The currently defined maps are:
-
- \e[1mgeneric\e[0m
- 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.
-
- \e[1malias\e[0m
- 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 address(es) of the recipient(s).
-
- \e[1mattach\e[0m
- The attachment menu is used to access the attachments on
- received messages.
-
- \e[1mbrowser\e[0m
- The browser is used for both browsing the local directory
- structure, and for listing all of your incoming mailboxes.
-
- \e[1meditor\e[0m
- The editor is the line-based editor the user enters text data.
-
- \e[1mindex\e[0m
- The index is the list of messages contained in a mailbox.
-
- \e[1mcompose\e[0m
- The compose menu is the screen used when sending a new message.
-
- \e[1mpager\e[0m
- The pager is the mode used to display message/attachment data,
- and help listings.
-
- \e[1mpgp\e[0m
- The pgp menu is used to select the OpenPGP keys used for
- encrypting outgoing messages.
-
- \e[1mpostpone\e[0m
- The postpone menu is similar to the index menu, except is used
- when recalling a message the user was composing, but saved until
- later.
-
- \e[4mkey\e[24m is the key (or key sequence) you wish to bind. To specify a
- control character, use the sequence \e[4m\Cx\e[24m, where \e[4mx\e[24m is the letter of the
- control character (for example, to specify control-A use ``\Ca'').
- Note that the case of \e[4mx\e[24m as well as \e[4m\C\e[24m is ignored, so that \e[4m\CA\e[24m, \e[4m\Ca\e[24m,
- \e[4m\cA\e[24m and \e[4m\ca\e[24m are all equivalent. An alternative form is to specify the
- key as a three digit octal number prefixed with a ``\'' (for example
- \e[4m\177\e[24m is equivalent to \e[4m\c?\e[24m).
-
- In addition, \e[4mkey\e[24m may consist of:
-
- \t tab
- <tab> tab
- \r carriage return
- \n newline
- \e escape
- <esc> escape
- <up> up arrow
- <down> down arrow
- <left> left arrow
- <right> right arrow
- <pageup> Page Up
- <pagedown> Page Down
- <backspace> Backspace
- <delete> Delete
- <insert> Insert
- <enter> Enter
- <return> Return
- <home> Home
- <end> End
- <space> Space bar
- <f1> function key 1
- <f10> function key 10
-
- \e[4mkey\e[24m does not need to be enclosed in quotes unless it contains a space
- (`` '').
-
- \e[4mfunction\e[24m specifies which action to take when \e[4mkey\e[24m is pressed. For a
- complete list of functions, see the ``reference''. The special
- function noop unbinds the specified key sequence.
-
- \e[1m3.4. Defining aliases for character sets\e[0m
+ 1. Using MIME in Mutt
- Usage: charset-hook \e[4malias\e[24m \e[4mcharset\e[0m
- Usage: iconv-hook \e[4mcharset\e[24m \e[4mlocal-charset\e[0m
+ 1.1. Viewing MIME messages in the pager
+ 1.2. The Attachment Menu
+ 1.3. The Compose Menu
- 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.
+ 2. MIME Type configuration with mime.types
+ 3. MIME Viewer configuration with mailcap
- 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.
+ 3.1. The Basics of the mailcap file
+ 3.2. Secure use of mailcap
+ 3.3. Advanced mailcap Usage
+ 3.4. Example mailcap files
- \e[1m3.5. Setting variables based upon mailbox\e[0m
+ 4. MIME Autoview
+ 5. MIME Multipart/Alternative
+ 6. MIME Lookup
- Usage: folder-hook [!]\e[4mregexp\e[24m \e[4mcommand\e[0m
+ 6. Security Considerations
- 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 any configuration command. \e[4mregexp\e[24m is a regular expression
- specifying in which mailboxes to execute \e[4mcommand\e[24m before loading. If a
- mailbox matches multiple folder-hook's, they are executed in the order
- given in the muttrc.
+ 1. Passwords
+ 2. Temporary Files
+ 3. Information Leaks
- \e[1mNote: \e[22mif 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 \e[4mnot\e[24m operator for
- the expression.
+ 3.1. Message-ID: headers
+ 3.2. mailto:-style links
- Note that the settings are \e[4mnot\e[24m 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:
+ 4. External applications
- folder-hook mutt set sort=threads
+ 4.1. mailcap
+ 4.2. Other
- However, the sorting method is not restored to its previous value when
- reading a different mailbox. To specify a \e[4mdefault\e[24m command, use the
- pattern ``.'':
+ 7. Reference
- folder-hook . set sort=date-sent
+ 1. Command line options
+ 2. Patterns
+ 3. Configuration Commands
+ 4. Configuration variables
+ 5. Functions
- \e[1m3.6. Keyboard macros\e[0m
+ 5.1. generic
+ 5.2. index
+ 5.3. pager
+ 5.4. alias
+ 5.5. query
+ 5.6. attach
+ 5.7. compose
+ 5.8. postpone
+ 5.9. browser
+ 5.10. pgp
+ 5.11. editor
- Usage: macro \e[4mmenu\e[24m \e[4mkey\e[24m \e[4msequence\e[24m [ \e[4mdescription\e[24m ]
+ 8. Miscellany
- Macros are useful when you would like a single key to perform a series
- of actions. When you press \e[4mkey\e[24m in menu \e[4mmenu\e[24m, Mutt will behave as if
- you had typed \e[4msequence\e[24m. So if you have a common sequence of commands
- you type, you can create a macro to execute those commands with a
- single key.
+ 1. Acknowledgments
- \e[4mmenu\e[24m is the ``map'' which the macro will be bound. 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.
+Chapter 1. Introduction
- \e[4mkey\e[24m and \e[4msequence\e[24m are expanded by the same rules as the ``key
- bindings''. There are some additions however. The first is that
- control characters in \e[4msequence\e[24m can also be specified as \e[4m^x\e[24m. In order
- to get a caret (`^'') you need to use \e[4m^^\e[24m. Secondly, to specify a
- certain key such as \e[4mup\e[24m or to invoke a function directly, you can use
- the format \e[4m<key\e[24m \e[4mname>\e[24m and \e[4m<function\e[24m \e[4mname>\e[24m. For a listing of key names
- see the section on ``key bindings''. Functions are listed in the
- ``function reference''.
+ Table of Contents
- The advantage with using function names directly is that the macros
- will work 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 (eg. the system Muttrc).
+ 1. Overview
+ 2. Mutt-ng Home Page
+ 3. Mailing Lists
+ 4. Software Distribution Sites
+ 5. IRC
+ 6. Weblog
+ 7. Copyright
- Optionally you can specify a descriptive text after \e[4msequence\e[24m, which is
- shown in the help screens.
+1. Overview
- \e[1mNote: \e[22mMacro definitions (if any) listed in the help screen(s), are
- silently truncated at the screen width, and are not wrapped.
+ Mutt-ng is a small but very powerful text-based MIME mail client. Mutt-ng is highly configurable, and is well suited to the mail power user with advanced features like key bindings, keyboard macros, mail threading, regular expression searches and a powerful pattern matching language for selecting groups of messages.
- \e[1m3.7. Using color and mono video attributes\e[0m
+ This documentation additionally contains documentation to Mutt-NG, a fork from Mutt with the goal to fix all the little annoyances of Mutt, to integrate all the Mutt patches that are floating around in the web, and to add other new features. Features specific to Mutt-ng will be discussed in an extra section. Don't be confused when most of the documentation talk about Mutt and not Mutt-ng, Mutt-ng contains all Mutt features, plus many more.
- Usage: color \e[4mobject\e[24m \e[4mforeground\e[24m \e[4mbackground\e[24m [ \e[4mregexp\e[24m ]
- Usage: color index \e[4mforeground\e[24m \e[4mbackground\e[24m \e[4mpattern\e[0m
- Usage: uncolor index \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+2. Mutt-ng Home Page
- 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 \e[1mand \e[22ma
- background color (it is not possible to only specify one or the
- other).
+ http://www.muttng.org
- \e[4mobject\e[24m can be one of:
+3. Mailing Lists
- · attachment
+ * mutt-ng-users@lists.berlios.de -- This is where the mutt-ng user support happens.
+ * mutt-ng-devel@lists.berlios.de -- The development mailing list for mutt-ng
- · body (match \e[4mregexp\e[24m in the body of messages)
+4. Software Distribution Sites
- · bold (hiliting bold patterns in the body of messages)
+ So far, there are no official releases of Mutt-ng, but you can download daily snapshots from http://mutt-ng.berlios.de/snapshots/
- · error (error messages printed by Mutt)
+5. IRC
- · header (match \e[4mregexp\e[24m in the message header)
+ Visit channel #muttng on irc.freenode.net (www.freenode.net) to chat with other people interested in Mutt-ng.
- · hdrdefault (default color of the message header in the pager)
+6. Weblog
- · index (match \e[4mpattern\e[24m in the message index)
+ If you want to read fresh news about the latest development in Mutt-ng, and get informed about stuff like interesting, Mutt-ng-related articles and packages for your favorite distribution, you can read and/or subscribe to our Mutt-ng development weblog.
- · indicator (arrow or bar used to indicate the current item in a
- menu)
+7. Copyright
- · markers (the ``+'' markers at the beginning of wrapped lines in the
- pager)
+ Mutt is Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu> and others
- · message (informational messages)
+ This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
- · normal
+ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
- · quoted (text matching ``$quote_regexp'' in the body of a message)
+ You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
- · quoted1, quoted2, ..., quoted\e[1mN \e[22m(higher levels of quoting)
+Chapter 2. Getting Started
- · search (hiliting of words in the pager)
+ Table of Contents
- · signature
+ 1. Basic Concepts
- · status (mode lines used to display info about the mailbox or
- message)
+ 1.1. Screens and Menus
+ 1.2. Configuration
+ 1.3. Functions
+ 1.4. Interaction
+ 1.5. Modularization
+ 1.6. Patterns
- · tilde (the ``~'' used to pad blank lines in the pager)
+ 2. Screens and Menus
- · tree (thread tree drawn in the message index and attachment menu)
+ 2.1. Index
+ 2.2. Pager
+ 2.3. File Browser
+ 2.4. Sidebar
+ 2.5. Help
+ 2.6. Compose Menu
+ 2.7. Alias Menu
+ 2.8. Attachment Menu
+ 2.9. Key Menu
- · underline (hiliting underlined patterns in the body of messages)
+ 3. Moving Around in Menus
+ 4. Editing Input Fields
+ 5. Reading Mail - The Index and Pager
- \e[4mforeground\e[24m and \e[4mbackground\e[24m can be one of the following:
+ 5.1. The Message Index
+ 5.2. The Pager
+ 5.3. Threaded Mode
+ 5.4. Miscellaneous Functions
- · white
+ 6. Sending Mail
- · black
+ 6.1. Composing new messages
+ 6.2. Replying
+ 6.3. Editing the message header
+ 6.4. Using Mutt-ng with PGP
+ 6.5. Sending anonymous messages via mixmaster
- · green
+ 7. Forwarding and Bouncing Mail
+ 8. Postponing Mail
- · magenta
+1. Basic Concepts
- · blue
+1.1. Screens and Menus
- · cyan
+ mutt-ng offers different screens of which every has its special purpose:
+ * The index displays the contents of the currently opened mailbox.
+ * The pager is responsible for displaying messages, that is, the header, the body and all attached parts.
+ * The file browser offers operations on and displays information of all folders mutt-ng should watch for mail.
+ * The sidebar offers a permanent view of which mailboxes contain how many total, new and/or flagged mails.
+ * The help screen lists for all currently available commands how to invoke them as well as a short description.
+ * The compose menu is a comfortable interface take last actions before sending mail: change subjects, attach files, remove attachements, etc.
+ * The attachement menu gives a summary and the tree structure of the attachements of the current message.
+ * The alias menu lists all or a fraction of the aliases a user has defined.
+ * The key menu used in connection with encryption lets users choose the right key to encrypt with.
- · yellow
+ When mutt-ng is started without any further options, it'll open the users default mailbox and display the index.
- · red
+1.2. Configuration
- · default
+ Mutt-ng does not feature an internal configuration interface or menu due to the simple fact that this would be too complex to handle (currently there are several hundred variables which fine-tune the behaviour.)
- · color\e[4mx\e[0m
+ Mutt-ng is configured using configuration files which allow users to add comments or manage them via version control systems to ease maintenance.
- \e[4mforeground\e[24m can optionally be prefixed with the keyword bright to make
- the foreground color boldfaced (e.g., brightred).
+ Also, mutt-ng comes with a shell script named grml-muttng kindly contributed by users which really helps and eases the creation of a user's configuration file. When downloading the source code via a snapshot or via subversion, it can be found in the contrib directory.
- If your terminal supports it, the special keyword \e[4mdefault\e[24m can be used
- as a transparent color. The value \e[4mbrightdefault\e[24m is also valid. If
- Mutt is linked against the \e[4mS-Lang\e[24m library, you also need to set the
- \e[4mCOLORFGBG\e[24m environment variable to the default colors of your terminal
- for this to work; for example (for Bourne-like shells):
+1.3. Functions
- set COLORFGBG="green;black"
- export COLORFGBG
+ Mutt-ng offers great flexibility due to the use of functions: internally, every action a user can make mutt-ng perform is named ``function.'' Those functions are assigned to keys (or even key sequences) and may be completely adjusted to user's needs. The basic idea is that the impatient users get a very intuitive interface to start off with and advanced users virtually get no limits to adjustments.
- \e[1mNote: \e[22mThe \e[4mS-Lang\e[24m library requires you to use the \e[4mlightgray\e[24m and \e[4mbrown\e[0m
- keywords instead of \e[4mwhite\e[24m and \e[4myellow\e[24m when setting this variable.
+1.4. Interaction
- \e[1mNote: \e[22mThe uncolor command can be applied to the index object only. It
- removes entries from the list. You \e[1mmust \e[22mspecify 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.
+ Mutt-ng has two basic concepts of user interaction:
+ 1. There is one dedicated line on the screen used to query the user for input, issue any command, query variables and display error and informational messages. As for every type of user input, this requires manual action leading to the need of input.
+ 2. The automatized interface for interaction are the so called hooks. Hooks specify actions the user wants to be performed at well-defined situations: what to do when entering which folder, what to do when displaying or replying to what kind of message, etc. These are optional, i.e. a user doesn't need to specify them but can do so.
- Mutt also recognizes the keywords \e[4mcolor0\e[24m, \e[4mcolor1\e[24m, ..., \e[4mcolor\e[24m\e[1mN-1 \e[22m(\e[1mN\e[0m
- 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 \e[4mcolor2\e[24m for your xterm), since color
- names may then lose their normal meaning.
+1.5. Modularization
- If your terminal does not support color, it is still possible change
- the video attributes through the use of the ``mono'' command:
+ Although mutt-ng has many functionality built-in, many features can be delegated to external tools to increase flexibility: users can define programs to filter a message through before displaying, users can use any program they want for displaying a message, message types (such as PDF or PostScript) for which mutt-ng doesn't have a built-in filter can be rendered by arbitrary tools and so forth. Although mutt-ng has an alias mechanism built-in, it features using external tools to query for nearly every type of addresses from sources like LDAP, databases or just the list of locally known users.
- Usage: mono
\e[4m<object>
\e[24m
\e[4m<attribute>
\e[24m [
\e[4mregexp
\e[24m ]
- Usage: mono index \e[4mattribute\e[24m \e[4mpattern\e[0m
- Usage: unmono index \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+1.6. Patterns
- where \e[4mattribute\e[24m is one of the following:
+ Mutt-ng has a built-in pattern matching ``language'' which is as widely used as possible to present a consistent interface to users. The same ``pattern terms'' can be used for searching, scoring, message selection and much more.
- · none
+2. Screens and Menus
- · bold
+2.1. Index
- · underline
+ The index is the screen that you usually see first when you start mutt-ng. 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.
- · reverse
+2.2. Pager
- · standout
+ 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.
- \e[1m3.8. Ignoring (weeding) unwanted message headers\e[0m
+ 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.
- Usage: [un]ignore \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+ To give the user a good overview, it is possible to configure mutt-ng 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.
- 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.
+2.3. File Browser
- 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.
+ 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.
- 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''.
+2.4. Sidebar
- ``unignore *'' will remove all tokens from the ignore list.
+ The sidebar comes in handy to manage mails which are spread over different folders. All folders users setup mutt-ng to watch for new mail will be listed. The listing includes not only the name but also the number of total messages, the number of new and flagged messages. Items with new mail may be colored different from those with flagged mail, items may be shortened or compress if they're they to long to be printed in full form so that by abbreviated names, user still now what the name stands for.
- For example:
+2.5. Help
- # 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 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-ng command prompt).
- \e[1m3.9. Alternative addresses\e[0m
+2.6. Compose Menu
- Usage: [un]alternates \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ The compose menu features a split screen containing the information which really matter before actually sending a message by mail or posting an article to a newsgroup: who gets the message as what (recipient, newsgroup, 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.
- 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
- yourself won't make much sense in many cases. (See ``$reply_to''.)
+ Also, it's used to attach messages, news articles or files to a message, to re-edit any attachment including the message itself.
- 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 addresses you receive mail under. That's the 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.
+2.7. Alias Menu
- To remove a regular expression from this list, use the unalternates
- command.
+ 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.
- \e[1m3.10. Mailing lists\e[0m
+2.8. Attachment Menu
- Usage: [un]lists \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
- Usage: [un]subscribe \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ As will be later discussed in detail, mutt-ng features a good and stable MIME implementation, that is, is greatly supports sending and receiving messages of arbitrary type. 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.
- 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 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 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.
+2.9. Key Menu
- 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''.
+ FIXME
- You can use regular expressions with both commands. To mark all
- messages sent to a specific bug report's address on mutt'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.
+3. Moving Around in Menus
- 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 addresssed to \e[4mmutt-users@mutt.org\e[24m. 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 \e[4mmutt-\e[0m
- \e[4musers@example.com\e[24m, you could use ``lists mutt-users@mutt.org'' or
- ``subscribe mutt-users@mutt.org'' to match only mail from the actual
- list.
+ Information is presented in menus, very similar to ELM. Here is a table showing the common keys used to navigate menus in Mutt-ng.
+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 key bindings for the current menu
- The ``unlists'' command is used to remove a token from the list of
- known and subscribed mailing-lists. Use ``unlists *'' to remove all
- tokens.
+4. Editing Input Fields
- To remove a mailing list from the list of subscribed mailing lists,
- but keep it on the list of known mailing lists, use ``unsubscribe''.
+ Mutt-ng has a builtin line editor which is used as the primary way to input textual data such as email addresses or filenames. The keys used to move around while editing are very similar to those of Emacs.
+^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
+^G n/a abort
+<Return> n/a finish editing
- \e[1m3.11. Using Multiple spool mailboxes\e[0m
+ 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
- Usage: mbox-hook [!]\e[4mpattern\e[24m \e[4mmailbox\e[0m
+ bind editor <delete> backspace
- This command is used to move read messages from a specified mailbox to
- a different mailbox automatically when you quit or change folders.
- \e[4mpattern\e[24m is a regular expression specifying the mailbox to treat as a
- ``spool'' mailbox and \e[4mmailbox\e[24m specifies where mail should be saved
- when read.
+5. Reading Mail - The Index and Pager
- Unlike some of the other \e[4mhook\e[24m commands, only the \e[4mfirst\e[24m matching
- pattern is used (it is not possible to save read mail in more than a
- single mailbox).
+ Similar to many other mail clients, there are two modes in which mail is read in Mutt-ng. The first is the index of messages in the mailbox, which is called the ``index'' in Mutt-ng. The second mode is the display of the message contents. This is called the ``pager.''
- \e[1m3.12. Defining mailboxes which receive mail\e[0m
+ The next few sections describe the functions provided in each of these modes.
- Usage: [un]mailboxes [!]\e[4mfilename\e[24m [ \e[4mfilename\e[24m ... ]
+5.1. The Message Index
- 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.
+c change to a different mailbox
+ESC c change to a folder in read-only mode
+C copy the current message to another mailbox
+ESC C decode a message and copy it to a folder
+ESC s decode a message and save it to a folder
+D delete messages matching a pattern
+d delete the current message
+F mark as important
+l show messages matching a pattern
+N mark message as new
+o change the current sort method
+O reverse sort the mailbox
+q save changes and exit
+s save-message
+T tag messages matching a pattern
+t toggle the tag on a message
+ESC t toggle tag on entire message thread
+U undelete messages matching a pattern
+u undelete-message
+v view-attachments
+x abort changes and exit
+<Return> display-message
+<Tab> jump to the next new message
+@ show the author's full e-mail address
+$ save changes to mailbox
+/ search
+ESC / search-reverse
+^L clear and redraw the screen
+^T untag messages matching a pattern
+
+5.1.1. 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:
+
+ D
+ message is deleted (is marked for deletion)
+
+ d
+ message have attachments marked for deletion
+
+ K
+ contains a PGP public key
+
+ N
+ message is new
+
+ O
+ message is old
+
+ P
+ message is PGP encrypted
+
+ r
+ message has been replied to
+
+ S
+ message is signed, and the signature is succesfully 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
- When changing folders, pressing \e[4mspace\e[24m will cycle through folders with
- new mail.
+ T
+ message is to you, but also to or cc'ed to others
- 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.
+ C
+ message is cc'ed to you
- The ``unmailboxes'' command is used to remove a token from the list of
- folders which receive mail. Use ``unmailboxes *'' to remove all
- tokens.
+ F
+ message is from you
- \e[1mNote: \e[22mnew mail is detected by comparing the last modification time to
- the last access time. 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.
+ L
+ message is sent to a subscribed mailing list
- \e[1mNote: \e[22mthe filenames 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.
+5.2. The Pager
- \e[1m3.13. User defined headers\e[0m
+ By default, Mutt-ng 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.
+<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
+n search for next match
+S skip beyond quoted text
+T toggle display of quoted text
+? show key bindings
+/ search for a regular expression (pattern)
+ESC / search backwards for a regular expression
+\ toggle search pattern coloring
+^ jump to the top of the message
- Usage:
- my_hdr \e[4mstring\e[0m
- unmy_hdr \e[4mfield\e[24m [ \e[4mfield\e[24m ... ]
+ In addition, 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).
- The ``my_hdr'' command allows you to create your own header fields
- which will be added to every message you send.
+ 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-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 color objects to specify a color or mono attribute for them.
- For example, if you would like to add an ``Organization:'' header
- field to all of your outgoing messages, you can put the command
+ Additionally, the internal pager supports the ANSI escape sequences for character attributes. Mutt-ng translates them into the correct color and character settings. The sequences Mutt-ng supports are:
+ESC [ Ps;Ps;Ps;...;Ps m
+where Ps =
+0 All Attributes Off
+1 Bold on
+4 Underline on
+5 Blink on
+7 Reverse video on
+3x Foreground color is x
+4x Background color is x
- my_hdr Organization: A Really Big Company, Anytown, USA
+Colors are
+0 black
+1 red
+2 green
+3 yellow
+4 blue
+5 magenta
+6 cyan
+7 white
- in your .muttrc.
+ Mutt-ng 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 display, for example by changing the color associated with color2 for your xterm, then that color will be used instead of green.
- \e[1mNote: \e[22mspace characters are \e[4mnot\e[24m allowed between the keyword and the
- colon (``:''). The standard for electronic mail (RFC822) says that
- space is illegal there, so Mutt enforces the rule.
+5.3. Threaded Mode
- If you would like to add a header field to a single message, you
- should either set the ``edit_headers'' variable, or use the \e[4medit-\e[0m
- \e[4mheaders\e[24m function (default: ``E'') in the send-menu so that you can
- edit the header of your message along with the body.
+ When the mailbox is sorted by threads, there are a few additional functions available in the index and pager modes.
+^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
- 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:
+ Note: 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.
- unmy_hdr to cc
+ See also: strict-threads.
- \e[1m3.14. Defining the order of headers when viewing messages\e[0m
+5.4. Miscellaneous Functions
- Usage: hdr_order \e[4mheader1\e[24m \e[4mheader2\e[24m \e[4mheader3\e[0m
+ create-alias (default: a)
- With this command, you can specify an order in which mutt will attempt
- to present headers to you when viewing messages.
+ 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.
- ``unhdr_order *'' will clear all previous headers from the order list,
- thus removing the header order effects set by the system-wide startup
- file.
+ check-traditional-pgp (default: ESC P)
- hdr_order From Date: From: To: Cc: Subject:
+ This function will search the current message for content signed or 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 effect.
- \e[1m3.15. Specify default save filename\e[0m
+ display-toggle-weed (default: h)
- Usage: save-hook [!]\e[4mpattern\e[24m \e[4mfilename\e[0m
+ Toggles the weeding of message header fields specified by ignore commands.
- This command is used to override the default filename used when saving
- messages. \e[4mfilename\e[24m will be used as the default filename if the
- message is \e[4mFrom:\e[24m an address matching \e[4mregexp\e[24m or if you are the author
- and the message is addressed \e[4mto:\e[24m something matching \e[4mregexp\e[24m.
+ edit (default: e)
- See ``Message Matching in Hooks'' for information on the exact format
- of \e[4mpattern\e[24m.
+ 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.
- Examples:
+ edit-type (default: ^E on the attachment menu, and in the pager and index menus; ^T on the compose menu)
- save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
- save-hook aol\\.com$ +spam
+ 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 attach-menu, you can change any attachment's content type. These changes are not persistent, and get lost upon changing folders.
- Also see the ``fcc-save-hook'' command.
+ Note that this command is also available on the compose-menu. There, it's used to fine-tune the properties of attachments you are going to send.
- \e[1m3.16. Specify default Fcc: mailbox when composing\e[0m
+ enter-command (default: ``:'')
- Usage: fcc-hook [!]\e[4mpattern\e[24m \e[4mmailbox\e[0m
+ 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 macro to change settings on the fly.
- This command is used to save outgoing mail in a mailbox other than
- ``$record''. Mutt searches the initial list of message recipients for
- the first matching \e[4mregexp\e[24m and uses \e[4mmailbox\e[24m as the default Fcc:
- mailbox. If no match is found the message will be saved to
- ``$record'' mailbox.
+ extract-keys (default: ^K)
- See ``Message Matching in Hooks'' for information on the exact format
- of \e[4mpattern\e[24m.
+ This command extracts PGP public keys from the current or tagged message(s) and adds them to your PGP public key ring.
- Example: fcc-hook aol.com$ +spammers
+ forget-passphrase (default: ^F)
- 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.
+ This command wipes the passphrase(s) from memory. It is useful, if you misspelled the passphrase.
- \e[1m3.17. Specify default save filename and default Fcc: mailbox at once\e[0m
+ list-reply (default: L)
- Usage: fcc-save-hook [!]\e[4mpattern\e[24m \e[4mmailbox\e[0m
+ Reply to the current or tagged message(s) by extracting any addresses which match the regular expressions given by the lists 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.
- This command is a shortcut, equivalent to doing both a ``fcc-hook''
- and a ``save-hook'' with its arguments.
+ pipe-message (default: |)
- \e[1m3.18. Change settings based upon message recipients\e[0m
+ 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.
- Usage: reply-hook [!]\e[4mpattern\e[24m \e[4mcommand\e[0m
- Usage: send-hook [!]\e[4mpattern\e[24m \e[4mcommand\e[0m
- Usage: send2-hook [!]\e[4mpattern\e[24m \e[4mcommand\e[0m
+ resend-message (default: ESC e)
- These commands can be used to execute arbitrary configuration commands
- based upon recipients of the message. \e[4mpattern\e[24m is a regular expression
- matching the desired address. \e[4mcommand\e[24m is executed when \e[4mregexp\e[24m matches
- recipients of the message.
+ With resend-message, 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 included here depends on the value of the weed variable.
- reply-hook is matched against the message you are \e[4mreplying\e[24m \e[1mto\e[22m, instead
- of the message you are \e[4msending\e[24m. send-hook is matched against all
- messages, both \e[4mnew\e[24m and \e[4mreplies\e[24m. \e[1mNote: \e[22mreply-hooks are matched \e[1mbefore\e[0m
- the send-hook, \e[1mregardless \e[22mof the order specified in the users's
- configuration file.
+ 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.
- 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 ``$sendmail'' variable depending on
- the message's sender address.
+ shell-escape (default: !)
- 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).
+ Asks for an external Unix command and executes it. The wait-key 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.
- See ``Message Matching in Hooks'' for information on the exact format
- of \e[4mpattern\e[24m.
+ toggle-quoted (default: T)
- Example: send-hook mutt "set mime_forward signature=''"
+ 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 quoted text in the way.
- Another typical use for this command is to change the values of the
- ``$attribution'', ``$signature'' and ``$locale'' variables in order to
- change the language of the attributions and signatures based upon the
- recipients.
+ skip-quoted (default: S)
- \e[1mNote: \e[22mthe 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.
+ This function will go to the next line of non-quoted text which come after a line of quoted text in the internal pager.
- \e[1m3.19. Change settings before formatting a message\e[0m
+6. Sending Mail
- Usage: message-hook [!]\e[4mpattern\e[24m \e[4mcommand\e[0m
+ The following bindings are available in the index for sending messages.
+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
- This command can be used to execute arbitrary configuration commands
- before viewing or formatting a message based upon information about
- the message. \e[4mcommand\e[24m is executed if the \e[4mpattern\e[24m matches the message
- to be displayed. When multiple matches occur, commands are executed in
- the order they are specified in the muttrc.
+ 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-mail.
- See ``Message Matching in Hooks'' for information on the exact format
- of \e[4mpattern\e[24m.
+6.1. Composing new messages
- Example:
+ When you want to send an email using mutt-ng, simply press m on your keyboard. Then, mutt-ng asks for the recipient via a prompt in the last line:
+To:
- message-hook ~A 'set pager=builtin'
- message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
+ After you've finished entering the recipient(s), press return. If you want to send an email to more than one recipient, separate the email addresses using the comma ",". Mutt-ng then asks you for the email subject. Again, press return after you've entered it. After that, mutt-ng got the most important information from you, and starts up an editor where you can then enter your email.
- \e[1m3.20. Choosing the cryptographic key of the recipient\e[0m
+ The editor that is called is selected in the following way: you can e.g. set it in the mutt-ng configuration:
+set editor = "vim +/^$/ -c ':set tw=72'"
+set editor = "nano"
+set editor = "emacs"
- Usage: crypt-hook \e[4mpattern\e[24m \e[4mkeyid\e[0m
+ If you don't set your preferred editor in your configuration, mutt-ng first looks whether the environment variable $VISUAL is set, and if so, it takes its value as editor command. Otherwise, it has a look at $EDITOR and takes its value if it is set. If no editor command can be found, mutt-ng simply assumes vi to be the default editor, since it's the most widespread editor in the Unix world and it's pretty safe to assume that it is installed and available.
- When encrypting messages with PGP 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.
-
- 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.
-
- \e[1m3.21. Adding key sequences to the keyboard buffer\e[0m
-
- Usage: push \e[4mstring\e[0m
-
- 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.
-
- \e[1m3.22. Executing functions\e[0m
-
- Usage: exec \e[4mfunction\e[24m [ \e[4mfunction\e[24m ... ]
-
- This command can be used to execute any function. Functions are listed
- in the ``function reference''. ``exec function'' is equivalent to
- ``push <function>''.
- \e[1m3.23. Message Scoring\e[0m
-
- Usage: score \e[4mpattern\e[24m \e[4mvalue\e[0m
- Usage: unscore \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
-
- The score commands adds \e[4mvalue\e[24m to a message's score if \e[4mpattern\e[24m matches
- it. \e[4mpattern\e[24m 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).
- \e[4mvalue\e[24m 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 \e[4mvalue\e[24m 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 \e[1mmust\e[0m
- 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.
-
- \e[1m3.24. Spam detection\e[0m
-
- Usage: spam \e[4mpattern\e[24m \e[4mformat\e[0m
- Usage: nospam \e[4mpattern\e[0m
-
- Mutt has generalized support for external spam-scoring filters. By
- defining your spam patterns with the spam and nospam commands, you can
- \e[4mlimit\e[24m, \e[4msearch\e[24m, and \e[4msort\e[24m 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
- ``$index_format'' 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. \e[4mpattern\e[24m 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
- below.) The appearance of this attribute is entirely up to you, and is
- governed by the \e[4mformat\e[24m parameter. \e[4mformat\e[24m can be any static text, but
- it also can include back-references from the \e[4mpattern\e[24m 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.
-
- If you're using multiple spam filters, a message can have more than
- 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 message's spam
- tag will consist of all the \e[4mformat\e[24m strings joined together, with the
- value of $spam_separator separating them.
-
- For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
- define these spam settings:
-
- 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
- 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''.)
-
- If the $spam_separator variable is unset, then each spam pattern match
- supercedes the previous one. Instead of getting joined \e[4mformat\e[24m 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 string that the ~H pattern-
- matching expression matches against for \e[4msearch\e[24m and \e[4mlimit\e[24m 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 to sorting.
-
- Generally, when you sort by spam tag, mutt will sort \e[4mlexically\e[24m -- that
- is, by ordering strings alphnumerically. However, if a spam tag 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 \e[4many\e[24m 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 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.
-
- 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.
-
- If the \e[4mpattern\e[24m given to nospam is exactly the same as the \e[4mpattern\e[24m 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
- \e[4mpattern\e[24m for a spam command matches an entry on the nospam list, that
- nospam entry will be removed. If the \e[4mpattern\e[24m for nospam is ``*'', \e[4mall\e[0m
- \e[4mentries\e[24m \e[4mon\e[24m \e[4mboth\e[24m \e[4mlists\e[24m 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 example,
- if you consider all mail from MAILER-DAEMON to be spam, you can use a
- spam command like this:
-
- spam "^From: .*MAILER-DAEMON" "999"
-
- \e[1m3.25. Setting variables\e[0m
-
- Usage: set [no|inv]\e[4mvariable\e[24m[=\e[4mvalue\e[24m] [ \e[4mvariable\e[24m ... ]
- Usage: toggle \e[4mvariable\e[24m [\e[4mvariable\e[24m ... ]
- Usage: unset \e[4mvariable\e[24m [\e[4mvariable\e[24m ... ]
- Usage: reset \e[4mvariable\e[24m [\e[4mvariable\e[24m ... ]
-
- This command is used to set (and unset) ``configuration variables''.
- There are four basic types of variables: boolean, number, string and
- quadoption. \e[4mboolean\e[24m variables can be \e[4mset\e[24m (true) or \e[4munset\e[24m (false).
- \e[4mnumber\e[24m variables can be assigned a positive integer value.
-
- \e[4mstring\e[24m variables consist of any number of printable characters.
- \e[4mstrings\e[24m must be enclosed in quotes if they contain spaces or tabs.
- You may also use the ``C'' escape sequences \e[1m\n \e[22mand \e[1m\t \e[22mfor newline and
- tab, respectively.
-
- \e[4mquadoption\e[24m variables are used to control whether or not to be prompted
- for certain actions, or to specify a default action. A value of \e[4myes\e[0m
- will cause the action to be carried out automatically as if you had
- answered yes to the question. Similarly, a value of \e[4mno\e[24m will cause the
- the action to be carried out as if you had answered ``no.'' A value
- of \e[4mask-yes\e[24m will cause a prompt with a default answer of ``yes'' and
- \e[4mask-no\e[24m will provide a default answer of ``no.''
-
- Prefixing a variable with ``no'' will unset it. Example: set
- noaskbcc.
-
- For \e[4mboolean\e[24m 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.
-
- The toggle command automatically prepends the inv prefix to all
- specified variables.
-
- The unset command automatically prepends the no prefix to all
- specified variables.
-
- Using the enter-command function in the \e[4mindex\e[24m 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
- variables.
-
- 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.
-
- With the reset command there exists the special variable ``all'',
- which allows you to reset all variables to their system defaults.
-
- \e[1m3.26. Reading initialization commands from another file\e[0m
-
- Usage: source \e[4mfilename\e[0m
-
- This command allows the inclusion of initialization commands from
- other files. For example, I place all of my aliases in
- ~/.mail_aliases so that I can make my ~/.muttrc readable and keep my
- aliases private.
-
- 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 \e[4mfilename\e[24m is
- considered to be an executable program from which to read input (eg.
- source ~/bin/myscript|).
-
- \e[1m3.27. Removing hooks\e[0m
-
- Usage: unhook [ * | \e[4mhook-type\e[24m ]
-
- This command permits you to flush hooks you have previously defined.
- 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.
+ When you've finished entering your message, save it and quit your editor. Mutt-ng will then present you with a summary screen, the compose menu. On the top, you see a summary of the most important available key commands. Below that, you see the sender, the recipient(s), Cc and/or Bcc recipient(s), the subject, the reply-to address, and optionally information where the sent email will be stored and whether it should be digitally signed and/or encrypted.
- \e[1m4. Advanced Usage\e[0m
-
- \e[1m4.1. Regular Expressions\e[0m
+ Below that, you see a list of "attachments". The mail you've just entered before is also an attachment, but due to its special type (it's plain text), it will be displayed as the normal message on the receiver's side.
- All string patterns in Mutt including those in more complex
- ``patterns'' 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.
+ At this point, you can add more attachments, pressing a, you can edit the recipient addresses, pressing t for the "To:" field, c for the "Cc:" field, and b for the "Bcc: field. You can also edit the subject the subject by simply pressing s or the email message that you've entered before by pressing e. You will then again return to the editor. You can even edit the sender, by pressing <esc>f, but this shall only be used with caution.
- The search is case sensitive if the pattern contains at least one
- upper case letter, and case insensitive otherwise. Note that ``\''
- must be quoted if used for a regular expression in an initialization
- command: ``\\''.
-
- A regular expression is a pattern that describes a set of strings.
- 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 "
- or ' which is useful if the regular expression includes a white-space
- character. See ``Syntax of Initialization Files'' for more
- information on " and ' delimiter processing. To match a literal " or
- ' you must preface it with \ (backslash).
+ Alternatively, you can configure mutt-ng in a way that most of the above settings can be edited using the editor. Therefore, you only need to add the following to your configuration:
+set edit_headers
- The fundamental building blocks are the regular expressions that match
- a single character. Most characters, including all letters and
- digits, are regular expressions that match themselves. Any
- metacharacter with special meaning may be quoted by preceding it with
- a backslash.
+ Once you have finished editing the body of your mail message, you are returned to the compose menu. The following options are available:
+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 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.
+ 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 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.
- 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 \e[1mnot \e[22min the list. For example, the
- regular expression \e[1m[0123456789] \e[22mmatches 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.
+6.2. Replying
- 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:
+6.2.1. Simple Replies
- \e[1m[:alnum:]\e[0m
- Alphanumeric characters.
+ When you want to reply to an email message, select it in the index menu and then press r. Mutt-ng's behaviour is then similar to the behaviour when you compose a message: first, you will be asked for the recipient, then for the subject, and then, mutt-ng will start the editor with the quote attribution and the quoted message. This can e.g. look like the example below.
+On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
+> Bill, can you please send last month's progress report to Mr.
+> Morgan? We also urgently need the cost estimation for the new
+> production server that we want to set up before our customer's
+> project will go live.
- \e[1m[:alpha:]\e[0m
- Alphabetic characters.
+ You can start editing the email message. It is strongly recommended to put your answer below the quoted text and to only quote what is really necessary and that you refer to. Putting your answer on top of the quoted message, is, although very widespread, very often not considered to be a polite way to answer emails.
- \e[1m[:blank:]\e[0m
- Space or tab characters.
+ The quote attribution is configurable, by default it is set to
+set attribution = "On %d, %n wrote:"
- \e[1m[:cntrl:]\e[0m
- Control characters.
+ It can also be set to something more compact, e.g.
+set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"
- \e[1m[:digit:]\e[0m
- Numeric characters.
+ The example above results in the following attribution:
+* Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
+> Bill, can you please send last month's progress report to Mr.
+> Morgan? We also urgently need the cost estimation for the new
+> production server that we want to set up before our customer's
+> project will go live.
- \e[1m[:graph:]\e[0m
- Characters that are both printable and visible. (A space is
- printable, but not visible, while an ``a'' is both.)
+ Generally, try to keep your attribution short yet information-rich. It is not the right place for witty quotes, long "attribution" novels or anything like that: the right place for such things is - if at all - the email signature at the very bottom of the message.
- \e[1m[:lower:]\e[0m
- Lower-case alphabetic characters.
+ When you're done with writing your message, save and quit the editor. As before, you will return to the compose menu, which is used in the same way as before.
- \e[1m[:print:]\e[0m
- Printable characters (characters that are not control
- characters.)
+6.2.2. Group Replies
- \e[1m[:punct:]\e[0m
- Punctuation characters (characters that are not letter, digits,
- control characters, or space characters).
+ In the situation where a group of people uses email as a discussion, most of the emails will have one or more recipients, and probably several "Cc:" recipients. The group reply functionality ensures that when you press g instead of r to do a reply, each and every recipient that is contained in the original message will receive a copy of the message, either as normal recipient or as "Cc:" recipient.
- \e[1m[:space:]\e[0m
- Space characters (such as space, tab and formfeed, to name a
- few).
+6.2.3. List Replies
- \e[1m[:upper:]\e[0m
- Upper-case alphabetic characters.
+ When you use mailing lists, it's generally better to send your reply to a message only to the list instead of the list and the original author. To make this easy to use, mutt-ng features list replies.
- \e[1m[:xdigit:]\e[0m
- Characters that are hexadecimal digits.
+ To do a list reply, simply press L. If the email contains a Mail-Followup-To: header, its value will be used as reply address. Otherwise, mutt-ng searches through all mail addresses in the original message and tries to match them a list of regular expressions which can be specified using the lists command. If any of the regular expression matches, a mailing list address has been found, and it will be used as reply address.
+lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@
- 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, \e[1m[[:digit:]]\e[0m
- is equivalent to \e[1m[0-9]\e[22m.
-
- 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:
-
- \e[1mCollating Symbols\e[0m
- A collating symbol is a multi-character collating element
- enclosed in ``[.'' and ``.]''. For example, if ``ch'' is a
- collating element, then \e[1m[[.ch.]] \e[22mis a regexp that matches this
- collating element, while \e[1m[ch] \e[22mis a regexp that matches either
- ``c'' or ``h''.
-
- \e[1mEquivalence Classes\e[0m
- 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[1m[[=e=]]\e[0m
- 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:
-
- \e[1m? \e[22mThe preceding item is optional and matched at most once.
-
- \e[1m* \e[22mThe preceding item will be matched zero or more times.
-
- \e[1m+ \e[22mThe preceding item will be matched one or more times.
-
- \e[1m{n}\e[0m
- The preceding item is matched exactly \e[4mn\e[24m times.
-
- \e[1m{n,}\e[0m
- The preceding item is matched \e[4mn\e[24m or more times.
-
- \e[1m{,m}\e[0m
- The preceding item is matched at most \e[4mm\e[24m times.
-
- \e[1m{n,m}\e[0m
- The preceding item is matched at least \e[4mn\e[24m times, but no more than
- \e[4mm\e[24m times.
-
- Two regular expressions may be concatenated; the resulting regular
- expression matches any string formed by concatenating two substrings
- that respectively match the concatenated subexpressions.
-
- Two regular expressions may be joined by the infix operator ``|''; the
- resulting regular expression matches any string matching either
- subexpression.
-
- Repetition takes precedence over concatenation, which in turn takes
- precedence over alternation. A whole subexpression may be enclosed in
- parentheses to override these precedence rules.
-
- \e[1mNote: \e[22mIf you compile Mutt with the GNU \e[4mrx\e[24m package, the following
- operators may also be used in regular expressions:
-
- \e[1m\\y\e[0m
- Matches the empty string at either the beginning or the end of a
- word.
-
- \e[1m\\B\e[0m
- Matches the empty string within a word.
-
- \e[1m\\<\e[0m
- Matches the empty string at the beginning of a word.
-
- \e[1m\\>\e[0m
- Matches the empty string at the end of a word.
-
- \e[1m\\w\e[0m
- Matches any word-constituent character (letter, digit, or
- underscore).
-
- \e[1m\\W\e[0m
- Matches any character that is not word-constituent.
-
- \e[1m\\`\e[0m
- Matches the empty string at the beginning of a buffer (string).
-
- \e[1m\\'\e[0m
- Matches the empty string at the end of a buffer.
-
- Please note however that these operators are not defined by POSIX, so
- they may or may not be available in stock libraries on various
- systems.
-
- \e[1m4.2. Patterns\e[0m
-
- Many of Mutt's commands allow you to specify a pattern to match
- (limit, tag-pattern, delete-pattern, etc.). There are several ways to
- select messages:
-
- ~A all messages
- ~b EXPR messages which contain EXPR in the message body
- ~B EXPR messages which contain EXPR in the whole message
- ~c USER messages carbon-copied to USER
- ~C EXPR message is either to: or cc: EXPR
- ~D deleted messages
- ~d [MIN]-[MAX] messages with ``date-sent'' in a Date range
- ~E expired messages
- ~e EXPR message which contains EXPR in the ``Sender'' field
- ~F flagged messages
- ~f USER messages originating from USER
- ~g cryptographically signed messages
- ~G cryptographically encrypted messages
- ~H EXPR messages with a spam attribute matching EXPR
- ~h EXPR messages which contain EXPR in the message header
- ~k message contains PGP key material
- ~i ID message which match ID in the ``Message-ID'' field
- ~L EXPR message is either originated or received by EXPR
- ~l message 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 *)
- ~N new messages
- ~O old messages
- ~p message is addressed to you (consults alternates)
- ~P message is from you (consults alternates)
- ~Q messages which have been replied to
- ~R read messages
- ~r [MIN]-[MAX] messages with ``date-received'' in a Date range
- ~S superseded messages
- ~s SUBJECT messages having SUBJECT in the ``Subject'' field.
- ~T tagged messages
- ~t USER messages addressed to USER
- ~U unread messages
- ~v message is part of a collapsed thread.
- ~V cryptographically verified messages
- ~x EXPR messages which contain EXPR in the `References' field
- ~y EXPR messages 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)
+ Nowadays, most mailing list software like GNU Mailman adds a Mail-Followup-To: header to their emails anyway, so setting lists is hardly ever necessary in practice.
- Where EXPR, USER, ID, and SUBJECT are ``regular expressions''.
- 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 (\), 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 (\\).
+6.3. Editing the message header
- *) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too.
+ When editing the header of your outgoing message, there are a couple of special features available.
- \e[1m4.2.1. Pattern Modifier\e[0m
+ If you specify Fcc: filename Mutt-ng will pick up filename just as if you had used the edit-fcc function in the compose menu.
- Note that 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 ^. This example matches all mails which only has
- recipients from Germany.
+ You can also attach files to your message by specifying Attach: filename [ description ] where filename is the file to attach and description is an optional string to use as the description of the attached file.
- ^~C \.de$
+ When replying to messages, if you remove the In-Reply-To: field from the header field, Mutt-ng will not generate a References: field, which allows you to create a new message thread.
- \e[1m4.2.2. Complex Patterns\e[0m
+ Also see edit-headers.
- Logical AND is performed by specifying more than one criterion. For
- example:
+6.4. Using Mutt-ng with PGP
- ~t mutt ~f elkins
+ If you want to use PGP, you can specify
- would select messages which contain the word ``mutt'' in the list of
- recipients \e[1mand \e[22mthat have the word ``elkins'' in the ``From'' header
- field.
+ Pgp: [ E | S | S<id> ]
- Mutt also recognizes the following operators to create more complex
- search patterns:
+ ``E'' encrypts, ``S'' signs and ``S<id>'' signs with the given key, setting pgp-sign-as permanently.
- · ! -- logical NOT operator
+ 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 any questions about keys which have a certified user ID matching one of the message recipients' mail addresses. However, there may be situations in which there are several keys, weakly certified user ID fields, or where no matching keys can be found.
- · | -- logical OR 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''.
-
- !(~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'':
-
- '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
-
- Note that if a regular expression contains parenthesis, or a veritical
- bar ("|"), you \e[1mmust \e[22menclose the expression in double or single quotes
- since those characters are also used to separate different parts of
- Mutt's pattern language. For example,
-
- ~f "me@(mutt\.org|cs\.hmc\.edu)"
-
- Without the quotes, the parenthesis wouldn't end. This would be
- seperated to two OR'd patterns: \e[4m~f\e[24m \e[4mme@(mutt\.org\e[24m and \e[4mcs\.hmc\.edu)\e[24m.
- They are never what you want.
-
- \e[1m4.2.3. Searching by Date\e[0m
+ 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 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 return to the compose screen.
- Mutt supports two types of dates, \e[4mabsolute\e[24m and \e[4mrelative\e[24m.
+ Once you have successfully finished the key selection, the message will be encrypted using the selected public keys, and sent out.
- \e[1mAbsolute\e[22m. Dates \e[1mmust \e[22mbe 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:
+ 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.
- Limit to messages matching: ~d 20/1/95-31/10
+ The flags sequence (%f) will expand to one of the following flags:
+R The key has been revoked and can't be used.
+X The key is expired and can't be used.
+d You have marked the key as disabled.
+c There are unknown critical self-signature
+ packets.
- If you omit the minimum (first) date, and just specify ``-DD/MM/YY'',
- all messages \e[4mbefore\e[24m the given date will be selected. If you omit the
- maximum (second) date, and specify ``DD/MM/YY-'', all messages \e[4mafter\e[0m
- 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.
+ 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 this key can be used for encryption.
- \e[1mError Margins\e[22m. You can add error margins to absolute dates. An error
- margin is a sign (+ or -), followed by a digit, followed by one of the
- following units:
+ 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.
- y years
- m months
- w weeks
- d days
+ 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.
- As a special case, you can replace the sign by a ``*'' character,
- which is equivalent to giving identical plus and minus error margins.
+6.5. Sending anonymous messages via mixmaster
- Example: To select any messages two weeks around January 15, 2001,
- you'd use the following pattern:
+ 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.
- Limit to messages matching: ~d 15/1/2001*2w
+ To use it, you'll have to obey certain restrictions. Most important, you cannot use the Cc and Bcc headers. To tell Mutt-ng to use mixmaster, you have to select a remailer chain, using the mix function on the compose menu.
- \e[1mRelative\e[22m. This type of date is relative to the current date, and may
- be specified as:
+ 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.
- · >\e[4moffset\e[24m (messages older than \e[4moffset\e[24m units)
+ 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.
- · <\e[4moffset\e[24m (messages newer than \e[4moffset\e[24m units)
+ 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.
- · =\e[4moffset\e[24m (messages exactly \e[4moffset\e[24m units old)
+7. Forwarding and Bouncing Mail
- \e[4moffset\e[24m is specified as a positive number with one of the following
- units:
+ Often, it is necessary to forward mails to other people. Therefore, mutt-ng supports forwarding messages in two different ways.
- y years
- m months
- w weeks
- d days
+ The first one is regular forwarding, as you probably know it from other mail clients. You simply press f, enter the recipient email address, the subject of the forwarded email, and then you can edit the message to be forwarded in the editor. The forwarded message is separated from the rest of the message via the two following markers:
+----- Forwarded message from Lucas User <luser@example.com> -----
- Example: to select messages less than 1 month old, you would use
+From: Lucas User <luser@example.com>
+Date: Thu, 02 Dec 2004 03:08:34 +0100
+To: Michael Random <mrandom@example.com>
+Subject: Re: blackmail
- Limit to messages matching: ~d <1m
+Pay me EUR 50,000.- cash or your favorite stuffed animal will die
+a horrible death.
- \e[1mNote: \e[22mall dates used when searching are relative to the \e[1mlocal \e[22mtime
- zone, so unless you change the setting of your ``$index_format'' to
- include a %[...] format, these are \e[1mnot \e[22mthe dates shown in the main
- index.
- \e[1m4.3. Using Tags\e[0m
+----- End forwarded message -----
- 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 default. See
- ``patterns'' for Mutt's pattern matching syntax.
+ When you're done with editing the mail, save and quit the editor, and you will return to the compose menu, the same menu you also encounter when composing or replying to mails.
- 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 \e[1mnext \e[22moperation 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''.
+ The second mode of forwarding emails with mutt-ng is the so-called bouncing: when you bounce an email to another address, it will be sent in practically the same format you send it (except for headers that are created during transporting the message). To bounce a message, press b and enter the recipient email address. By default, you are then asked whether you really want to bounce the message to the specified recipient. If you answer with yes, the message will then be bounced.
- 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.
+ To the recipient, the bounced email will look as if he got it like a regular email where he was Bcc: recipient. The only possibility to find out whether it was a bounced email is to carefully study the email headers and to find out which host really sent the email.
- \e[1m4.4. Using Hooks\e[0m
+8. Postponing Mail
- A \e[4mhook\e[24m is a concept borrowed from the EMACS editor 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 \e[4mhook\e[24m consists of a ``regular expression'' or ``pattern''
- along with a configuration option/command. See
+ At times it is desirable to delay sending a message that you have 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-ng and then restart it at a later time.
- · ``folder-hook''
+ 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 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.
- · ``send-hook''
+ Note: 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.
- · ``message-hook''
+ See also the postpone quad-option.
- · ``save-hook''
+Chapter 3. Configuration
- · ``mbox-hook''
+ Table of Contents
- · ``fcc-hook''
+ 1. Locations of Configuration Files
+ 2. Basic Syntax of Initialization Files
+ 3. Expansion within variables
- · ``fcc-save-hook''
+ 3.1. Commands' Output
+ 3.2. Environment Variables
+ 3.3. Configuration Variables
+ 3.4. Self-Defined Variables
+ 3.5. Pre-Defined Variables
+ 3.6. Type Conversions
- for specific details on each type of \e[4mhook\e[24m available.
+ 4. Defining/Using aliases
+ 5. Changing the default key bindings
+ 6. Defining aliases for character sets
+ 7. Setting variables based upon mailbox
+ 8. Keyboard macros
+ 9. Using color and mono video attributes
+ 10. Ignoring (weeding) unwanted message headers
+ 11. Alternative addresses
+ 12. Format = Flowed
- \e[1mNote: \e[22mif 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:
+ 12.1. Introduction
+ 12.2. Receiving: Display Setup
+ 12.3. Sending
+ 12.4. Additional Notes
- send-hook . 'unmy_hdr From:'
- send-hook ~Cb@b.b my_hdr from: c@c.c
+ 13. Mailing lists
+ 14. Using Multiple spool mailboxes
+ 15. Defining mailboxes which receive mail
+ 16. User defined headers
+ 17. Defining the order of headers when viewing messages
+ 18. Specify default save filename
+ 19. Specify default Fcc: mailbox when composing
+ 20. Specify default save filename and default Fcc: mailbox at once
+ 21. Change settings based upon message recipients
+ 22. Change settings before formatting a message
+ 23. Choosing the cryptographic key of the recipient
+ 24. Adding key sequences to the keyboard buffer
+ 25. Executing functions
+ 26. Message Scoring
+ 27. Spam detection
+ 28. Setting variables
+ 29. Reading initialization commands from another file
+ 30. Removing hooks
+ 31. Sharing Setups
- \e[1m4.4.1. Message Matching in Hooks\e[0m
+ 31.1. Character Sets
+ 31.2. Modularization
+ 31.3. Conditional parts
- 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 ``regular expression'' 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.
+ 32. Obsolete Variables
- 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 \e[4mlimiting\e[24m or \e[4msearching\e[24m the mailbox, except that you are
- restricted to those operators which match information mutt extracts
- from the header of the message (i.e. from, to, cc, date, subject,
- etc.).
+1. Locations of Configuration Files
- For example, if you wanted to set your return address based upon
- sending mail to a specific address, you could do something like:
+ While the default configuration (or ``preferences'') make Mutt-ng usable right 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'' commandline 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 will look for .muttngrc. If this file does not exist and your home directory has a subdirectory named .mutt, mutt try to load a file named .muttng/muttngrc.
- send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
+ .muttrc (or .muttngrc for Mutt-ng) is the file where you will usually place your commands to configure Mutt-ng.
- which would execute the given command when sending mail to
- \e[4mme@cs.hmc.edu\e[24m.
+2. Basic Syntax of Initialization Files
- However, it is not required that you write the pattern to match using
- the full searching language. You can still specify a simple \e[4mregular\e[0m
- \e[4mexpression\e[24m like the other hooks, in which case Mutt will translate
- your 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 ``$default_hook'' that is
- in effect at that time will be used.
+ 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 (;).
+set realname='Mutt-ng user' ; ignore x-
- \e[1m4.5. External Address Queries\e[0m
+ The hash mark, or pound sign (``#''), 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,
+my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
- Mutt 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 ``$query_command'' variable, you
- specify the wrapper command to use. For example:
+ 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.
- set query_command = "mutt_ldap_query.pl '%s'"
+ \ 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.
+set realname="Michael \"MuttDude\" Elkins"
- 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 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.
-
- An example multiple response output:
+ ``\\'' means to insert a literal ``\'' into the line. ``\n'' and ``\r'' have their usual C meanings of linefeed and carriage-return, respectively.
- Searching database ... 20 entries ... 3 matching:
- me@cs.hmc.edu Michael Elkins mutt dude
- blong@fiction.net Brandon Long mutt and more
- roessler@guug.de 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). 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 to mail, start a new query, or have a new query
- appended to the current 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 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 menu. At the query menu, you can select one
- or more addresses to be added to the prompt.
-
- \e[1m4.6. Mailbox Formats\e[0m
-
- Mutt 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 uses the default specified with the
- ``$mbox_type'' variable.
-
- \e[1mmbox\e[22m. This is the most 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).
-
- \e[1mMMDF\e[22m. This is a variant of the \e[4mmbox\e[24m format. Each message is
- surrounded by lines containing ``^A^A^A^A'' (four control-A's).
-
- \e[1mMH\e[22m. A radical departure from \e[4mmbox\e[24m and \e[4mMMDF\e[24m, 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. \e[1mNote: \e[22mMutt detects this type of
- mailbox by looking for either .mh_sequences or .xmhcache (needed to
- distinguish normal directories from MH mailboxes).
-
- \e[1mMaildir\e[22m. The newest of the mailbox formats, used by the Qmail MTA (a
- replacement for sendmail). Similar to \e[4mMH\e[24m, except that it adds three
- subdirectories of the mailbox: \e[4mtmp\e[24m, \e[4mnew\e[24m and \e[4mcur\e[24m. 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.
-
- \e[1m4.7. Mailbox Shortcuts\e[0m
-
- 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.
-
- · ! -- refers to your ``$spoolfile'' (incoming) mailbox
-
- · > -- refers to your ``$mbox'' file
-
- · < -- refers to your ``$record'' file
-
- · - or !! -- refers to the file you've last visited
-
- · ~ -- refers to your home directory
-
- · = or + -- refers to your ``$folder'' directory
-
- · @\e[4malias\e[24m -- refers to the ``default save folder'' as determined by
- the address of the alias
-
- \e[1m4.8. Handling Mailing Lists\e[0m
-
- Mutt has a few configuration options that make dealing with large
- 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.
-
- 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 \e[4mindex\e[24m 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).
-
- 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 \e[4mindex\e[24m menu and \e[4mpager\e[24m, 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).
-
- 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 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 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.
-
- Conversely, when group-replying or list-replying to a message which
- 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 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 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 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'' field. Mutt uses the ``$reply_to'' variable to help decide which
- address to use. If set, 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
- unset, the ``Reply-To'' field will be used when present.
-
- 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 index, and
- Mutt'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 has the ability to ``sort'' the mailbox into ``threads''.
- 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 graphically. 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.
-
- \e[1m4.9. Delivery Status Notification (DSN) Support\e[0m
-
- 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.'' Berkeley sendmail 8.8.x currently has some
- command line options in which the mail client can make requests as to
- what type of status messages should be returned.
-
- To support this, there are two variables. ``$dsn_notify'' is used to
- request receipts for different results (such as failed message,
- message delivered, etc.). ``$dsn_return'' requests how much of your
- message should be returned with the receipt (headers or full message).
- Refer to the man page on sendmail for more details on DSN.
-
- \e[1m4.10. POP3 Support (OPTIONAL)\e[0m
-
- If Mutt was compiled with POP3 support (by running the \e[4mconfigure\e[0m
- script with the \e[4m--enable-pop\e[24m flag), it has the ability to work with
- mailboxes located on a remote POP3 server and fetch mail for local
- browsing.
-
- You can access the remote POP3 mailbox by selecting the folder
- pop://popserver/.
-
- You can select an alternative port by specifying it with the server,
- ie: pop://popserver:port/.
-
- You can also specify different username for each folder, ie:
- pop://username@popserver[:port]/.
-
- Polling for new mail is more expensive over POP3 than locally. For
- this reason the frequency at which Mutt will check for mail remotely
- can be controlled by the ``$pop_checkinterval'' variable, which
- defaults to every 60 seconds.
-
- If Mutt was compiled with SSL support (by running the \e[4mconfigure\e[24m script
- with the \e[4m--with-ssl\e[24m flag), connections to POP3 servers can be
- encrypted. This naturally requires that the server supports SSL
- encrypted connections. To access a folder with POP3/SSL, you should
- use pops: prefix, ie: pops://[username@]popserver[:port]/.
-
- Another way to access your POP3 mail is the \e[4mfetch-mail\e[24m 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.
-
- \e[1mNote: \e[22mIf you only need to fetch all messages to local mailbox you
- should consider using a specialized program, such as fetchmail
-
- \e[1m4.11. IMAP Support (OPTIONAL)\e[0m
-
- If Mutt was compiled with IMAP support (by running the \e[4mconfigure\e[0m
- script with the \e[4m--enable-imap\e[24m flag), it has the ability to work with
- folders located on a remote IMAP server.
-
- You can access the remote inbox by selecting the folder
- imap://imapserver/INBOX, where imapserver is the name of the IMAP
- server and 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 you want to access.
-
- You can select an alternative port by specifying it with the server,
- ie: imap://imapserver:port/INBOX.
-
- You can also specify different username for each folder, ie:
- imap://username@imapserver[:port]/INBOX.
-
- If Mutt was compiled with SSL support (by running the \e[4mconfigure\e[24m script
- with the \e[4m--with-ssl\e[24m flag), connections to IMAP servers can be
- encrypted. This naturally requires that the server supports SSL
- encrypted connections. To access a folder with IMAP/SSL, you should
- use imaps://[username@]imapserver[:port]/path/to/folder as your folder
- path.
-
- Pine-compatible notation is also supported, ie
- {[username@]imapserver[:port][/ssl]}path/to/folder
-
- 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.
-
- 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 \e[4mtoggle-subscribed\e[24m command. See also the ``$imap_list_subscribed''
- variable.
-
- Polling for new mail on an IMAP server can cause noticeable delays.
- So, you'll want to carefully tune the ``$mail_check'' and ``$timeout''
- variables. Personally I use
-
- set mail_check=90
- set timeout=15
-
- with relatively good results over my slow modem line.
-
- 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.
-
- \e[1m4.11.1. The Folder Browser\e[0m
-
- 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 that the entry
- contains both messages and subfolders. On Cyrus-like servers
- folders will often contain both messages and subfolders.
-
- · For the case where an entry can contain both messages and
- subfolders, the selection key (bound to enter by default) will
- choose to descend into the subfolder view. If you wish to view the
- messages in that folder, you must use view-file instead (bound to
- space by default).
-
- · You can delete mailboxes with the delete-mailbox command (bound to
- d by default. You may also subscribe and unsubscribe to mailboxes
- (normally these are bound to s and u, respectively).
-
- \e[1m4.11.2. Authentication\e[0m
-
- Mutt supports four authentication methods with IMAP servers: SASL,
- GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
- 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".
-
- 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 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 \e[4m--with-sasl\e[24m flag.
-
- Mutt will try whichever methods are compiled in and available on the
- server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5,
- LOGIN.
-
- There are a few variables which control authentication:
+ 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.
- · ``$imap_user'' - controls the username under which you request
- authentication on the IMAP server, for all authenticators. This is
- overridden by an explicit username in the mailbox path (ie by using
- a mailbox name of the form {user@host}).
-
- · ``$imap_pass'' - a password which you may preset, used by all
- authentication methods where 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 listed above).
-
- \e[1m4.12. Managing multiple IMAP/POP accounts (OPTIONAL)\e[0m
+ Please note that, unlike the various shells, mutt-ng interprets a ``\'' at the end of a line also in comments. This allows you to disable a command split over multiple lines with only one ``#''.
+# folder-hook . \
+ set realname="Michael \"MuttDude\" Elkins"
- If you happen to have accounts on multiple IMAP and/or POP 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
- (including inside the folder browser), not just when you open the
- mailbox.
-
- Some examples:
-
- account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
- account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
- account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
-
- \e[1m4.13. Start a WWW Browser on URLs (EXTERNAL)\e[0m
-
- If a message contains URLs (\e[4munified\e[24m \e[4mresource\e[24m \e[4mlocator\e[24m = address in the
- WWW space like \e[4mhttp://www.mutt.org/\e[24m), 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:
-
- macro index \cb |urlview\n
- macro pager \cb |urlview\n
-
- \e[1m5. Mutt's MIME Support\e[0m
-
- Quite a bit of effort has been made to make Mutt the premier text-mode
- 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
- IANA MIME types. The other is the mailcap file, which specifies the
- external commands to use for handling specific MIME types.
-
- \e[1m5.1. Using MIME in Mutt\e[0m
-
- There are three areas/menus in Mutt which deal with MIME, they are the
- pager (while viewing a message), the attachment menu and the compose
- menu.
-
- \e[1m5.1.1. Viewing MIME messages in the pager\e[0m
-
- When you select a message from the index and view it in the pager,
- Mutt decodes the message to a text representation. Mutt internally
- supports a number of MIME types, including text/plain, text/enriched,
- message/rfc822, and message/news. In addition, the export controlled
- version of Mutt recognizes a variety of PGP MIME types, 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-print-
- able/base64/binary.
-
- If Mutt cannot deal with a MIME type, it will display a message like:
-
- [-- image/gif is unsupported (use 'v' to view this part) --]
-
- \e[1m5.1.2. The Attachment Menu\e[0m
-
- 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 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.
-
- See the help on the attachment menu for more information.
-
- \e[1m5.1.3. The Compose Menu\e[0m
-
- The compose menu is the menu you see before you send a message. It
- allows you to edit the recipient list, the subject, and other aspects
- of your message. It also contains a list of the attachments of your
- message, including the main body. From this menu, you can print,
- copy, filter, pipe, edit, compose, review, and rename an attachment or
- a list of tagged attachments. You can also modifying the attachment
- 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 cancelling) 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 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
- megabytes. The next field is the filename, 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).
-
- \e[1m5.2. MIME Type configuration with mime.types\e[0m
-
- 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 /etc/mime.types
-
- The mime.types file consist of lines containing a MIME type and a
- space separated list of extensions. For example:
-
- application/postscript ps eps
- 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.
-
- If Mutt can not determine the mime type by the extension of the file
- you 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 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 recognises all of these if
- the appropriate entry is found in the mime.types file. It also
- recognises other major mime types, such as the chemical type that is
- widely used in the molecular modelling community to pass molecular
- data in various forms to various molecular viewers. Non-recognised
- mime types should only be used if the recipient of the message is
- likely to be expecting such attachments.
-
- \e[1m5.3. MIME Viewer configuration with mailcap\e[0m
-
- Mutt supports RFC 1524 MIME Configuration, in particular the Unix
- 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.
-
- 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 set to
-
- ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
-
- where $HOME is your home directory.
-
- In particular, the metamail distribution will install a mailcap file,
- usually as /usr/local/etc/mailcap, which contains some baseline
- entries.
-
- \e[1m5.3.1. The Basics of the mailcap file\e[0m
-
- A mailcap file consists of a series of lines which are comments,
- blank, or definitions.
-
- A comment line consists of a # character followed by anything you
- want.
-
- A blank line is blank.
-
- A definition line consists of a content type, a view command, and any
- number of optional fields. Each field of a definition line is divided
- by a semicolon ';' character.
-
- The content type is specified in the MIME standard type/subtype
- method. For example, text/plain, text/html, image/gif, etc. In
- addition, the mailcap format includes two formats for wildcards, one
- using the special '*' subtype, the other is the implicit wild, where
- you only include the major type. For example, image/*, or video, will
- match all image types and video types, respectively.
-
- The view command is a Unix command for viewing the type specified.
- There are two different types of commands supported. The default is to
- send the body of the MIME message to the command on stdin. You can
- change this behaviour by using %s as a parameter to your view command.
- This will cause Mutt to save the body of the MIME message to a
- temporary file, and then call the view command with the %s replaced by
- the name of the temporary file. In both cases, Mutt will turn over the
- terminal to the view program until the program quits, at which time
- Mutt 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
- message:
-
- text/html; lynx %s
-
- In this case, lynx does not support viewing a file from stdin, so you
- must use the %s syntax. \e[1mNote: \e[4m\e[22mSome\e[24m \e[4molder\e[24m \e[4mversions\e[24m \e[4mof\e[24m \e[4mlynx\e[24m \e[4mcontain\e[24m \e[4ma\e[0m
- \e[4mbug\e[24m \e[4mwhere\e[24m \e[4mthey\e[24m \e[4mwill\e[24m \e[4mcheck\e[24m \e[4mthe\e[24m \e[4mmailcap\e[24m \e[4mfile\e[24m \e[4mfor\e[24m \e[4ma\e[24m \e[4mviewer\e[24m \e[4mfor\e[24m \e[4mtext/html.\e[0m
- \e[4mThey\e[24m \e[4mwill\e[24m \e[4mfind\e[24m \e[4mthe\e[24m \e[4mline\e[24m \e[4mwhich\e[24m \e[4mcalls\e[24m \e[4mlynx,\e[24m \e[4mand\e[24m \e[4mrun\e[24m \e[4mit.\e[24m \e[4mThis\e[24m \e[4mcauses\e[0m
- \e[4mlynx\e[24m \e[4mto\e[24m \e[4mcontinuously\e[24m \e[4mspawn\e[24m \e[4mitself\e[24m \e[4mto\e[24m \e[4mview\e[24m \e[4mthe\e[24m \e[4mobject.\e[0m
-
- 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.
- \e[1m5.3.2. Secure use of mailcap\e[0m
-
- The interpretion of shell meta-characters embedded in MIME parameters
- can lead to security problems in general. Mutt tries to quote
- parameters in expansion of %s syntaxes properly, and avoids risky
- characters by substituting them, see the ``mailcap_sanitize''
- 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. Therefore you should pay attention to the following
- rules:
-
- \e[4mKeep\e[24m \e[4mthe\e[24m \e[4m%-expandos\e[24m \e[4maway\e[24m \e[4mfrom\e[24m \e[4mshell\e[24m \e[4mquoting.\e[24m Don't quote them with
- single or double quotes. Mutt does this for you, the right way, as
- should any other program which interprets mailcap. Don't put them
- into backtick expansions. Be highly careful with eval statements, and
- avoid them if possible at all. Trying to fix broken behaviour with
- quotes introduces new leaks - there is no alternative to correct
- quoting in the first place.
-
- If you have to use the %-expandos' values in context where you need
- quoting or backtick expansions, put that value into a shell variable
- and reference the shell variable where necessary, as in the following
- example (using $charset inside the backtick expansion is safe, 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
-
- \e[1m5.3.3. Advanced mailcap Usage\e[0m
-
- \e[1m5.3.3.1. Optional Fields\e[0m
-
- 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:
-
- \e[1mcopiousoutput\e[0m
- This flag tells Mutt that the command passes possibly large
- amounts of text on stdout. This causes Mutt 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
- 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.
-
- \e[1mneedsterminal\e[0m
- Mutt uses this flag when viewing attachments with ``autoview'',
- 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 \e[4mneedsterminal\e[24m flag, Mutt will use ``$wait_key'' 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.
-
- \e[1mcompose=<command>\e[0m
- This flag specifies the command to use to create a new
- attachment of a specific MIME type. Mutt supports this from the
- compose menu.
-
- \e[1mcomposetyped=<command>\e[0m
- 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 used to specify parameters,
- filename, description, etc. for a new attachment. Mutt
- supports this from the compose menu.
-
- \e[1mprint=<command>\e[0m
- This flag specifies the command to use to print a specific MIME
- type. Mutt supports this from the attachment and compose menus.
-
- \e[1medit=<command>\e[0m
- This flag specifies the command to use to edit a specific MIME
- type. Mutt supports this from the compose menu, and also uses
- it to compose new attachments. Mutt will default to the defined
- editor for text attachments.
-
- \e[1mnametemplate=<template>\e[0m
- This field specifies the format for the file denoted by %s in
- the command fields. Certain programs will require a certain
- file extension, 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
-
- \e[1mtest=<command>\e[0m
- This field specifies a command to run to test whether this
- mailcap 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. \e[1mNote: \e[4m\e[22mthe\e[0m
- \e[4mcontent-type\e[24m \e[4mmust\e[24m \e[4mmatch\e[24m \e[4mbefore\e[24m \e[4mMutt\e[24m \e[4mperforms\e[24m \e[4mthe\e[24m \e[4mtest.\e[24m For
- example:
-
- text/html; netscape -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 dis-
- play 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.
-
- \e[1m5.3.3.2. Search Order\e[0m
-
- When searching for an entry in the mailcap file, Mutt will search for
- 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
- 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 ``Autoview'' 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; lynx %s; nametemplate=%s.html
- text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
-
- For ``Autoview'', 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 pro-
- gram returns non-zero, Mutt will use the second entry for interactive
- viewing.
-
- \e[1m5.3.3.3. Command Expansion\e[0m
-
- The various commands defined in the mailcap files are passed to the
- /bin/sh shell using the system() 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:
-
- \e[1m%s \e[22mAs seen in the basic mailcap section, this variable is expanded
- to a filename specified by the calling program. This file
- contains the body of the message to view/print/edit or where the
- composing program should place the results of composition. In
- addition, the use of this keyword causes Mutt to not pass the
- body of the message to the view/print/edit program on stdin.
-
- \e[1m%t \e[22mMutt will expand %t to the text representation of the content
- type of the message in the same form as the first parameter of
- the mailcap definition line, ie text/html or image/gif.
-
-
\e[1m%{<parameter>}
\e[0m
- 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 meta-
- mail mailcap file uses this feature to test the charset to spawn an
- xterm using the right charset to view the message.
-
- \e[1m\% \e[22mThis 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 mes-
- sages, which is handled internally by Mutt.
-
- \e[1m5.3.4. Example mailcap files\e[0m
-
- This mailcap file is fairly simple and standard:
+ When testing your config files, beware the following caveat. The backslash at the end of the commented line extends the current line with the next line - then referred to as a ``continuation line''. As the first line is commented with a hash (#) all following continuation lines are also part of a comment and therefore are ignored, too. So take care of comments when continuation lines are involved within your setup files!
- ______________________________________________________________________
- # I'm always running X :)
- video/*; xanim %s > /dev/null
- image/*; xv %s > /dev/null
+ Abstract example:
+line1\
+line2a # line2b\
+line3\
+line4
+line5
- # I'm always running netscape (if my computer had more memory, maybe)
- text/html; netscape -remote 'openURL(%s)'
- ______________________________________________________________________
+ line1 ``continues'' until line4. however, the part after the # is a comment which includes line3 and line4. line5 is a new line of its own and thus is interpreted again.
- 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
+ The commands understood by mutt are explained in the next paragraphs. For a complete list, see the commands.
- # Send html to a running netscape by remote
- text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
+3. Expansion within variables
- # If I'm not running netscape but I am running X, start netscape on the
- # object
- text/html; netscape %s; test=RunningX
+ Besides just assign static content to variables, there's plenty of ways of adding external and more or less dynamic content.
- # Else use lynx to view it as text
- text/html; lynx %s
+3.1. Commands' Output
- # This version would convert the text/html to text/plain
- text/html; lynx -dump %s; copiousoutput
+ It is possible to substitute the output of a Unix command in an initialization file. This is accomplished by enclosing the command in backquotes (``) as in, for example:
+my_hdr X-Operating-System: `uname -a`
- # I use enscript to print text in two columns to a page
- text/*; more %s; print=enscript -2Gr %s
+ 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.
- # Netscape adds a flag to tell itself to view jpegs internally
- image/jpeg;xv %s; x-mozilla-flags=internal
+3.2. Environment Variables
- # Use xv to view images if I'm running X
- # In addition, this uses the \ to extend the line and set my editor
- # for images
- image/*;xv %s; test=RunningX; \
- edit=xpaint %s
-
- # Convert images to text using the netpbm tools
- image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
- pbmtoascii -1x2 ) 2>&1 ; copiousoutput
-
- # Send excel spreadsheets to my NT box
- application/ms-excel; open.pl %s
- ______________________________________________________________________
-
- \e[1m5.4. MIME Autoview\e[0m
-
- In addition to explicitly telling Mutt to view an attachment with the
- MIME viewer defined in the mailcap file, Mutt has support for
- automatically viewing MIME attachments while in the pager.
+ UNIX environments can be accessed like the way it is done in shells like sh and bash: Prepend the name of the environment by a ``$'' sign. For example,
+set record=+sent_on_$HOSTNAME
- 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.
+ sets the record variable to the string +sent_on_ and appends the value of the evironment variable $HOSTNAME.
- You then use the auto_view muttrc command to list the content-types
- that you wish to view automatically.
+ Note: There will be no warning if an environment variable is not defined. The result will of the expansion will then be empty.
- For instance, if you set auto_view to:
+3.3. Configuration Variables
- auto_view text/html application/x-gunzip application/postscript image/gif application/x-tar-gz
+ As for environment variables, the values of all configuration variables as string can be used in the same way, too. For example,
+set imap_home_namespace = $folder
- Mutt could use the following mailcap entries to automatically view
- attachments of these types.
+ would set the value of imap-home-namespace to the value to which folder is currently set to.
- text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
- image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
- application/x-gunzip; gzcat; copiousoutput
- application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
- application/postscript; ps2ascii %s; copiousoutput
+ Note: There're no logical links established in such cases so that the the value for imap-home-namespace won't change even if folder gets changed.
- ``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.
+ Note: 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.
- \e[1m5.5. MIME Multipart/Alternative\e[0m
+3.4. Self-Defined Variables
- 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:
+ 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 reserved namespace for them: all user-defined variables must be prefixed with user_ and can be used just like any ordinary configuration or environment variable.
- alternative_order text/enriched text/plain text application/postscript image/*
+ For example, to view the manual, users can either define two macros like the following
+macro generic <F1> "!less -r /path/to/manual" "Show manual"
+macro pager <F1> "!less -r /path/to/manual" "Show manual"
- 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.
+ for generic, pager and index. The alternative is to define a custom variable like so:
+set user_manualcmd = "!less -r /path/to_manual"
+macro generic <F1> "$user_manualcmd<enter>" "Show manual"
+macro pager <F1> "$user_manualcmd<enter>" "Show manual"
+macro index <F1> "$user_manualcmd<enter>" "Show manual"
- To remove a MIME type from the alternative_order list, use the
- unalternative_order command.
+ to re-use the command sequence as in:
+macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"
- \e[1m5.6. MIME Lookup\e[0m
+ Using this feature, arbitrary sequences can be defined once and recalled and reused where necessary. More advanced scenarios could include to save a variable's value at the beginning of macro sequence and restore it at end.
- 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 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 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:
+ 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.
- mime_lookup application/octet-stream application/X-Lotus-Manuscript
+ The complete removal is done via the unset keyword.
- 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.
+ After the following sequence:
+set user_foo = 42
+set user_foo = 666
- \e[1m6. Reference\e[0m
+ the variable $user_foo has a current value of 666 and an initial of 42. The query
+set ?user_foo
- \e[1m6.1. Command line options\e[0m
+ will show 666. After doing the reset via
+reset user_foo
- Running mutt with no arguments will make Mutt attempt to read your
- spool mailbox. However, it is possible to read other mailboxes and to
- send messages from the command line as well.
+ a following query will give 42 as the result. After unsetting it via
+unset user_foo
- -A expand an alias
- -a attach a file to a message
- -b specify a blind carbon-copy (BCC) address
- -c specify a carbon-copy (Cc) address
- -e specify a config command to be run after initilization files are read
- -f specify a mailbox to load
- -F specify an alternate file to read initialization commands
- -h print help on command line options
- -H specify a draft file from which to read a header and body
- -i specify a file to include in a message composition
- -m specify a default mailbox type
- -n do not read the system Muttrc
- -p recall a postponed message
- -Q query a configuration variable
- -R open mailbox in read-only mode
- -s specify a subject (enclose in quotes if it contains spaces)
- -v show version number and compile-time definitions
- -x simulate the mailx(1) compose mode
- -y show a menu containing the files specified by the mailboxes command
- -z exit immediately if there are no messages in the mailbox
- -Z open the first folder with new message,exit immediately if none
+ any query or operation (except the noted expansion within other statements) will lead to an error message.
- To read messages in a mailbox
+3.5. Pre-Defined Variables
- mutt [ -nz ] [ -F \e[4mmuttrc\e[24m ] [ -m \e[4mtype\e[24m ] [ -f \e[4mmailbox\e[24m ]
+ 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 variables. 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.
- To compose a new message
+ Please consult the local copy of your manual for their values as they may differ from different manual sources. Where the manual is installed in can be queried (already using such a variable) by running:
+muttng -Q muttng_docdir
- mutt [ -n ] [ -F \e[4mmuttrc\e[24m ] [ -a \e[4mfile\e[24m ] [ -c \e[4maddress\e[24m ] [ -i \e[4mfilename\e[24m ] [
- -s \e[4msubject\e[24m ] \e[4maddress\e[24m [ \e[4maddress\e[24m ... ]
+ 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'
- Mutt also supports a ``batch'' mode to send prepared messages. Simply
- redirect input from the file you wish to send. For example,
+ to:
+set user_manualcmd = "!less -r $muttng_docdir/manual.txt"
- mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat
+ which works everywhere if a manual is installed.
- 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''.
+ 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.
- \e[1m6.2. Configuration Commands\e[0m
+ For example, the statement
+folder-hook . "set user_current_folder = $muttng_folder_name"
- The following are the commands understood by mutt.
+ will be already be translated to the following when reading the startup files:
+folder-hook . "set user_current_folder = some_folder"
- · ``account-hook'' \e[4mpattern\e[24m \e[4mcommand\e[0m
+ with some_folder being the name of the first folder muttng opens. On the contrary,
+folder-hook . 'set user_current_folder = $muttng_folder_name'
- · ``alias'' \e[4mkey\e[24m \e[4maddress\e[24m [ , \e[4maddress\e[24m, ... ]
+ will be executed at runtime because of the single quotes so that user_current_folder will always have the value of the currently opened folder.
- · ``unalias'' [ * | \e[4mkey\e[24m ... ]
+ A more practical example is:
+folder-hook . 'source ~/.mutt/score-$muttng_folder_name'
- · ``alternates'' \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ which can be used to source files containing score commands depending on the folder the user enters.
- · ``unalternates'' [ * | \e[4mregexp\e[24m ... ]
+3.6. Type Conversions
- · ``alternative_order'' \e[4mmimetype\e[24m [ \e[4mmimetype\e[24m ... ]
+ 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 and from string. That means that there's no need to worry about types when referencing any variable. As an example, the following can be used without harm (besides makeing muttng very likely behave strange):
+set read_inc = 100
+set folder = $read_inc
+set read_inc = $folder
+set user_magic_number = 42
+set folder = $user_magic_number
- · ``unalternative_order'' \e[4mmimetype\e[24m [ \e[4mmimetype\e[24m ... ]
+4. Defining/Using aliases
- · ``auto_view'' \e[4mmimetype\e[24m [ \e[4mmimetype\e[24m ... ]
+ Usage: alias key address [ , address, ... ]
- · ``unauto_view'' \e[4mmimetype\e[24m [ \e[4mmimetype\e[24m ... ]
+ It's usually very cumbersome to remember or type out the address of someone you are communicating with. Mutt-ng allows you to create ``aliases'' which map a short string to a full address.
- · ``bind'' \e[4mmap\e[24m \e[4mkey\e[24m \e[4mfunction\e[0m
+ Note: if you want to create an alias for a group (by specifying more than one address), you must separate the addresses with a comma (``,'').
- · ``charset-hook'' \e[4malias\e[24m \e[4mcharset\e[0m
+ To remove an alias or aliases (``*'' means all aliases):
- · ``color'' \e[4mobject\e[24m \e[4mforeground\e[24m \e[4mbackground\e[24m [ \e[4mregexp\e[24m ]
+ unalias [ * | key ... ]
+alias muttdude me@cs.hmc.edu (Michael Elkins)
+alias theguys manny, moe, jack
- · ``uncolor'' \e[4mindex\e[24m \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+ Unlike other mailers, Mutt-ng 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 source. Consequently, you can have multiple alias files, or you can have all aliases defined in your muttrc.
- · ``exec'' \e[4mfunction\e[24m [ \e[4mfunction\e[24m ... ]
+ 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-ng 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.
- · ``fcc-hook'' \e[4mpattern\e[24m \e[4mmailbox\e[0m
+ For example:
+source /usr/local/share/Mutt-ng.aliases
+source ~/.mail_aliases
+set alias_file=~/.mail_aliases
- · ``fcc-save-hook'' \e[4mpattern\e[24m \e[4mmailbox\e[0m
+ 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.
- · ``folder-hook'' \e[4mpattern\e[24m \e[4mcommand\e[0m
+ 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 alias, such as at the beginning of the prompt or after a comma denoting multiple addresses.
- · ``hdr_order'' \e[4mheader\e[24m [ \e[4mheader\e[24m ... ]
+ 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.
- · ``unhdr_order'' \e[4mheader\e[24m [ \e[4mheader\e[24m ... ]
+5. Changing the default key bindings
- · ``iconv-hook'' \e[4mcharset\e[24m \e[4mlocal-charset\e[0m
+ Usage: bind map key function
- · ``ignore'' \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+ This command allows you to change the default key bindings (operation invoked when pressing a key).
- · ``unignore'' \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+ map specifies in which menu the binding belongs. Multiple maps may be specified by separating them with commas (no additional whitespace is allowed). The currently defined maps are:
- · ``lists'' \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ generic
+ 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-ng 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.
- · ``unlists'' \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ alias
+ 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 address(es) of the recipient(s).
- · ``macro'' \e[4mmenu\e[24m \e[4mkey\e[24m \e[4msequence\e[24m [ \e[4mdescription\e[24m ]
+ attach
+ The attachment menu is used to access the attachments on received messages.
- · ``mailboxes'' \e[4mfilename\e[24m [ \e[4mfilename\e[24m ... ]
+ browser
+ The browser is used for both browsing the local directory structure, and for listing all of your incoming mailboxes.
- · ``mbox-hook'' \e[4mpattern\e[24m \e[4mmailbox\e[0m
+ editor
+ The editor is the line-based editor the user enters text data.
- · ``message-hook'' \e[4mpattern\e[24m \e[4mcommand\e[0m
+ index
+ The index is the list of messages contained in a mailbox.
- · ``mime_lookup'' \e[4mmimetype\e[24m [ \e[4mmimetype\e[24m ... ]
+ compose
+ The compose menu is the screen used when sending a new message.
- · ``unmime_lookup'' \e[4mmimetype\e[24m [ \e[4mmimetype\e[24m ... ]
+ pager
+ The pager is the mode used to display message/attachment data, and help listings.
- · ``mono'' \e[4mobject\e[24m \e[4mattribute\e[24m [ \e[4mregexp\e[24m ]
+ pgp
+ The pgp menu is used to select the OpenPGP keys used for encrypting outgoing messages.
- · ``unmono'' \e[4mindex\e[24m \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+ postpone
+ The postpone menu is similar to the index menu, except is used when recalling a message the user was composing, but saved until later.
- · ``my_hdr'' \e[4mstring\e[0m
+ 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 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 equivalent to \c?).
- · ``unmy_hdr'' \e[4mfield\e[24m [ \e[4mfield\e[24m ... ]
+ In addition, key may consist of:
+\t tab
+<tab> tab
+<backtab> backtab / shift-tab
+\r carriage return
+\n newline
+\e escape
+<esc> escape
+<up> up arrow
+<down> down arrow
+<left> left arrow
+<right> right arrow
+<pageup> Page Up
+<pagedown> Page Down
+<backspace> Backspace
+<delete> Delete
+<insert> Insert
+<enter> Enter
+<return> Return
+<home> Home
+<end> End
+<space> Space bar
+<f1> function key 1
+<f10> function key 10
- · ``crypt-hook'' \e[4mpattern\e[24m \e[4mkey-id\e[0m
+ key does not need to be enclosed in quotes unless it contains a space (`` '').
- · ``push'' \e[4mstring\e[0m
+ function specifies which action to take when key is pressed. For a complete list of functions, see the functions. The special function noop unbinds the specified key sequence.
- · ``reset'' \e[4mvariable\e[24m [\e[4mvariable\e[24m ... ]
+6. Defining aliases for character sets
- · ``save-hook'' \e[4mregexp\e[24m \e[4mfilename\e[0m
+ Usage: charset-hook alias charset Usage: iconv-hook charset local-charset
- · ``score'' \e[4mpattern\e[24m \e[4mvalue\e[0m
+ 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.
- · ``unscore'' \e[4mpattern\e[24m [ \e[4mpattern\e[24m ... ]
+ 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.
- · ``send-hook'' \e[4mregexp\e[24m \e[4mcommand\e[0m
+7. Setting variables based upon mailbox
- · ``reply-hook'' \e[4mregexp\e[24m \e[4mcommand\e[0m
+ Usage: folder-hook [!]regexp command
- · ``set'' [no|inv]\e[4mvariable\e[24m[=\e[4mvalue\e[24m] [ \e[4mvariable\e[24m ... ]
+ 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 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.
- · ``unset'' \e[4mvariable\e[24m [\e[4mvariable\e[24m ... ]
+ Note: 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.
- · ``source'' \e[4mfilename\e[0m
+ Note that the 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
- · ``spam'' \e[4mpattern\e[24m \e[4mformat\e[0m
+ However, the sorting method is not restored to its previous value when reading a different mailbox. To specify a default command, use the pattern ``.'':
+folder-hook . set sort=date-sent
- · ``nospam'' \e[4mpattern\e[0m
+8. Keyboard macros
- · ``subscribe'' \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ Usage: macro menu key sequence [ description ]
- · ``unsubscribe'' \e[4mregexp\e[24m [ \e[4mregexp\e[24m ... ]
+ Macros are useful when you would like a single key to perform a series of actions. When you press key in menu menu, Mutt-ng 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.
- · ``toggle'' \e[4mvariable\e[24m [\e[4mvariable\e[24m ... ]
+ menu is the maps which the macro will be bound. 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.
- · ``unhook'' \e[4mhook-type\e[0m
+ key and sequence are expanded by the same rules as the bind. There are some additions however. The first is that control characters in sequence can also be specified 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 names see the section on bind. Functions are listed in the functions.
- \e[1m6.3. Configuration variables\e[0m
+ The advantage with using function names directly is that the macros will work 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 (eg. the system Muttngrc).
- \e[1m6.3.1. abort_nosubject\e[0m
+ Optionally you can specify a descriptive text after sequence, which is shown in the help screens.
- Type: quadoption
- Default: ask-yes
+ Note: Macro definitions (if any) listed in the help screen(s), are silently truncated at the screen width, and are not wrapped.
- If set to \e[4myes\e[24m, when composing messages and no subject is given at the
- subject prompt, composition will be aborted. If set to \e[4mno\e[24m, composing
- messages with no subject given at the subject prompt will never be
- aborted.
+9. Using color and mono video attributes
- \e[1m6.3.2. abort_unmodified\e[0m
+ Usage: color object foreground background [ regexp ] Usage: color index foreground background pattern Usage: uncolor index pattern [ pattern ... ]
- Type: quadoption
- Default: yes
+ If your terminal supports color, you can spice up Mutt-ng 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 possible to only specify one or the other).
- If set to \e[4myes\e[24m, composition will automatically abort after editing the
- message body if no changes are made to the file (this check only
- happens after the \e[4mfirst\e[24m edit of the file). When set to \e[4mno\e[24m,
- composition will never be aborted.
+ object can be one of:
+ * attachment
+ * body (match regexp in the body of messages)
+ * bold (highlighting bold patterns in the body of messages)
+ * error (error messages printed by Mutt-ng)
+ * 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 (highlighting 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 (highlighting underlined patterns in the body of messages)
- \e[1m6.3.3. alias_file\e[0m
+ foreground and background can be one of the following:
+ * white
+ * black
+ * green
+ * magenta
+ * blue
+ * cyan
+ * yellow
+ * red
+ * default
+ * colorx
- Type: path
- Default: "~/.muttrc"
+ foreground can optionally be prefixed with the keyword bright to make the foreground color boldfaced (e.g., brightred).
- The default file in which to save aliases created by the ````create-
- alias'''' function.
+ If your terminal supports it, the special keyword default can be used as a transparent color. The value brightdefault is also valid. If Mutt-ng 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
- \e[1mNote: \e[22mMutt will not automatically source this file; you must
- explicitly use the ````source'''' command for it to be executed.
+ Note: The S-Lang library requires you to use the lightgray and brown keywords instead of white and yellow when setting this variable.
- \e[1m6.3.4. alias_format\e[0m
+ 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.
- Type: string
- Default: "%4n %2f %t %-10a %r"
+ Mutt-ng also recognizes the keywords color0, color1, …, 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.
- Specifies the format of the data displayed for the `alias' menu. The
- following printf(3)-style sequences are available:
+ If your terminal does not support color, it is still possible change the video attributes through the use of the ``mono'' command:
- \e[1m%a \e[22malias name
+ Usage: mono <object> <attribute> [ regexp ] Usage: mono index attribute pattern Usage: unmono index pattern [ pattern ... ]
- \e[1m%f \e[22mflags - currently, a "d" for an alias marked for deletion
+ where attribute is one of the following:
+ * none
+ * bold
+ * underline
+ * reverse
+ * standout
- \e[1m%n \e[22mindex number
+10. Ignoring (weeding) unwanted message headers
- \e[1m%r \e[22maddress which alias expands to
+ Usage: [un]ignore pattern [ pattern ... ]
- \e[1m%t \e[22mcharacter which indicates if the alias is tagged for inclusion
+ 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.
- \e[1m6.3.5. allow_8bit\e[0m
+ 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.
- Type: boolean
- Default: yes
+ To remove a previously added token from the list, use the ``unignore'' command. The ``unignore'' command will make Mutt-ng display headers with the given pattern. For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
- Controls whether 8-bit data is converted to 7-bit using either Quoted-
- Printable or Base64 encoding when sending mail.
+ ``unignore *'' will remove all tokens from the ignore list.
- \e[1m6.3.6. allow_ansi\e[0m
+ For example:
+# 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:
- Type: boolean
- Default: no
+11. Alternative addresses
- Controls whether ANSI color codes in messages (and color tags in rich
- text messages) are to be interpreted. Messages containing these codes
- are rare, but if this option is set, their text will be colored
- accordingly. Note that this may override your color choices, and even
- present a security problem, since a message could include a line like
- "[-- PGP output follows ..." and give it the same color as your
- attachment color.
+ Usage: [un]alternates regexp [ regexp ... ]
- \e[1m6.3.7. arrow_cursor\e[0m
+ 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 yourself won't make much sense in many cases. (See reply-to.)
- Type: boolean
- Default: no
+ 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 addresses you receive mail under. That's the 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.
- When set, an arrow (``->'') will be used to indicate the current entry
- in menus instead of highlighting the whole line. On slow network or
- modem links this will make response faster because there is less that
- has to be redrawn on the screen when moving to the next or previous
- entries in the menu.
+ 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.
- \e[1m6.3.8. ascii_chars\e[0m
+ To remove a regular expression from the alternates list, use the unalternates command with exactly the same regexp. Likewise, if the regexp for a 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.
- Type: boolean
- Default: no
+12. Format = Flowed
- If set, Mutt will use plain ASCII characters when displaying thread
- and attachment trees, instead of the default \e[4mACS\e[24m characters.
+12.1. Introduction
- \e[1m6.3.9. askbcc\e[0m
+ Mutt-ng contains support for so-called format=flowed messages. In the beginning of email, each message had a fixed line width, and it was enough for displaying them on fixed-size terminals. But times changed, and nowadays hardly anybody still uses fixed-size terminals: more people nowaydays use graphical user interfaces, with dynamically resizable windows. This led to the demand of a new email format that makes it possible for the email client to make the email look nice in a resizable window without breaking quoting levels and creating an incompatible email format that can also be displayed nicely on old fixed-size terminals.
- Type: boolean
- Default: no
+ For introductory information on format=flowed messages, see <http://www.joeclark.org/ffaq.html>.
- If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
- before editing an outgoing message.
+12.2. Receiving: Display Setup
- \e[1m6.3.10. askcc\e[0m
+ When you receive emails that are marked as format=flowed messages, and is formatted correctly, mutt-ng will try to reformat the message to optimally fit on your terminal. If you want a fixed margin on the right side of your terminal, you can set the following:
+ set wrapmargin = 10
- Type: boolean
- Default: no
+ The code above makes the line break 10 columns before the right side of the terminal.
- If set, Mutt will prompt you for carbon-copy (Cc) recipients before
- editing the body of an outgoing message.
+ If your terminal is so wide that the lines are embarrassingly long, you can also set a maximum line length:
+ set max_line_length = 120
- 6\b6.\b.3\b3.\b.1\b11\b1.\b. a\bas\bsk\bk_\b_f\bfo\bol\bll\blo\bow\bw_\b_u\bup\bp
+ The example above will give you lines not longer than 120 characters.
- Type: boolean
- Default: no
+ When you view at format=flowed messages, you will often see the quoting hierarchy like in the following example:
+ >Bill, can you please send last month's progress report to Mr.
+ >Morgan? We also urgently need the cost estimation for the new
+ >production server that we want to set up before our customer's
+ >project will go live.
- If set, Mutt will prompt you for follow-up groups before editing the
- body of an outgoing message.
+ This obviously doesn't look very nice, and it makes it very hard to differentiate between text and quoting character. The solution is to configure mutt-ng to "stuff" the quoting:
+ set stuff_quoted
- 6\b6.\b.3\b3.\b.1\b12\b2.\b. a\bas\bsk\bk_\b_x\bx_\b_c\bco\bom\bmm\bme\ben\bnt\bt_\b_t\bto\bo
+ This will lead to a nicer result that is easier to read:
+ > Bill, can you please send last month's progress report to Mr.
+ > Morgan? We also urgently need the cost estimation for the new
+ > production server that we want to set up before our customer's
+ > project will go live.
- Type: boolean
- Default: no
+12.3. Sending
- If set, Mutt will prompt you for x-comment-to field before editing the
- body of an outgoing message.
- 6\b6.\b.3\b3.\b.1\b13\b3.\b. a\bat\btt\bta\bac\bch\bh_\b_f\bfo\bor\brm\bma\bat\bt
+ If you want mutt-ng to send emails with format=flowed set, you need to explicitly set it:
+ set text_flowed
- Type: string
- Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
+ 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.
- This variable describes the format of the `attachment' menu. The
- following printf-style sequences are understood:
+ Also note that format=flowed knows about ``space-stuffing'', that is, when sending messages, some kinds of lines have to be indented with a single space on the sending side. On the receiving side, the first space (if any) is removed. As a consequence and in addition to the above simple setting, please keep this in mind when making manual formattings within the editor. Also note that mutt-ng currently violates the standard (RfC 3676) as it does not space-stuff lines starting with:
+ * > This is not the quote character but a right angle used for other reasons
+ * From with a trailing space.
+ * just a space for formatting reasons
- %\b%C\bC charset
+ Please make sure that you manually prepend a space to each of them.
- %\b%c\bc reqiures charset conversion (n or c)
+12.4. Additional Notes
- %\b%D\bD deleted flag
+ For completeness, the delete-space variable provides the mechanism to generate a DelSp=yes parameter on outgoing 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. Because flowed lines usually contain only one space at the end, this parameter would make the receiving client concatenate the last word of the previous with the first of the current line without a space. This makes ordinary text unreadable and is intended for languages rarely using spaces. So please use this setting only if you're sure what you're doing.
- %\b%d\bd description
+13. Mailing lists
- %\b%e\be MIME content-transfer-encoding
+ Usage: [un]lists regexp [ regexp ... ] Usage: [un]subscribe regexp [ regexp ... ]
- %\b%f\bf filename
+ Mutt-ng has a few nice features for using-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 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 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.
- %\b%I\bI disposition (I=inline, A=attachment)
+ 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, use ``subscribe''.
- %\b%m\bm major MIME type
+ You can use regular expressions with both commands. To mark all messages sent to a specific bug report's address on mutt'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.
- %\b%M\bM MIME subtype
+ Specify as much of the address as you need to to remove ambiguity. For example, if you've subscribed to the Mutt-ng mailing list, you will receive mail addressed to mutt-users@mutt.org. So, to tell Mutt-ng 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 match only mail from the actual list.
- %\b%n\bn attachment number
+ The ``unlists'' command is used to remove a token from the list of known and subscribed mailing-lists. Use ``unlists *'' to remove all tokens.
- %\b%s\bs size
+ To remove a mailing list from the list of subscribed mailing lists, but keep it on the list of known mailing lists, use ``unsubscribe''.
- %\b%t\bt tagged flag
+14. Using Multiple spool mailboxes
- %\b%T\bT graphic tree characters
+ Usage: mbox-hook [!]pattern mailbox
- %\b%u\bu unlink (=to delete) flag
+ 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 read.
- %\b%>\b>X\bX
- right justify the rest of the string and pad with character "X"
+ Unlike some of the other hook commands, only the first matching pattern is used (it is not possible to save read mail in more than a single mailbox).
- %\b%|\b|X\bX
- pad to the end of the line with character "X"
+15. Defining mailboxes which receive mail
- 6\b6.\b.3\b3.\b.1\b14\b4.\b. a\bat\btt\bta\bac\bch\bh_\b_s\bse\bep\bp
+ Usage: [un]mailboxes [!]filename [ filename ... ]
- Type: string
- Default: "\n"
+ 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.
- The separator to add between attachments when operating (saving,
- printing, piping, etc) on a list of tagged attachments.
+ When changing folders, pressing space will cycle through folders with new mail.
- 6\b6.\b.3\b3.\b.1\b15\b5.\b. a\bat\btt\bta\bac\bch\bh_\b_s\bsp\bpl\bli\bit\bt
+ 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-ng will automatically enter this mode when invoked from the command line with the -y option.
- Type: boolean
- Default: yes
+ The ``unmailboxes'' command is used to remove a token from the list of folders which receive mail. Use ``unmailboxes *'' to remove all tokens.
- If this variable is unset, when operating (saving, printing, piping,
- etc) on a list of tagged attachments, Mutt will concatenate the
- attachments and will operate on them as a single attachment. The
- ````$attach_sep'''' separator is added after each attachment. When
- set, Mutt will operate on the attachments one by one.
+ Note: new mail is detected by comparing the last modification time to the last access time. Utilities like biff or frm or any other program which accesses the mailbox might cause Mutt-ng 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.
- 6\b6.\b.3\b3.\b.1\b16\b6.\b. a\bat\btt\btr\bri\bib\bbu\but\bti\bio\bon\bn
+ Note: the filenames in the mailboxes command are resolved when the command is executed, so if these names contain shortcuts (such as ``='' and ``!''), any variable definition that affect these characters (like folder and spoolfile) should be executed before the mailboxes command.
- Type: string
- Default: "On %d, %n wrote:"
+16. User defined headers
- This is the string that will precede a message which has been included
- in a reply. For a full listing of defined printf()-like sequences see
- the section on ````$index_format''''.
+ Usage: my_hdr string unmy_hdr field [ field ... ]
- 6\b6.\b.3\b3.\b.1\b17\b7.\b. a\bau\but\bto\boe\bed\bdi\bit\bt
+ The ``my_hdr'' command allows you to create your own header fields which will be added to every message you send.
- Type: boolean
- Default: no
+ For example, if you would like to add an ``Organization:'' header field to all of your outgoing messages, you can put the command
+my_hdr Organization: A Really Big Company, Anytown, USA
- When set along with ````$edit_headers'''', Mutt will skip the initial
- send-menu and allow you to immediately begin editing the body of your
- message. The send-menu may still be accessed once you have finished
- editing the body of your message.
+ in your .muttrc.
- Also see ````$fast_reply''''.
+ Note: space characters are not allowed between the keyword and the colon (``:''). The standard for electronic mail (RFC822) says that space is illegal there, so Mutt-ng enforces the rule.
- 6\b6.\b.3\b3.\b.1\b18\b8.\b. a\bau\but\bto\bo_\b_t\bta\bag\bg
+ 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 that you can edit the header of your message along with the body.
- Type: boolean
- Default: no
+ 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
- When set, functions in the _\bi_\bn_\bd_\be_\bx menu which affect a message will be
- applied to all tagged messages (if there are any). When unset, you
- must first use the tag-prefix function (default: ";") to make the next
- function apply to all tagged messages.
+17. Defining the order of headers when viewing messages
- 6\b6.\b.3\b3.\b.1\b19\b9.\b. b\bbe\bee\bep\bp
+ Usage: hdr_order header1 header2 header3
- Type: boolean
- Default: yes
+ With this command, you can specify an order in which mutt will attempt to present headers to you when viewing messages.
- When this variable is set, mutt will beep when an error occurs.
+ ``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:
- 6\b6.\b.3\b3.\b.2\b20\b0.\b. b\bbe\bee\bep\bp_\b_n\bne\bew\bw
+18. Specify default save filename
- Type: boolean
- Default: no
+ Usage: save-hook [!]pattern filename
- When this variable is set, mutt will beep whenever it prints a message
- notifying you of new mail. This is independent of the setting of the
- ````$beep'''' variable.
+ This command is used to override the default filename used when saving messages. filename will be used as the default filename if the message is From: an address matching regexp or if you are the author and the message is addressed to: something matching regexp.
- 6\b6.\b.3\b3.\b.2\b21\b1.\b. b\bbo\bou\bun\bnc\bce\be
+ See pattern-hook for information on the exact format of pattern.
- Type: quadoption
- Default: ask-yes
+ Examples:
+save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
+save-hook aol\\.com$ +spam
- Controls whether you will be asked to confirm bouncing messages. If
- set to _\by_\be_\bs you don't get asked if you want to bounce a message.
- Setting this variable to _\bn_\bo is not generally useful, and thus not
- recommended, because you are unable to bounce messages.
+ Also see the fcc-save-hook command.
- 6\b6.\b.3\b3.\b.2\b22\b2.\b. b\bbo\bou\bun\bnc\bce\be_\b_d\bde\bel\bli\biv\bve\ber\bre\bed\bd
+19. Specify default Fcc: mailbox when composing
- Type: boolean
- Default: yes
+ Usage: fcc-hook [!]pattern mailbox
- When this variable is set, mutt will include Delivered-To headers when
- bouncing messages. Postfix users may wish to unset this variable.
+ This command is used to save outgoing mail in a mailbox other than record. Mutt-ng searches the initial list of message recipients for the first matching regexp and uses mailbox as the default Fcc: mailbox. If no match is found the message will be saved to record mailbox.
- 6\b6.\b.3\b3.\b.2\b23\b3.\b. c\bca\bat\btc\bch\bhu\bup\bp_\b_n\bne\bew\bws\bsg\bgr\bro\bou\bup\bp
+ See pattern-hook for information on the exact format of pattern.
- Type: quadoption
- Default: ask-yes
+ Example: fcc-hook [@.]aol\\.com$ +spammers
- If this variable is _\bs_\be_\bt, Mutt will mark all articles in newsgroup as
- read when you quit the newsgroup (catchup newsgroup).
+ 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.
- 6\b6.\b.3\b3.\b.2\b24\b4.\b. c\bch\bha\bar\brs\bse\bet\bt
+20. Specify default save filename and default Fcc: mailbox at once
- Type: string
- Default: ""
+ Usage: fcc-save-hook [!]pattern mailbox
- Character set your terminal uses to display and enter textual data.
+ This command is a shortcut, equivalent to doing both a fcc-hook and a save-hook with its arguments.
- 6\b6.\b.3\b3.\b.2\b25\b5.\b. c\bch\bhe\bec\bck\bk_\b_n\bne\bew\bw
+21. Change settings based upon message recipients
- Type: boolean
- Default: yes
+ Usage: reply-hook [!]pattern command Usage: send-hook [!]pattern command Usage: send2-hook [!]pattern command
- N\bNo\bot\bte\be:\b: this option only affects _\bm_\ba_\bi_\bl_\bd_\bi_\br and _\bM_\bH style mailboxes.
+ 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.
- When _\bs_\be_\bt, Mutt will check for new mail delivered while the mailbox is
- open. Especially with MH mailboxes, this operation can take quite
- some time since it involves scanning the directory and checking each
- file to see if it has already been looked at. If _\bc_\bh_\be_\bc_\bk_\b__\bn_\be_\bw is _\bu_\bn_\bs_\be_\bt,
- no check for new mail is performed while the mailbox is open.
+ 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 of the order specified in the users's configuration file.
- 6\b6.\b.3\b3.\b.2\b26\b6.\b. c\bco\bol\bll\bla\bap\bps\bse\be_\b_u\bun\bnr\bre\bea\bad\bd
+ 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 sendmail variable depending on the message's sender address.
- Type: boolean
- Default: yes
+ 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).
- When _\bu_\bn_\bs_\be_\bt, Mutt will not collapse a thread if it contains any unread
- messages.
+ See pattern-hook for information on the exact format of pattern.
- 6\b6.\b.3\b3.\b.2\b27\b7.\b. u\bun\bnc\bco\bol\bll\bla\bap\bps\bse\be_\b_j\bju\bum\bmp\bp
+ Example: send-hook mutt "set mime_forward signature=''"
- Type: boolean
- Default: no
+ Another typical use for this command is to change the values of the attribution, signature and locale variables in order to change the language of the attributions and signatures based upon the recipients.
- When _\bs_\be_\bt, Mutt will jump to the next unread message, if any, when the
- current thread is _\bu_\bncollapsed.
+ 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.
- 6\b6.\b.3\b3.\b.2\b28\b8.\b. c\bco\bom\bmp\bpo\bos\bse\be_\b_f\bfo\bor\brm\bma\bat\bt
+22. Change settings before formatting a message
- Type: string
- Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"
+ Usage: message-hook [!]pattern command
- Controls the format of the status line displayed in the \fCompose
- menu. This string is similar to ````$status_format'''', but has its
- own set of printf()-like sequences:
+ 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.
- %\b%a\ba total number of attachments
+ See pattern-hook for information on the exact format of pattern.
- %\b%h\bh local hostname
+ Example:
+message-hook ~A 'set pager=builtin'
+message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
- %\b%l\bl approximate size (in bytes) of the current message
+23. Choosing the cryptographic key of the recipient
- %\b%v\bv Mutt version string
+ Usage: crypt-hook pattern keyid
- See the text describing the ````$status_format'''' option for more
- information on how to set ````$compose_format''''.
+ When encrypting messages with PGP 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-ng 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.
- 6\b6.\b.3\b3.\b.2\b29\b9.\b. c\bco\bon\bnf\bfi\bir\brm\bma\bap\bpp\bpe\ben\bnd\bd
+ 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.
- Type: boolean
- Default: yes
+24. Adding key sequences to the keyboard buffer
- When set, Mutt will prompt for confirmation when appending messages to
- an existing mailbox.
+ Usage: push string
- 6\b6.\b.3\b3.\b.3\b30\b0.\b. c\bco\bon\bnf\bfi\bir\brm\bmc\bcr\bre\bea\bat\bte\be
+ 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.
- Type: boolean
- Default: yes
+25. Executing functions
- When set, Mutt will prompt for confirmation when saving messages to a
- mailbox which does not yet exist before creating it.
+ Usage: exec function [ function ... ]
- 6\b6.\b.3\b3.\b.3\b31\b1.\b. c\bco\bon\bnn\bne\bec\bct\bt_\b_t\bti\bim\bme\beo\bou\but\bt
+ This command can be used to execute any function. Functions are listed in the functions. ``exec function'' is equivalent to ``push <function>''.
- Type: number
- Default: 30
+26. Message Scoring
- Causes Mutt to timeout a network connection (for IMAP or POP) after
- this many seconds if the connection is not able to be established. A
- negative value causes Mutt to wait indefinitely for the connection to
- succeed.
+ Usage: score pattern value Usage: unscore pattern [ pattern ... ]
- 6\b6.\b.3\b3.\b.3\b32\b2.\b. c\bco\bon\bnt\bte\ben\bnt\bt_\b_t\bty\byp\bpe\be
+ In situations where you have to cope with a lot of emails, e.g. when you read many different mailing lists, and take part in discussions, it is always useful to have the important messages marked and the annoying messages or the ones that you aren't interested in deleted. For this purpose, mutt-ng features a mechanism called ``scoring''.
- Type: string
- Default: "text/plain"
+ When you use scoring, every message has a base score of 0. You can then use the score command to define patterns and a positive or negative value associated with it. When a pattern matches a message, the message's score will be raised or lowered by the amount of the value associated with the pattern.
+score "~f nion@muttng\.org" 50
+score "~f @sco\.com" -100
- Sets the default Content-Type for the body of newly composed messages.
+ If the pattern matches, it is also possible to set the score value of the current message to a certain value and then stop evaluation:
+score "~f santaclaus@northpole\.int" =666
- 6\b6.\b.3\b3.\b.3\b33\b3.\b. c\bco\bop\bpy\by
+ What is important to note is that negative score values will be rounded up to 0.
- Type: quadoption
- Default: yes
+ To make scoring actually useful, the score must be applied in some way. That's what the score thresholds are for. Currently, there are three score thresholds:
+ * flag threshold: when a message has a score value equal or higher than the flag threshold, it will be flagged.
+ * read threshold: when a message has a score value equal or lower than the read threshold, it will be marked as read.
+ * delete threshold: when a message has a score value equal or lower than the delete threshold, it will be marked as deleted.
- This variable controls whether or not copies of your outgoing messages
- will be saved for later references. Also see ````$record'''',
- ````$save_name'''', ````$force_name'''' and ````fcc-hook''''.
+ These three thresholds can be set via the variables score-threshold-flag, score-threshold-read, score-threshold-delete and. By default, score-threshold-read and score-threshold-delete are set to -1, which means that in the default threshold configuration no message will ever get marked as read or deleted.
- 6\b6.\b.3\b3.\b.3\b34\b4.\b. c\bcr\bry\byp\bpt\bt_\b_a\bau\but\bto\bop\bpg\bgp\bp
+ Scoring gets especially interesting when combined with the color command and the ˜n pattern:
+color index black yellow "~n 10-"
+color index red yellow "~n 100-"
- Type: boolean
- Default: yes
+ 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. This might be unusual to you if you're used to e.g. slrn's scoring mechanism, but it is more flexible, as it visually marks different scores.
- This variable controls whether or not mutt may automatically enable
- PGP encryption/signing for messages. See also
- ````$crypt_autoencrypt'''', ````$crypt_replyencrypt'''',
- ````$crypt_autosign'''', ````$crypt_replysign'''' and
- ````$smime_is_default''''.
+27. Spam detection
- 6\b6.\b.3\b3.\b.3\b35\b5.\b. c\bcr\bry\byp\bpt\bt_\b_a\bau\but\bto\bos\bsm\bmi\bim\bme\be
+ Usage: spam pattern format Usage: nospam pattern
- Type: boolean
- Default: yes
+ Mutt-ng has generalized support for external spam-scoring filters. 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 display using the %H selector in the index-format variable. (Tip: try %?H?[%H] ? to display spam tags only when they are defined for a given message.)
- This variable controls whether or not mutt may automatically enable
- S/MIME encryption/signing for messages. See also
- ````$crypt_autoencrypt'''', ````$crypt_replyencrypt'''',
- ````$crypt_autosign'''', ````$crypt_replysign'''' and
- ````$smime_is_default''''.
+ Your first step is to define your external filter's spam patterns using 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 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 sub-expression contained within parentheses.) %1 is replaced with the first back-reference in the regex, %2 with the second, etc.
- 6\b6.\b.3\b3.\b.3\b36\b6.\b. d\bda\bat\bte\be_\b_f\bfo\bor\brm\bma\bat\bt
+ If you're using multiple spam filters, a message can have more than 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 message's spam tag will consist of all the format strings joined together, with the value of $spam_separator separating them.
- Type: string
- Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
+ For example, suppose I use DCC, SpamAssassin, and PureMessage. I might define these spam settings:
+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=", "
- This variable controls the format of the date printed by the ``%d''
- sequence in ````$index_format''''. This is passed to the _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be
- call to process the date. See the man page for _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be_\b(_\b3_\b) for the
- proper syntax.
+ If I then received a message 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''.)
- Unless the first character in the string is a bang (``!''), the month
- and week day names are expanded according to the locale specified in
- the variable ````$locale''''. If the first character in the string is
- a bang, the bang is discarded, and the month and week day names in the
- rest of the string are expanded in the _\bC locale (that is in US
- English).
+ 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.
- 6\b6.\b.3\b3.\b.3\b37\b7.\b. d\bde\bef\bfa\bau\bul\blt\bt_\b_h\bho\boo\bok\bk
+ The spam tag is what will be displayed in the index when you use %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 attribute will use as a sort key.
- Type: string
- Default: "~f %s !~P | (~P ~C %s)"
+ 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 to sorting.
- This variable controls how send-hooks, message-hooks, save-hooks, and
- fcc-hooks will be interpreted if they are specified with only a simple
- regexp, instead of a matching pattern. The hooks are expanded when
- they are declared, so a hook will be interpreted according to the
- value of this variable at the time the hook is declared. The default
- value matches if the message is either from a user matching the
- regular expression given, or if it is from you (if the from address
- matches ``alternates'') and is to or cc'ed to a user matching the
- given regular expression.
+ Generally, when you sort by spam tag, mutt will sort lexically -- that is, by ordering strings alphnumerically. However, if a spam tag 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 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 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.
- 6\b6.\b.3\b3.\b.3\b38\b8.\b. d\bde\bel\ble\bet\bte\be
+ 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.
- Type: quadoption
- Default: ask-yes
+ 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.
- Controls whether or not messages are really deleted when closing or
- synchronizing a mailbox. If set to _\by_\be_\bs, messages marked for deleting
- will automatically be purged without prompting. If set to _\bn_\bo,
- messages marked for deletion will be kept in the mailbox.
+ 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:
+spam "^From: .*MAILER-DAEMON" "999"
- 6\b6.\b.3\b3.\b.3\b39\b9.\b. d\bde\bel\ble\bet\bte\be_\b_u\bun\bnt\bta\bag\bg
+28. Setting variables
- Type: boolean
- Default: yes
+ Usage: set [no|inv]variable[=value] [ variable ... ] Usage: toggle variable [variable ... ] Usage: unset variable [variable ... ] Usage: reset variable [variable ... ]
- If this option is _\bs_\be_\bt, mutt will untag messages when marking them for
- deletion. This applies when you either explicitly delete a message,
- or when you save it to another folder.
+ This command is used to set (and unset) 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.
- 6\b6.\b.3\b3.\b.4\b40\b0.\b. d\bdi\big\bge\bes\bst\bt_\b_c\bco\bol\bll\bla\bap\bps\bse\be
+ 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.
- Type: boolean
- Default: yes
+ 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 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.''
- If this option is _\bs_\be_\bt, mutt's revattach menu will not show the
- subparts of individual messages in a digest. To see these subparts,
- press 'v' on that menu.
+ Prefixing a variable with ``no'' will unset it. Example: set noaskbcc.
- 6\b6.\b.3\b3.\b.4\b41\b1.\b. d\bdi\bis\bsp\bpl\bla\bay\by_\b_f\bfi\bil\blt\bte\ber\br
+ 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.
- Type: path
- Default: ""
+ The toggle command automatically prepends the inv prefix to all specified variables.
- When set, specifies a command used to filter messages. When a message
- is viewed it is passed as standard input to ``$display_filter'', and
- the filtered message is read from the standard output.
+ The unset command automatically prepends the no prefix to all specified variables.
- 6\b6.\b.3\b3.\b.4\b42\b2.\b. d\bdo\bot\btl\blo\boc\bck\bk_\b_p\bpr\bro\bog\bgr\bra\bam\bm
+ 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
- Type: path
- Default: "/usr/local/bin/mutt_dotlock"
+ The question mark is actually only required for boolean and quadoption variables.
- Contains the path of the mutt_dotlock (8) binary to be used by mutt.
+ 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.
- 6\b6.\b.3\b3.\b.4\b43\b3.\b. d\bds\bsn\bn_\b_n\bno\bot\bti\bif\bfy\by
+ With the reset command there exists the special variable ``all'', which allows you to reset all variables to their system defaults.
- Type: string
- Default: ""
+29. Reading initialization commands from another file
- N\bNo\bot\bte\be:\b: you should not enable this unless you are using Sendmail 8.8.x
- or greater.
+ Usage: source filename [ filename ... ]
- This variable sets the request for when notification is returned. The
- string consists of a comma separated list (no spaces!) of one or more
- of the following: _\bn_\be_\bv_\be_\br, to never request notification, _\bf_\ba_\bi_\bl_\bu_\br_\be, to
- request notification on transmission failure, _\bd_\be_\bl_\ba_\by, to be notified of
- message delays, _\bs_\bu_\bc_\bc_\be_\bs_\bs, to be notified of successful transmission.
+ This command allows the inclusion of initialization commands from other files. For example, I place all of my aliases in ˜/.mail_aliases so that I can make my ˜/.muttrc readable and keep my aliases private.
- Example: set dsn_notify="failure,delay"
+ If the filename begins with a tilde (``˜''), it will be expanded to the path of your home directory.
- 6\b6.\b.3\b3.\b.4\b44\b4.\b. d\bds\bsn\bn_\b_r\bre\bet\btu\bur\brn\bn
+ 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|).
- Type: string
- Default: ""
+30. Removing hooks
- N\bNo\bot\bte\be:\b: you should not enable this unless you are using Sendmail 8.8.x
- or greater.
+ Usage: unhook [ * | hook-type ]
- This variable controls how much of your message is returned in DSN
- messages. It may be set to either _\bh_\bd_\br_\bs to return just the message
- header, or _\bf_\bu_\bl_\bl to return the full message.
+ This command permits you to flush hooks you have previously defined. 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.
- Example: set dsn_return=hdrs
+31. Sharing Setups
- 6\b6.\b.3\b3.\b.4\b45\b5.\b. d\bdu\bup\bpl\bli\bic\bca\bat\bte\be_\b_t\bth\bhr\bre\bea\bad\bds\bs
+31.1. Character Sets
- Type: boolean
- Default: yes
+ As users may run mutt-ng on different systems, the configuration must be maintained because it's likely that people want to use the setup everywhere they use mutt-ng. And mutt-ng tries to help where it can.
- This variable controls whether mutt, when sorting by threads, threads
- messages with the same message-id together. If it is set, it will
- indicate that it thinks they are duplicates of each other with an
- equals sign in the thread diagram.
+ To not produce conflicts with different character sets, mutt-ng allows users to 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 very beginning of a users muttngrc:
+set config_charset = "..."
- 6\b6.\b.3\b3.\b.4\b46\b6.\b. e\bed\bdi\bit\bt_\b_h\bhe\bea\bad\bde\ber\brs\bs
+ and replacing the dots with the actual character set. To avoid problems while maintaining the setup, vim user's may want to use modelines as show in:
+# vim:fileencoding=...:
- Type: boolean
- Default: no
+ while, again, replacing the dots with the appropriate name. This tells vim as which character set to read and save the file.
- This option allows you to edit the header of your outgoing messages
- along with the body of your message.
+31.2. Modularization
- 6\b6.\b.3\b3.\b.4\b47\b7.\b. e\bed\bdi\bit\bto\bor\br
+ ``Modularization'' means to divide the setup into several files while sorting the options or commands by topic. Especially for longer setups (e.g. with many hooks), this helps maintaining it and solving trouble.
- Type: path
- Default: ""
+ When using separation, setups may be, as a whole or in fractions, shared over different systems.
- This variable specifies which editor is used by mutt. It defaults to
- the value of the VISUAL, or EDITOR, environment variable, or to the
- string "vi" if neither of those are set.
+31.3. Conditional parts
- 6\b6.\b.3\b3.\b.4\b48\b8.\b. e\ben\bnc\bco\bod\bde\be_\b_f\bfr\bro\bom\bm
+ When using a configuration on different systems, the user may not always have influence on how mutt-ng is installed and which features it includes.
- Type: boolean
- Default: no
+ To solve this, mutt-ng contain a feature based on the ``ifdef'' patch written for mutt. Its basic syntax is:
+ifdef <item> <command>
+ifndef <item> <command>
- When _\bs_\be_\bt, mutt will quoted-printable encode messages when they contain
- the string "From " in the beginning of a line. Useful to avoid the
- tampering certain mail delivery and transport agents tend to do with
- messages.
+ ...whereby <item> can be one of:
+ * a function name
+ * a variable name
+ * a menu name
+ * a feature name
- 6\b6.\b.3\b3.\b.4\b49\b9.\b. e\ben\bnv\bve\bel\blo\bop\bpe\be_\b_f\bfr\bro\bom\bm
+ All available functions, variables and menus are documented elsewhere in this manual but ``features'' is specific to these two commands. To test for one, prefix one of the following keywords with feature_:
+ncurses, slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
+gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
+classic_smime, gpgme, header_cache
- Type: boolean
- Default: no
+ As an example, one can use the following in ˜/.muttngrc:
+ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
+ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
+ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'
- When _\bs_\be_\bt, mutt will try to derive the message's _\be_\bn_\bv_\be_\bl_\bo_\bp_\be sender from
- the "From:" header. Note that this information is passed to sendmail
- command using the "-f" command line switch, so don't set this option
- if you are using that switch in ``$sendmail'' yourself, or if the
- sendmail on your machine doesn't support that command line switch.
+ ...to only source ˜/.mutt-ng/setup-imap if IMAP support is built in, only source ˜/.mutt-ng/setup-pop if POP support is built in and only source ˜/.mutt-ng/setup-nntp if NNTP support is built in.
- 6\b6.\b.3\b3.\b.5\b50\b0.\b. e\bes\bsc\bca\bap\bpe\be
+ 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 imap-mail-check, use:
+ifdef imap_mail_check 'set imap_mail_check = 300'
- Type: string
- Default: "~"
+ Provided for completeness is the test for menu names. To set pager-index-lines only if the pager menu is available, use:
+ifdef pager 'set pager_index_lines = 10'
- Escape character to use for functions in the builtin editor.
+ For completeness, too, the opposite of ifdef is provided: ifndef which only executes the command if the test fails. For example, the following two examples are equivalent:
+ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
+ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'
- 6\b6.\b.3\b3.\b.5\b51\b1.\b. f\bfa\bas\bst\bt_\b_r\bre\bep\bpl\bly\by
+ ...and...
+ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
+ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'
- Type: boolean
- Default: no
+32. Obsolete Variables
- When set, the initial prompt for recipients and subject are skipped
- when replying to messages, and the initial prompt for subject is
- skipped when forwarding messages.
+ 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 sect-obsolete for a complete list.
- N\bNo\bot\bte\be:\b: this variable has no effect when the ````$autoedit'''' variable
- is set.
+Chapter 4. Advanced Usage
- 6\b6.\b.3\b3.\b.5\b52\b2.\b. f\bfc\bcc\bc_\b_a\bat\btt\bta\bac\bch\bh
+ Table of Contents
- Type: boolean
- Default: yes
+ 1. Regular Expressions
+ 2. Patterns
- This variable controls whether or not attachments on outgoing messages
- are saved along with the main body of your message.
+ 2.1. Complex Patterns
+ 2.2. Patterns and Dates
- 6\b6.\b.3\b3.\b.5\b53\b3.\b. f\bfc\bcc\bc_\b_c\bcl\ble\bea\bar\br
+ 3. Format Strings
- Type: boolean
- Default: no
+ 3.1. Introduction
+ 3.2. Conditional Expansion
+ 3.3. Modifications and Padding
- When this variable is set, FCCs will be stored unencrypted and
- unsigned, even when the actual message is encrypted and/or signed.
- (PGP only)
+ 4. Using Tags
+ 5. Using Hooks
- 6\b6.\b.3\b3.\b.5\b54\b4.\b. f\bfo\bol\bld\bde\ber\br
+ 5.1. Message Matching in Hooks
- Type: path
- Default: "~/Mail"
+ 6. Using the sidebar
+ 7. External Address Queries
+ 8. Mailbox Formats
+ 9. Mailbox Shortcuts
+ 10. Handling Mailing Lists
+ 11. Editing threads
- Specifies the default location of your mailboxes. A `+' or `=' at the
- beginning of a pathname will be expanded to the value of this
- variable. Note that if you change this variable from the default
- value you need to make sure that the assignment occurs _\bb_\be_\bf_\bo_\br_\be you use
- `+' or `=' for any other variables since expansion takes place during
- the `set' command.
+ 11.1. Linking threads
+ 11.2. Breaking threads
- 6\b6.\b.3\b3.\b.5\b55\b5.\b. f\bfo\bol\bld\bde\ber\br_\b_f\bfo\bor\brm\bma\bat\bt
+ 12. Delivery Status Notification (DSN) Support
+ 13. POP3 Support (OPTIONAL)
+ 14. IMAP Support (OPTIONAL)
- Type: string
- Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
+ 14.1. The Folder Browser
+ 14.2. Authentication
- This variable allows you to customize the file browser display to your
- personal taste. This string is similar to ````$index_format'''', but
- has its own set of printf()-like sequences:
+ 15. NNTP Support (OPTIONAL)
- %\b%C\bC current file number
+ 15.1. Again: Scoring
- %\b%d\bd date/time folder was last modified
+ 16. SMTP Support (OPTIONAL)
+ 17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)
+ 18. Start a WWW Browser on URLs (EXTERNAL)
+ 19. Compressed folders Support (OPTIONAL)
- %\b%f\bf filename
+ 19.1. Open a compressed mailbox for reading
+ 19.2. Write a compressed mailbox
+ 19.3. Append a message to a compressed mailbox
+ 19.4. Encrypted folders
- %\b%F\bF file permissions
+1. Regular Expressions
- %\b%g\bg group name (or numeric gid, if missing)
+ All string patterns in Mutt-ng including those in more complex patterns 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.
- %\b%l\bl number of hard links
+ The search is case sensitive if the pattern contains at least one upper case letter, and case insensitive otherwise. Note that ``\'' must be quoted if used for a regular expression in an initialization command: ``\\''.
- %\b%N\bN N if folder has new mail, blank otherwise
+ A regular expression is a pattern that describes a set of strings. Regular expressions are constructed analogously to arithmetic expressions, by using various operators to combine smaller expressions.
- %\b%s\bs size in bytes
+ Note that the regular expression can be enclosed/delimited by either " or ' which is useful if the regular expression includes a white-space character. See muttrc-syntax for more information on " and ' delimiter processing. To match a literal " or ' you must preface it with \ (backslash).
- %\b%t\bt * if the file is tagged, blank otherwise
+ The fundamental building blocks are the regular expressions that match a single character. Most characters, including all letters and digits, are regular expressions that match themselves. Any metacharacter with special meaning may be quoted by preceding it with a backslash.
- %\b%u\bu owner name (or numeric uid, if missing)
+ 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.
- %\b%>\b>X\bX
- right justify the rest of the string and pad with character "X"
+ 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] 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.
- %\b%|\b|X\bX
- pad to the end of the line with character "X"
+ 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:
- 6\b6.\b.3\b3.\b.5\b56\b6.\b. f\bfo\bol\bll\blo\bow\bwu\bup\bp_\b_t\bto\bo
+ [:alnum:]
+ Alphanumeric characters.
- Type: boolean
- Default: yes
+ [:alpha:]
+ Alphabetic characters.
- Controls whether or not the _\bM_\ba_\bi_\bl_\b-_\bF_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b-_\bT_\bo header field is generated
- when sending mail. When _\bs_\be_\bt, Mutt will generate this field when you
- are replying to a known mailing list, specified with the ``subscribe''
- or ````lists'''' commands.
+ [:blank:]
+ Space or tab characters.
- This field has two purposes. First, preventing you from receiving
- duplicate copies of replies to messages which you send to mailing
- lists, and second, ensuring that you do get a reply separately for any
- messages sent to known lists to which you are not subscribed. The
- header will contain only the list's address for subscribed lists, and
- both the list address and your own email address for unsubscribed
- lists. Without this header, a group reply to your message sent to a
- subscribed list will be sent to both the list and your address,
- resulting in two copies of the same email for you.
+ [:cntrl:]
+ Control characters.
- 6\b6.\b.3\b3.\b.5\b57\b7.\b. f\bfo\bol\bll\blo\bow\bwu\bup\bp_\b_t\bto\bo_\b_p\bpo\bos\bst\bte\ber\br
+ [:digit:]
+ Numeric characters.
- Type: quadoption
- Default: ask-yes
+ [:graph:]
+ Characters that are both printable and visible. (A space is printable, but not visible, while an ``a'' is both.)
- If this variable is _\bs_\be_\bt and the keyword "poster" is present in
- _\bF_\bo_\bl_\bl_\bo_\bw_\bu_\bp_\b-_\bT_\bo header, follow-up to newsgroup function is not permitted.
- The message will be mailed to the submitter of the message via mail.
+ [:lower:]
+ Lower-case alphabetic characters.
- 6\b6.\b.3\b3.\b.5\b58\b8.\b. f\bfo\bor\brc\bce\be_\b_n\bna\bam\bme\be
+ [:print:]
+ Printable characters (characters that are not control characters.)
- Type: boolean
- Default: no
+ [:punct:]
+ Punctuation characters (characters that are not letter, digits, control characters, or space characters).
- This variable is similar to ````$save_name'''', except that Mutt will
- store a copy of your outgoing message by the username of the address
- you are sending to even if that mailbox does not exist.
+ [:space:]
+ Space characters (such as space, tab and formfeed, to name a few).
- Also see the ````$record'''' variable.
+ [:upper:]
+ Upper-case alphabetic characters.
- 6\b6.\b.3\b3.\b.5\b59\b9.\b. f\bfo\bor\brw\bwa\bar\brd\bd_\b_d\bde\bec\bco\bod\bde\be
+ [:xdigit:]
+ Characters that are hexadecimal digits.
- Type: boolean
- Default: yes
+ 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].
- Controls the decoding of complex MIME messages into text/plain when
- forwarding a message. The message header is also RFC2047 decoded.
- This variable is only used, if ````$mime_forward'''' is _\bu_\bn_\bs_\be_\bt,
- otherwise ````$mime_forward_decode'''' is used instead.
+ 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:
- 6\b6.\b.3\b3.\b.6\b60\b0.\b. f\bfo\bor\brw\bwa\bar\brd\bd_\b_e\bed\bdi\bit\bt
+ 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''.
- Type: quadoption
- Default: yes
+ 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''.
- This quadoption controls whether or not the user is automatically
- placed in the editor when forwarding messages. For those who always
- want to forward with no modification, use a setting of ``no''.
+ A regular expression matching a single character may be followed by one of several repetition operators:
- 6\b6.\b.3\b3.\b.6\b61\b1.\b. f\bfo\bor\brw\bwa\bar\brd\bd_\b_f\bfo\bor\brm\bma\bat\bt
+ ?
+ The preceding item is optional and matched at most once.
- Type: string
- Default: "[%a: %s]"
+ *
+ The preceding item will be matched zero or more times.
- This variable controls the default subject when forwarding a message.
- It uses the same format sequences as the ````$index_format''''
- variable.
+ +
+ The preceding item will be matched one or more times.
- 6\b6.\b.3\b3.\b.6\b62\b2.\b. f\bfo\bor\brw\bwa\bar\brd\bd_\b_q\bqu\buo\bot\bte\be
+ {n}
+ The preceding item is matched exactly n times.
- Type: boolean
- Default: no
+ {n,}
+ The preceding item is matched n or more times.
- When _\bs_\be_\bt forwarded messages included in the main body of the message
- (when ````$mime_forward'''' is _\bu_\bn_\bs_\be_\bt) will be quoted using
- ````$indent_string''''.
+ {,m}
+ The preceding item is matched at most m times.
- 6\b6.\b.3\b3.\b.6\b63\b3.\b. f\bfr\bro\bom\bm
+ {n,m}
+ The preceding item is matched at least n times, but no more than m times.
- Type: e-mail address
- Default: ""
+ Two regular expressions may be concatenated; the resulting regular expression matches any string formed by concatenating two substrings that respectively match the concatenated subexpressions.
- When set, this variable contains a default from address. It can be
- overridden using my_hdr (including from send-hooks) and
- ````$reverse_name''''. This variable is ignored if ````$use_from''''
- is unset.
+ Two regular expressions may be joined by the infix operator ``|''; the resulting regular expression matches any string matching either subexpression.
- Defaults to the contents of the environment variable EMAIL.
+ Repetition takes precedence over concatenation, which in turn takes precedence over alternation. A whole subexpression may be enclosed in parentheses to override these precedence rules.
- 6\b6.\b.3\b3.\b.6\b64\b4.\b. g\bge\bec\bco\bos\bs_\b_m\bma\bas\bsk\bk
+ Note: If you compile Mutt-ng with the GNU rx package, the following operators may also be used in regular expressions:
- Type: regular expression
- Default: "^[^,]*"
+ \\y
+ Matches the empty string at either the beginning or the end of a word.
- A regular expression used by mutt to parse the GECOS field of a
- password entry when expanding the alias. By default the regular
- expression is set to "^[^,]*" which will return the string up to the
- first "," encountered. If the GECOS field contains a string like
- "lastname, firstname" then you should set the gecos_mask=".*".
+ \\B
+ Matches the empty string within a word.
- This can be useful if you see the following behavior: you address a e-
- mail to user ID stevef whose full name is Steve Franklin. If mutt
- expands stevef to "Franklin" stevef@foo.bar then you should set the
- gecos_mask to a regular expression that will match the whole name so
- mutt will expand "Franklin" to "Franklin, Steve".
+ \\<
+ Matches the empty string at the beginning of a word.
- 6\b6.\b.3\b3.\b.6\b65\b5.\b. g\bgr\bro\bou\bup\bp_\b_i\bin\bnd\bde\bex\bx_\b_f\bfo\bor\brm\bma\bat\bt
+ \\>
+ Matches the empty string at the end of a word.
- Type: string
- Default: "%4C %M%N %5s %-45.45f %d"
+ \\w
+ Matches any word-constituent character (letter, digit, or underscore).
- This variable allows you to customize the newsgroup browser display to
- your personal taste. This string is similar to ````index_format'''',
- but has its own set of printf()-like sequences:
+ \\W
+ Matches any character that is not word-constituent.
- %C current newsgroup number
- %d description of newsgroup (becomes from server)
- %f newsgroup name
- %M - if newsgroup not allowed for direct post (moderated for example)
- %N N if newsgroup is new, u if unsubscribed, blank otherwise
- %n number of new articles in newsgroup
- %s number of unread articles in newsgroup
- %>X right justify the rest of the string and pad with character "X"
- %|X pad to the end of the line with character "X"
+ \\`
+ Matches the empty string at the beginning of a buffer (string).
- 6\b6.\b.3\b3.\b.6\b66\b6.\b. h\bhd\bdr\brs\bs
+ \\'
+ Matches the empty string at the end of a buffer.
- Type: boolean
- Default: yes
+ Please note however that these operators are not defined by POSIX, so they may or may not be available in stock libraries on various systems.
- When unset, the header fields normally added by the ````my_hdr''''
- command are not created. This variable _\bm_\bu_\bs_\bt be unset before composing
- a new message or replying in order to take effect. If set, the user
- defined header fields are added to every new message.
+2. Patterns
- 6\b6.\b.3\b3.\b.6\b67\b7.\b. h\bhe\bea\bad\bde\ber\br
+ Mutt-ng's pattern language provides a simple yet effective way to set up rules to match messages, e.g. for operations like tagging and scoring. A pattern consists 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 patterns in the Reference chapter.
- Type: boolean
- Default: no
+ 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 possible.
- When set, this variable causes Mutt to include the header of the
- message you are replying to into the edit buffer. The ````$weed''''
- setting applies.
+2.1. Complex Patterns
- 6\b6.\b.3\b3.\b.6\b68\b8.\b. h\bhe\bel\blp\bp
+ It is possible to combine several sub-patterns to a more complex pattern. The most simple possibility is to logically AND several patterns by stringing them together:
+~s 'SPAM' ~U
- Type: boolean
- Default: yes
+ The pattern above matches all messages that contain ``SPAM'' in the subject and are unread.
- When set, help lines describing the bindings for the major functions
- provided by each menu are displayed on the first line of the screen.
+ To logical OR patterns, simply use the | operator. This one especially useful when using local groups:
+~f ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
+(~b mutt-ng|~s Mutt-ng)
+!~x '@synflood\.at'
- N\bNo\bot\bte\be:\b: The binding will not be displayed correctly if the function is
- bound to a sequence rather than a single keystroke. Also, the help
- line may not be updated if a binding is changed while Mutt is running.
- Since this variable is primarily aimed at new users, neither of these
- should present a major problem.
+ The first pattern matches all messages that were sent by one of the mutt-ng maintainers, while the seconds pattern matches all messages that contain ``mutt-ng'' in the message body or ``Mutt-ng'' in the subject. The third pattern matches all messages that do not contain ``@synflood\.at'' in the References: header, i.e. messages that are not an (indirect) reply to one of my messages. A pattern can be logicall negated using the ! operator.
- 6\b6.\b.3\b3.\b.6\b69\b9.\b. h\bhi\bid\bdd\bde\ben\bn_\b_h\bho\bos\bst\bt
+2.2. Patterns and Dates
- Type: boolean
- Default: no
+ When using dates in patterns, the dates must be specified in a special format, i.e. DD/MM/YYYY. If you don't specify month or year, they default to the current month or year. When using date ranges, and you specify only the minimum or the maximum, the specified date will be excluded, e.g. 01/06/2005- matches against all messages after Juni 1st, 2005.
- When set, mutt will skip the host name part of ````$hostname''''
- variable when adding the domain part to addresses. This variable does
- not affect the generation of Message-IDs, and it will not lead to the
- cut-off of first-level domains.
- 6\b6.\b.3\b3.\b.7\b70\b0.\b. h\bhi\bid\bde\be_\b_l\bli\bim\bmi\bit\bte\bed\bd
+ It is also possible to use so-called ``error margins'' when specifying date ranges. You simply specify a date, and then the error margin. This margin needs to contain the information whether it goes ``forth'' or ``back'' in time, by using + and -. Then follows a number and a unit, i.e. y for years, m for months, w for weeks and d for days. If you use the special * sign, it means that the error margin goes to both ``directions'' in time.
+~d 01/01/2005+1y
+~d 18/10/2004-2w
+~d 28/12/2004*1d
- Type: boolean
- Default: no
+ The first pattern matches all dates between January 1st, 2005 and January 1st 2006. The second pattern matches all dates between October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004), while the third pattern matches all dates 1 day around December 28th, 2004 (i.e. Dec 27th, 28th and 29th).
- When set, mutt will not show the presence of messages that are hidden
- by limiting, in the thread tree.
+ Relative dates are also very important, as they make it possible to specify date ranges between a fixed number of units and the current date. How this works can be seen in the following example:
+~d >2w # messages older than two weeks
+~d <3d # messages newer than 3 days
+~d =1m # messages that are exactly one month old
- 6\b6.\b.3\b3.\b.7\b71\b1.\b. h\bhi\bid\bde\be_\b_m\bmi\bis\bss\bsi\bin\bng\bg
+3. Format Strings
- Type: boolean
- Default: yes
+3.1. Introduction
- When set, mutt will not show the presence of missing messages in the
- thread tree.
+ The so called Format Strings offer great flexibility when configuring mutt-ng. In short, they describe what items to print out how in menus and status messages.
- 6\b6.\b.3\b3.\b.7\b72\b2.\b. h\bhi\bid\bde\be_\b_t\bto\bop\bp_\b_l\bli\bim\bmi\bit\bte\bed\bd
+ Basically, they work as this: for different menus and bars, there's a variable specifying the layout. For every item available, there is a so called expando.
- Type: boolean
- Default: no
+ For example, when running mutt-ng on different machines or different versions for testing purposes, it may be interesting to have the following information always printed on screen when one is in the index:
+ * the current hostname
+ * the current mutt-ng version number
- When set, mutt will not show the presence of messages that are hidden
- by limiting, at the top of threads in the thread tree. Note that when
- ``$hide_missing'' is set, this option will have no effect.
+ The setting for the status bar of the index is controlled via the status-format 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:
+set status_format = "%v on %h: ..."
- 6\b6.\b.3\b3.\b.7\b73\b3.\b. h\bhi\bid\bde\be_\b_t\bto\bop\bp_\b_m\bmi\bis\bss\bsi\bin\bng\bg
+ mutt-ng will replace the sequence %v with the version string and %h with the host's name. When you are, for example, running mutt-ng version 1.5.9i on host mailhost, you'll see the following when you're in the index:
+Mutt-ng 1.5.9i on mailhost: ...
- Type: boolean
- Default: yes
+ In the index, there're more useful information one could want to see:
+ * which mailbox is open
+ * how man new, flagged or postponed messages
+ * ...
- When set, mutt will not show the presence of missing messages at the
- top of threads in the thread tree. Note that when ``$hide_limited''
- is set, this option will have no effect.
+ To include the mailbox' name is as easy as:
+set status_format = "%v on %h: %B: ...
- 6\b6.\b.3\b3.\b.7\b74\b4.\b. h\bhi\bis\bst\bto\bor\bry\by
+ When the currently opened mailbox is Inbox, this will be expanded to:
+Mutt-ng 1.5.9i on mailhost: Inbox: ...
- Type: number
- Default: 10
+ 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 not be desired to print just that there aren't any but instead only print something if there are any.
- This variable controls the size (in number of strings remembered) of
- the string history buffer. The buffer is cleared each time the
- variable is set.
+3.2. Conditional Expansion
- 6\b6.\b.3\b3.\b.7\b75\b5.\b. h\bho\bon\bno\bor\br_\b_f\bfo\bol\bll\blo\bow\bwu\bup\bp_\b_t\bto\bo
+ To only print the number of messages if there are new messages in the current mailbox, further extend $status_format to:
+set status_format = "%v on %h: %B %?n?%n new? ...
- Type: quadoption
- Default: yes
+ This feature is called nonzero-printing and works as this: some expandos may be optionally printed nonzero, i.e. a portion of the format string is only evaluated if the value of the expando is different from zero. The basic syntax is:
+%?<item>?<string if nonzero>?
- This variable controls whether or not a Mail-Followup-To header is
- honored when group-replying to a message.
- 6\b6.\b.3\b3.\b.7\b76\b6.\b. h\bho\bos\bst\btn\bna\bam\bme\be
+ which tells mutt-ng to only look at <string if nonzero> if the value of the %<item%gt; expando is different from zero. In our example, we used n as the expando to check for and %n new as the optional nonzero string.
- Type: string
- Default: ""
+ But this is not all: this feature only offers one alternative: ``print something if not zero.'' Mutt-ng does, as you might guess, also provide a logically complete version: ``if zero, print something and else print something else.'' This is achieved by the following syntax for those expandos which may be printed nonzero:
+%?<item>?<string if nonzero>&<string if zero>?
- Specifies the hostname to use after the ``@'' in local e-mail
- addresses. This overrides the compile time definition obtained from
- /etc/resolv.conf.
+ Using this we can make mutt-ng to do the following:
+ * make it print ``n new messages'' whereby n is the count but only if there new ones
+ * and make it print ``no new messages'' if there aren't any
- 6\b6.\b.3\b3.\b.7\b77\b7.\b. i\big\bgn\bno\bor\bre\be_\b_l\bli\bis\bst\bt_\b_r\bre\bep\bpl\bly\by_\b_t\bto\bo
+ The corresponding configuration is:
+set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...
- Type: boolean
- Default: no
+ This doubles the use of the ``new messages'' string because it'll get always printed. Thus, it can be shortened to:
+set status_format = "%v on %h: %B: %?n?%n&no? new messages ...
- Affects the behaviour of the _\br_\be_\bp_\bl_\by function when replying to messages
- from mailing lists. When set, if the ``Reply-To:'' field is set to
- the same value as the ``To:'' field, Mutt assumes that the ``Reply-
- To:'' field was set by the mailing list to automate responses to the
- list, and will ignore this field. To direct a response to the mailing
- list when this option is set, use the _\bl_\bi_\bs_\bt_\b-_\br_\be_\bp_\bl_\by function; _\bg_\br_\bo_\bu_\bp_\b-_\br_\be_\bp_\bl_\by
- will reply to both the sender and the list.
+ 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.
- 6\b6.\b.3\b3.\b.7\b78\b8.\b. i\bim\bma\bap\bp_\b_a\bau\but\bth\bhe\ben\bnt\bti\bic\bca\bat\bto\bor\brs\bs
+3.3. Modifications and Padding
- Type: string
- Default: ""
+ Besides the information given so far, there're even more features of format strings:
+ * When specifying %_<item> instead of just %<item>, mutt-ng will convert all characters in the expansion of <item> to lowercase.
+ * When specifying %:<item> instead of just %<item>, mutt-ng will convert all dots in the expansion of <item> to underscores (_).
- This is a colon-delimited list of authentication methods mutt may
- attempt to use to log in to an IMAP server, in the order mutt should
- try them. Authentication methods are either 'login' or the right side
- of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', parameter is
- unset (the default) mutt will try all available methods, in order from
- most-secure to least-secure.
+ Also, there's a feature called Padding supplied by the following two expandos: %|X and %>X.
- Example: set imap_authenticators="gssapi:cram-md5:login"
+ %|X
+ When this occurs, mutt-ng will fill the rest of the line with the character X. In our example, filling the rest of the line with dashes is done by setting:
- N\bNo\bot\bte\be:\b: Mutt will only fall back to other authentication methods if the
- previous methods are unavailable. If a method is available but
- authentication fails, mutt will not connect to the IMAP server.
+set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"
- 6\b6.\b.3\b3.\b.7\b79\b9.\b. i\bim\bma\bap\bp_\b_d\bde\bel\bli\bim\bm_\b_c\bch\bha\bar\brs\bs
+ %>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 of our example on the left but on the right and fill the gap with spaces, one might use (note the space after %>):
- Type: string
- Default: "/."
+set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"
- This contains the list of characters which you would like to treat as
- folder separators for displaying IMAP paths. In particular it helps in
- using the '=' shortcut for your _\bf_\bo_\bl_\bd_\be_\br variable.
+4. Using Tags
- 6\b6.\b.3\b3.\b.8\b80\b0.\b. i\bim\bma\bap\bp_\b_f\bfo\bor\brc\bce\be_\b_s\bss\bsl\bl
+ 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 default. See patterns for Mutt-ng's pattern matching syntax.
- Type: boolean
- Default: no
+ 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 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''.
- If this variable is set, Mutt will always use SSL when connecting to
- IMAP servers.
+ In macro 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-ng 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.
- 6\b6.\b.3\b3.\b.8\b81\b1.\b. i\bim\bma\bap\bp_\b_h\bho\bom\bme\be_\b_n\bna\bam\bme\bes\bsp\bpa\bac\bce\be
+5. Using Hooks
- Type: string
- Default: ""
+ A hook is a concept borrowed from the EMACS editor 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-ng world, a hook consists of a regexp or patterns along with a configuration option/command. See
+ * folder-hook
+ * send-hook
+ * message-hook
+ * save-hook
+ * mbox-hook
+ * fcc-hook
+ * fcc-save-hook
- You normally want to see your personal folders alongside your INBOX in
- the IMAP browser. If you see something else, you may set this variable
- to the IMAP path to your folders.
+ for specific details on each type of hook available.
- 6\b6.\b.3\b3.\b.8\b82\b2.\b. i\bim\bma\bap\bp_\b_k\bke\bee\bep\bpa\bal\bli\biv\bve\be
+ 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:
+send-hook . 'unmy_hdr From:'
+send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
- Type: number
- Default: 900
+5.1. Message Matching in Hooks
- This variable specifies the maximum amount of time in seconds that
- mutt will wait before polling open IMAP connections, to prevent the
- server from closing them before mutt has finished with them. The
- default is well within the RFC-specified minimum amount of time (30
- minutes) before a server is allowed to do this, but in practice the
- RFC does get violated every now and then. Reduce this number if you
- find yourself getting disconnected from your IMAP server due to
- inactivity.
+ 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 regexp 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.
- 6\b6.\b.3\b3.\b.8\b83\b3.\b. i\bim\bma\bap\bp_\b_l\bli\bis\bst\bt_\b_s\bsu\bub\bbs\bsc\bcr\bri\bib\bbe\bed\bd
+ Mutt-ng allows the use of the patterns 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 the message (i.e. from, to, cc, date, subject, etc.).
- Type: boolean
- Default: no
+ 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-ng User <user@host>'
- This variable configures whether IMAP folder browsing will look for
- only subscribed folders or all folders. This can be toggled in the
- IMAP browser with the _\bt_\bo_\bg_\bg_\bl_\be_\b-_\bs_\bu_\bb_\bs_\bc_\br_\bi_\bb_\be_\bd function.
+ which would execute the given command when sending mail to me@cs.hmc.edu.
- 6\b6.\b.3\b3.\b.8\b84\b4.\b. i\bim\bma\bap\bp_\b_p\bpa\bas\bss\bs
+ 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-ng will translate your 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 default-hook that is in effect at that time will be used.
- Type: string
- Default: ""
+6. Using the sidebar
- Specifies the password for your IMAP account. If unset, Mutt will
- prompt you for your password when you invoke the fetch-mail function.
- W\bWa\bar\brn\bni\bin\bng\bg: you should only use this option when you are on a fairly
- secure machine, because the superuser can read your muttrc even if you
- are the only one who can read the file.
+ The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing which looks very similar to the ones you probably know from GUI mail clients. The sidebar lists all specified mailboxes, shows the number in each and highlights the ones with new email Use the following configuration commands:
+set sidebar_visible="yes"
+set sidebar_width=25
- 6\b6.\b.3\b3.\b.8\b85\b5.\b. i\bim\bma\bap\bp_\b_p\bpa\bas\bss\bsi\biv\bve\be
+ If you want to specify the mailboxes you can do so with:
+set mbox='=INBOX'
+mailboxes INBOX \
+ MBOX1 \
+ MBOX2 \
+ ...
- Type: boolean
- Default: yes
+ You can also specify the colors for mailboxes with new mails by using:
+color sidebar_new red black
+color sidebar white black
- When set, mutt will not open new IMAP connections to check for new
- mail. Mutt will only check for new mail over existing IMAP
- connections. This is useful if you don't want to be prompted to
- user/password pairs on mutt invocation, or if opening the connection
- is slow.
+ The available functions are:
+sidebar-scroll-up Scrolls the mailbox list up 1 page
+sidebar-scroll-down Scrolls the mailbox list down 1 page
+sidebar-next Highlights the next mailbox
+sidebar-next-new Highlights the next mailbox with new mail
+sidebar-previous Highlights the previous mailbox
+sidebar-open Opens the currently highlighted mailbox
- 6\b6.\b.3\b3.\b.8\b86\b6.\b. i\bim\bma\bap\bp_\b_p\bpe\bee\bek\bk
+ Reasonable key bindings look e.g. like this:
+bind index \Cp sidebar-prev
+bind index \Cn sidebar-next
+bind index \Cb sidebar-open
+bind pager \Cp sidebar-prev
+bind pager \Cn sidebar-next
+bind pager \Cb sidebar-open
- Type: boolean
- Default: yes
+macro index B ':toggle sidebar_visible^M'
+macro pager B ':toggle sidebar_visible^M'
- If set, mutt will avoid implicitly marking your mail as read whenever
- you fetch a message from the server. This is generally a good thing,
- but can make closing an IMAP folder somewhat slower. This option
- exists to appease speed freaks.
+ You can then go up and down by pressing Ctrl-P and Ctrl-N, and switch on and off the sidebar simply by pressing 'B'.
- 6\b6.\b.3\b3.\b.8\b87\b7.\b. i\bim\bma\bap\bp_\b_s\bse\ber\brv\bve\ber\brn\bno\boi\bis\bse\be
+7. External Address Queries
- Type: boolean
- Default: yes
+ 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 query-command variable, you specify the wrapper command to use. For example:
+set query_command = "mutt_ldap_query.pl '%s'"
- When set, mutt will display warning messages from the IMAP server as
- error messages. Since these messages are often harmless, or generated
- due to configuration problems on the server which are out of the
- users' hands, you may wish to suppress them at some point.
+ 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 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.
- 6\b6.\b.3\b3.\b.8\b88\b8.\b. i\bim\bma\bap\bp_\b_u\bus\bse\ber\br
+ An example multiple response output:
+Searching database ... 20 entries ... 3 matching:
+me@cs.hmc.edu Michael Elkins mutt dude
+blong@fiction.net Brandon Long mutt and more
+roessler@guug.de Thomas Roessler mutt pgp
- Type: string
- Default: ""
+ 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 to mail, start a new query, or have a new query appended to the current responses.
- Your login name on the IMAP server.
+ 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 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 menu. At the query menu, you can select one or more addresses to be added to the prompt.
- This variable defaults to your user name on the local machine.
+8. Mailbox Formats
- 6\b6.\b.3\b3.\b.8\b89\b9.\b. i\bim\bmp\bpl\bli\bic\bci\bit\bt_\b_a\bau\but\bto\bov\bvi\bie\bew\bw
+ 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 mbox-type variable.
- Type: boolean
- Default: no
+ mbox. This is the most 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
- If set to ``yes'', mutt will look for a mailcap entry with the
- copiousoutput flag set for _\be_\bv_\be_\br_\by MIME attachment it doesn't have an
- internal viewer defined for. If such an entry is found, mutt will use
- the viewer defined in that entry to convert the body part to text
- form.
+ to denote the start of a new message (this is often referred to as the ``From_'' line).
- 6\b6.\b.3\b3.\b.9\b90\b0.\b. i\bin\bnc\bcl\blu\bud\bde\be
+ MMDF. This is a variant of the mbox format. Each message is surrounded by lines containing ``^A^A^A^A'' (four control-A's).
- Type: quadoption
- Default: ask-yes
+ 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-ng displays). Deleted messages are renamed with a comma (,) prepended to the filename. Note: Mutt detects this type of mailbox by looking for either .mh_sequences or .xmhcache (needed to distinguish normal directories from MH mailboxes).
- Controls whether or not a copy of the message(s) you are replying to
- is included in your reply.
+ 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.
- 6\b6.\b.3\b3.\b.9\b91\b1.\b. i\bin\bnd\bde\ben\bnt\bt_\b_s\bst\btr\bri\bin\bng\bg
+9. Mailbox Shortcuts
- Type: string
- Default: "> "
+ 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.
+ * ! -- refers to your spoolfile (incoming) mailbox
+ * > -- refers to your mbox file
+ * < -- refers to your record file
+ * ^ -- refers to the current mailbox
+ * - or !! -- refers to the file you've last visited
+ * ˜ -- refers to your home directory
+ * = or + -- refers to your folder directory
+ * @alias -- refers to the save-hook as determined by the address of the alias
- Specifies the string to prepend to each line of text quoted in a
- message to which you are replying. You are strongly encouraged not to
- change this value, as it tends to agitate the more fanatical netizens.
+10. Handling Mailing Lists
- 6\b6.\b.3\b3.\b.9\b92\b2.\b. i\bin\bnd\bde\bex\bx_\b_f\bfo\bor\brm\bma\bat\bt
+ Mutt-ng has a few configuration options that make dealing with large 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 commands in your muttrc.
- Type: string
- Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
+ 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 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).
- This variable allows you to customize the message index display to
- your personal taste.
+ 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 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).
- ``Format strings'' are similar to the strings used in the ``C''
- function printf to format output (see the man page for more detail).
- The following sequences are defined in Mutt:
+ 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 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 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.
- %\b%a\ba address of the author
+ Conversely, when group-replying or list-replying to a message which 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 that the reply goes to the mailing list, even if it's not specified in the list of recipients in the Mail-Followup-To.
- %\b%A\bA reply-to address (if present; otherwise: address of author)
+ Note that, when header editing is enabled, you can create a Mail-Followup-To header manually. Mutt-ng will only auto-generate this header if it doesn't exist when you send the message.
- %\b%b\bb filename of the original message folder (think mailBox)
+ The other method some mailing list admins use is to generate a ``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'' field. Mutt-ng 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 present.
- %\b%B\bB the list to which the letter was sent, or else the folder name
- (%b).
+ 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 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.
- %\b%c\bc number of characters (bytes) in the message
+ Lastly, Mutt-ng has the ability to sort the mailbox into threads. 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 graphically. 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.
- %\b%C\bC current message number
+11. Editing threads
- %\b%d\bd date and time of the message in the format specified by
- ``date_format'' converted to sender's time zone
+ Mutt-ng 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 annoyances which make it hard to follow a discussion.
- %\b%D\bD date and time of the message in the format specified by
- ``date_format'' converted to the local time zone
+11.1. Linking threads
- %\b%e\be current message number in thread
+ 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-ng 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.
- %\b%E\bE number of messages in current thread
+ You can also connect multiple children at once, tagging them and using the tag-prefix command (';') or the auto_tag option.
- %\b%f\bf entire From: line (address + real name)
+11.2. Breaking threads
- %\b%F\bF author name, or recipient name if the message is from you
+ 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 the subject to a totally unrelated one. 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.
- %\b%g\bg newsgroup name (if compiled with nntp support)
+12. Delivery Status Notification (DSN) Support
- %\b%i\bi message-id of the current message
+ 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.''
- %\b%l\bl number of lines in the message (does not work with maildir, mh,
- and possibly IMAP folders)
+ Users can make use of it in one of the following two ways:
+ * Berkeley sendmail 8.8.x currently has some command line options in which the mail client can make requests as to what type of status messages should be returned.
+ * The SMTP support via libESMTP supports it, too.
- %\b%L\bL If an address in the To or CC header field matches an address
- defined by the users ``subscribe'' command, this displays "To
- <list-name>", otherwise the same as %F.
+ To support this, there are two variables:
+ * dsn-notify is used to request receipts for different results (such as failed message, message delivered, etc.).
+ * dsn-return requests how much of your message should be returned with the receipt (headers or full message).
- %\b%m\bm total number of message in the mailbox
+ Please see the reference chapter for possible values.
- %\b%M\bM number of hidden messages if the thread is collapsed.
+13. POP3 Support (OPTIONAL)
- %\b%N\bN message score
+ If Mutt-ng was 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.
- %\b%n\bn author's real name (or address if missing)
+ You can access the remote POP3 mailbox by selecting the folder pop://popserver/.
- %\b%O\bO (_O_riginal save folder) Where mutt would formerly have stashed
- the message: list name or recipient name if no list
+ You can select an alternative port by specifying it with the server, i.e.: pop://popserver:port/.
- %\b%s\bs subject of the message
+ You can also specify different username for each folder, i.e.: pop://username@popserver[:port]/.
- %\b%S\bS status of the message (N/D/d/!/r/*)
+ 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 pop-mail-check variable, which defaults to every 60 seconds.
- %\b%t\bt `to:' field (recipients)
+ If Mutt-ng was compiled with SSL support (by running the configure script with the --with-ssl flag), connections to POP3 servers can be encrypted. This naturally requires that the server supports SSL encrypted connections. To access a folder with POP3/SSL, you should use pops: prefix, ie: pops://[username@]popserver[:port]/.
- %\b%T\bT the appropriate character from the ``$to_chars'' string
+ 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-ng runs exactly as if the mail had always been local.
- %\b%u\bu user (login) name of the author
+ Note: If you only need to fetch all messages to local mailbox you should consider using a specialized program, such as fetchmail
- %\b%v\bv first name of the author, or the recipient if the message is
- from you
+14. IMAP Support (OPTIONAL)
- %\b%W\bW name of organization of author (`organization:' field)
+ If Mutt-ng was compiled with IMAP support (by running the configure script with the --enable-imap flag), it has the ability to work with folders located on a remote IMAP server.
- %\b%y\by `x-label:' field, if present
+ You can access the remote inbox by selecting the folder imap://imapserver/INBOX, where imapserver is the name of the IMAP server and 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 you want to access.
- %\b%Y\bY `x-label' field, if present, and (1) not at part of a thread
- tree, (2) at the top of a thread, or (3) `x-label' is different
- from preceding message's `x-label'.
+ You can select an alternative port by specifying it with the server, i.e.: imap://imapserver:port/INBOX.
- %\b%Z\bZ message status flags
+ You can also specify different username for each folder, i.e.: imap://username@imapserver[:port]/INBOX.
- %\b%{\b{f\bfm\bmt\bt}\b}
- the date and time of the message is converted to sender's time
- zone, and ``fmt'' is expanded by the library function
- ``strftime''; a leading bang disables locales
+ If Mutt-ng was compiled with SSL support (by running the configure script with the --with-ssl flag), connections to IMAP servers can be encrypted. This naturally requires that the server supports SSL encrypted connections. To access a folder with IMAP/SSL, you should use imaps://[username@]imapserver[:port]/path/to/folder as your folder path.
- %\b%[\b[f\bfm\bmt\bt]\b]
- the date and time of the message is converted to the local time
- zone, and ``fmt'' is expanded by the library function
- ``strftime''; a leading bang disables locales
+ Pine-compatible notation is also supported, i.e. {[username@]imapserver[:port][/ssl]}path/to/folder
- %\b%(\b(f\bfm\bmt\bt)\b)
- the local date and time when the message was received. ``fmt''
- is expanded by the library function ``strftime''; a leading bang
- disables locales
+ Note that not all servers use / as the hierarchy separator. Mutt-ng should correctly notice which separator is being used by the server and convert paths accordingly.
- %\b%<\b<f\bfm\bmt\bt>\b>
- the current local time. ``fmt'' is expanded by the library
- function ``strftime''; a leading bang disables locales.
+ 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 imap-list-subscribed variable.
- %\b%>\b>X\bX
- right justify the rest of the string and pad with character "X"
+ Polling for new mail on an IMAP server can cause noticeable delays. So, you'll want to carefully tune the imap-mail-check and timeout variables.
- %\b%|\b|X\bX
- pad to the end of the line with character "X"
+ 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.
- See also: ````$to_chars''''.
+14.1. The Folder Browser
- 6\b6.\b.3\b3.\b.9\b93\b3.\b. i\bin\bne\bew\bws\bs
+ 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:
+ * Instead 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.
+ * For the case where an entry can contain both messages and subfolders, the selection key (bound to enter by default) will choose to descend into the subfolder view. If you wish to view the messages in that folder, you must use view-file instead (bound to space by default).
+ * You can create, delete and rename mailboxes with the create-mailbox, delete-mailbox, and rename-mailbox commands (default bindings: C, d and r, respectively). You may also subscribe and unsubscribe to mailboxes (normally these are bound to s and u, respectively).
- Type: path
- Default: ""
+14.2. Authentication
- If set, specifies the program and arguments used to deliver news
- posted by Mutt. Otherwise, mutt posts article using current
- connection to news server. The following printf-style sequence is
- understood:
+ Mutt-ng supports four authentication methods with IMAP servers: SASL, GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add 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".
- %s newsserver name
+ 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 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.
- Example: set inews="/usr/local/bin/inews -hS"
+ Mutt-ng will try whichever methods are compiled in and available on the server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
- 6\b6.\b.3\b3.\b.9\b94\b4.\b. i\bis\bsp\bpe\bel\bll\bl
+ There are a few variables which control authentication:
+ * imap-user - controls the username under which you request authentication on the IMAP server, for all authenticators. This is overridden by an explicit username in the mailbox path (i.e. by using a mailbox name of the form {user@host}).
+ * imap-pass - a password which you may preset, used by all authentication methods where 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 listed above).
- Type: path
- Default: "/usr/bin/ispell"
+15. NNTP Support (OPTIONAL)
- How to invoke ispell (GNU's spell-checking software).
+ If compiled with ``--enable-nntp'' option, Mutt-ng can read news from a newsserver via NNTP. You can open a newsgroup with the ``change-newsgroup'' function from the index/pager which is by default bound to i.
- 6\b6.\b.3\b3.\b.9\b95\b5.\b. k\bke\bee\bep\bp_\b_f\bfl\bla\bag\bgg\bge\bed\bd
+ The Default newsserver can be obtained from the $NNTPSERVER environment variable. Like other news readers, info about subscribed newsgroups is saved in a file as specified by the nntp-newsrc 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.
- Type: boolean
- Default: no
+15.1. Again: Scoring
- If set, read messages marked as flagged will not be moved from your
- spool mailbox to your ````$mbox'''' mailbox, or as a result of a
- ````mbox-hook'''' command.
+ Especially for Usenet, people often ask for advanced filtering and scoring functionality. Of course, mutt-ng has scoring and allows a killfile, too. How to use a killfile has been discussed in score-command.
- 6\b6.\b.3\b3.\b.9\b96\b6.\b. l\blo\boc\bca\bal\ble\be
+ What has not been discusses in detail is mutt-ng's built-in realname filter. For may newsreaders including those for ``advanced users'' like slrn or tin, there are frequent request for such functionality. The solutions offered often are complicated regular expressions.
- Type: string
- Default: "C"
+ In mutt-ng this is as easy as
+score ~* =42
- The locale used by _\bs_\bt_\br_\bf_\bt_\bi_\bm_\be_\b(_\b3_\b) to format dates. Legal values are the
- strings your system accepts for the locale variable _\bL_\bC_\b__\bT_\bI_\bM_\bE.
+ This tells mutt-ng to apply a score of 42 to all messages whose sender specified a valid realname and a valid email address. Using
+score !~* =42
- 6\b6.\b.3\b3.\b.9\b97\b7.\b. m\bma\bai\bil\bl_\b_c\bch\bhe\bec\bck\bk
+ on the contrary applies a score of 42 to all messages not matching those criteria which are very strict:
+ * Email addresses must be valid according to RFC 2822, see <ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt>
+ * the name must consist of at least 2 fields whereby a field must not end in a dot. This means that ``Joe User'' and ``Joe A. User'' are valid while ``J. User'' and ``J. A. User'' aren't.
+ * it's assumed that users are interested in reading their own mail and mail from people who they have defined an alias for so that those 2 groups of messages are excluded from the strict rules.
- Type: number
- Default: 5
+16. SMTP Support (OPTIONAL)
- This variable configures how often (in seconds) mutt should look for
- new mail.
+ Mutt-ng can be built using a library called ``libESMTP'' which provides SMTP 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 dsn section) as well as handling the 8BITMIME flag controlled via use-8bitmime.
- 6\b6.\b.3\b3.\b.9\b98\b8.\b. m\bma\bai\bil\blc\bca\bap\bp_\b_p\bpa\bat\bth\bh
+ To enable sending mail directly via SMTP without an MTA such as Postfix or SSMTP and the like, simply set the smtp-host variable pointing to your SMTP server.
- Type: string
- Default: ""
+ Authentication mechanisms are available via the smtp-user and smtp-pass variables.
- This variable specifies which files to consult when attempting to
- display MIME bodies not directly supported by Mutt.
+ 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 smtp-use-tls 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.
- 6\b6.\b.3\b3.\b.9\b99\b9.\b. m\bma\bai\bil\blc\bca\bap\bp_\b_s\bsa\ban\bni\bit\bti\biz\bze\be
+ Some mail providers require user's to set a particular envelope sender, i.e. 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 smtp-envelope may be used to set the envelope different from the From: header.
- Type: boolean
- Default: yes
+17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)
- If set, mutt will restrict possible characters in mailcap % expandos
- to a well-defined set of safe characters. This is the safe setting,
- but we are not sure it doesn't break some more advanced MIME stuff.
+ If you happen to have accounts on multiple IMAP and/or POP 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 (including inside the folder browser), not just when you open the mailbox.
- D\bDO\bON\bN'\b'T\bT C\bCH\bHA\bAN\bNG\bGE\bE T\bTH\bHI\bIS\bS S\bSE\bET\bTT\bTI\bIN\bNG\bG U\bUN\bNL\bLE\bES\bSS\bS Y\bYO\bOU\bU A\bAR\bRE\bE R\bRE\bEA\bAL\bLL\bLY\bY S\bSU\bUR\bRE\bE W\bWH\bHA\bAT\bT Y\bYO\bOU\bU A\bAR\bRE\bE
- D\bDO\bOI\bIN\bNG\bG!\b!
+ Some examples:
+account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
+account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
+account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
- 6\b6.\b.3\b3.\b.1\b10\b00\b0.\b. m\bma\bai\bil\bld\bdi\bir\br_\b_t\btr\bra\bas\bsh\bh
+18. Start a WWW Browser on URLs (EXTERNAL)
- Type: boolean
- Default: no
+ If a message contains URLs (unified resource locator = address in the WWW space like http://www.mutt.org/), 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:
+macro index \cb |urlview\n
+macro pager \cb |urlview\n
- If set, messages marked as deleted will be saved with the maildir
- (T)rashed flag instead of unlinked. N\bNO\bOT\bTE\bE:\b: this only applies to
- maildir-style mailboxes. Setting it will have no effect on other
- mailbox types.
+19. Compressed folders Support (OPTIONAL)
- 6\b6.\b.3\b3.\b.1\b10\b01\b1.\b. m\bma\bar\brk\bk_\b_o\bol\bld\bd
+ If Mutt-ng was compiled with compressed folders support (by running the configure script with the --enable-compressed flag), Mutt can open folders stored in an arbitrary format, provided that the user has a script to convert from/to this format to one of the accepted.
- Type: boolean
- Default: yes
+ The most common use is to open compressed archived folders e.g. with gzip.
- Controls whether or not mutt marks _\bn_\be_\bw u\bun\bnr\bre\bea\bad\bd messages as _\bo_\bl_\bd if you
- exit a mailbox without reading them. With this option set, the next
- time you start mutt, the messages will show up with an "O" next to
- them in the index menu, indicating that they are old.
+ In addition, the user can provide a script that gets a folder in an accepted format and appends its context to the folder in the user-defined format, which may be faster than converting the entire folder to the accepted format, appending to it and converting back to the user-defined format.
- 6\b6.\b.3\b3.\b.1\b10\b02\b2.\b. m\bma\bar\brk\bke\ber\brs\bs
+ There are three hooks defined (open-hook, close-hook and append-hook) which define commands to uncompress and compress a folder and to append messages to an existing compressed folder respectively.
- Type: boolean
- Default: yes
+ For example:
+open-hook \\.gz$ "gzip -cd %f > %t"
+close-hook \\.gz$ "gzip -c %t > %f"
+append-hook \\.gz$ "gzip -c %t >> %f"
- Controls the display of wrapped lines in the internal pager. If set, a
- ``+'' marker is displayed at the beginning of wrapped lines. Also see
- the ````$smart_wrap'''' variable.
+ You do not have to specify all of the commands. If you omit append-hook, the folder will be open and closed again each time you will add to it. If you omit close-hook (or give empty command) , the folder will be open in the mode. If you specify append-hook though you'll be able to append to the folder.
- 6\b6.\b.3\b3.\b.1\b10\b03\b3.\b. m\bma\bas\bsk\bk
+ 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 surprising if your compressing script produces empty files. In this situation, unset save-empty, so that the compressed file will be removed if you delete all of the messages.
- Type: regular expression
- Default: "!^\.[^.]"
+19.1. Open a compressed mailbox for reading
- A regular expression used in the file browser, optionally preceded by
- the _\bn_\bo_\bt operator ``!''. Only files whose names match this mask will
- be shown. The match is always case-sensitive.
+ Usage: open-hook regexp "command"
- 6\b6.\b.3\b3.\b.1\b10\b04\b4.\b. m\bmb\bbo\box\bx
+ The command is the command that can be used for opening the folders whose names match regexp.
- Type: path
- Default: "~/mbox"
+ The command string is the printf-like format string, and it should accept two parameters: %f, which is replaced with the (compressed) folder name, and %t which is replaced with the name of the temporary folder to which to write.
- This specifies the folder into which read mail in your
- ````$spoolfile'''' folder will be appended.
+ %f and %t can be repeated any number of times in the command string, and all of the entries are replaced with the appropriate folder name. In addition, %% is replaced by %, as in printf, and any other %anything is left as is.
- 6\b6.\b.3\b3.\b.1\b10\b05\b5.\b. m\bmb\bbo\box\bx_\b_t\bty\byp\bpe\be
+ The command should not remove the original compressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong.
- Type: folder magic
- Default: mbox
+ Example:
+open-hook \\.gz$ "gzip -cd %f > %t"
- The default mailbox type used when creating new folders. May be any of
- mbox, MMDF, MH and Maildir.
+ If the command is empty, this operation is disabled for this file type.
- 6\b6.\b.3\b3.\b.1\b10\b06\b6.\b. m\bme\bet\bto\boo\bo
+19.2. Write a compressed mailbox
- Type: boolean
- Default: no
+ Usage: close-hook regexp "command"
- If unset, Mutt will remove your address (see the ``alternates''
- command) from the list of recipients when replying to a message.
+ This is used to close the folder that was open with the open-hook command after some changes were made to it.
- 6\b6.\b.3\b3.\b.1\b10\b07\b7.\b. m\bme\ben\bnu\bu_\b_s\bsc\bcr\bro\bol\bll\bl
+ The command string is the command that can be used for closing the folders whose names match regexp. It has the same format as in the open-hook command. Temporary folder in this case is the folder previously produced by the <open-hook command.
- Type: boolean
- Default: no
+ The command should not remove the decompressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong.
- When _\bs_\be_\bt, menus will be scrolled up or down one line when you attempt
- to move across a screen boundary. If _\bu_\bn_\bs_\be_\bt, the screen is cleared and
- the next or previous page of the menu is displayed (useful for slow
- links to avoid many redraws).
+ Example:
+close-hook \\.gz$ "gzip -c %t > %f"
- 6\b6.\b.3\b3.\b.1\b10\b08\b8.\b. m\bme\bet\bta\ba_\b_k\bke\bey\by
+ If the command is empty, this operation is disabled for this file type, and the file can only be open in the readonly mode.
- Type: boolean
- Default: no
+ close-hook is not called when you exit from the folder if the folder was not changed.
- If set, forces Mutt to interpret keystrokes with the high bit (bit 8)
- set as if the user had pressed the ESC key and whatever key remains
- after having the high bit removed. For example, if the key pressed
- has an ASCII value of 0xf4, then this is treated as if the user had
- pressed ESC then ``x''. This is because the result of removing the
- high bit from ``0xf4'' is ``0x74'', which is the ASCII character
- ``x''.
+19.3. Append a message to a compressed mailbox
- 6\b6.\b.3\b3.\b.1\b10\b09\b9.\b. m\bmh\bh_\b_p\bpu\bur\brg\bge\be
+ Usage: append-hook regexp "command"
- Type: boolean
- Default: no
+ This command is used for saving to an existing compressed folder. The command is the command that can be used for appending to the folders whose names match regexp. It has the same format as in the open-hook command. The temporary folder in this case contains the messages that are being appended.
- When unset, mutt will mimic mh's behaviour and rename deleted messages
- to _\b,_\b<_\bo_\bl_\bd _\bf_\bi_\bl_\be _\bn_\ba_\bm_\be_\b> in mh folders instead of really deleting them. If
- the variable is set, the message files will simply be deleted.
+ The command should not remove the decompressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong.
- 6\b6.\b.3\b3.\b.1\b11\b10\b0.\b. m\bmh\bh_\b_s\bse\beq\bq_\b_f\bfl\bla\bag\bgg\bge\bed\bd
+ Example:
+append-hook \\.gz$ "gzip -c %t >> %f"
- Type: string
- Default: "flagged"
+ When append-hook 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 (mbox-type) type is always supposed (i.e. this is the format used for the temporary folder).
- The name of the MH sequence used for flagged messages.
+ If the file does not exist when you save to it, close-hook is called, and not append-hook. append-hook is only for appending to existing folders.
- 6\b6.\b.3\b3.\b.1\b11\b11\b1.\b. m\bmh\bh_\b_s\bse\beq\bq_\b_r\bre\bep\bpl\bli\bie\bed\bd
+ If the command is empty, this operation is disabled for this file type. In this case, the folder will be open and closed again (using open-hook and close-hookrespectively) each time you will add to it.
- Type: string
- Default: "replied"
+19.4. Encrypted folders
- The name of the MH sequence used to tag replied messages.
+ The compressed folders support can also be used to handle encrypted folders. If you want to encrypt a folder with PGP, you may want to use the following hooks:
+open-hook \\.pgp$ "pgp -f < %f > %t"
+close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
- 6\b6.\b.3\b3.\b.1\b11\b12\b2.\b. m\bmh\bh_\b_s\bse\beq\bq_\b_u\bun\bns\bse\bee\ben\bn
+ Please note, that PGP does not support appending to an encrypted folder, so there is no append-hook defined.
- Type: string
- Default: "unseen"
+ Note: the folder is temporary stored decrypted in the /tmp directory, where it can be read by your system administrator. So think about the security aspects of this.
- The name of the MH sequence used for unseen messages.
+Chapter 5. Mutt-ng's MIME Support
- 6\b6.\b.3\b3.\b.1\b11\b13\b3.\b. m\bmi\bim\bme\be_\b_f\bfo\bor\brw\bwa\bar\brd\bd
+ Table of Contents
- Type: quadoption
- Default: no
+ 1. Using MIME in Mutt
- When set, the message you are forwarding will be attached as a
- separate MIME part instead of included in the main body of the
- message. This is useful for forwarding MIME messages so the receiver
- can properly view the message as it was delivered to you. If you like
- to switch between MIME and not MIME from mail to mail, set this
- variable to ask-no or ask-yes.
+ 1.1. Viewing MIME messages in the pager
+ 1.2. The Attachment Menu
+ 1.3. The Compose Menu
- Also see ````$forward_decode'''' and ````$mime_forward_decode''''.
+ 2. MIME Type configuration with mime.types
+ 3. MIME Viewer configuration with mailcap
- 6\b6.\b.3\b3.\b.1\b11\b14\b4.\b. m\bmi\bim\bme\be_\b_f\bfo\bor\brw\bwa\bar\brd\bd_\b_d\bde\bec\bco\bod\bde\be
+ 3.1. The Basics of the mailcap file
+ 3.2. Secure use of mailcap
+ 3.3. Advanced mailcap Usage
+ 3.4. Example mailcap files
- Type: boolean
- Default: no
+ 4. MIME Autoview
+ 5. MIME Multipart/Alternative
+ 6. MIME Lookup
- Controls the decoding of complex MIME messages into text/plain when
- forwarding a message while ````$mime_forward'''' is _\bs_\be_\bt. Otherwise
- ````$forward_decode'''' is used instead.
+ Quite a bit of effort has been made to make Mutt-ng the premier text-mode 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-ng for MIME, there are two extra types of configuration files which Mutt-ng uses. One is the 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.
- 6\b6.\b.3\b3.\b.1\b11\b15\b5.\b. m\bmi\bim\bme\be_\b_f\bfo\bor\brw\bwa\bar\brd\bd_\b_r\bre\bes\bst\bt
+1. Using MIME in Mutt
- Type: quadoption
- Default: yes
+ There are three areas/menus in Mutt-ng which deal with MIME, they are the pager (while viewing a message), the attachment menu and the compose menu.
- When forwarding multiple attachments of a MIME message from the
- recvattach menu, attachments which cannot be decoded in a reasonable
- manner will be attached to the newly composed message if this option
- is set.
+1.1. Viewing MIME messages in the pager
- 6\b6.\b.3\b3.\b.1\b11\b16\b6.\b. m\bmi\bim\bme\be_\b_s\bsu\bub\bbj\bje\bec\bct\bt
+ When you select a message from the index and view it in the pager, Mutt decodes the message to a text representation. Mutt-ng internally supports a number of MIME types, including text/plain, text/enriched, message/rfc822, and message/news. In addition, the export controlled version of Mutt-ng recognizes a variety of PGP MIME types, including PGP/MIME and application/pgp.
- Type: boolean
- Default: yes
+ Mutt-ng 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 --]
- If _\bu_\bn_\bs_\be_\bt, 8-bit ``subject:'' line in article header will not be
- encoded according to RFC2047 to base64. This is useful when message
- is Usenet article, because MIME for news is nonstandard feature.
+ Where the Description is the description or filename given for the attachment, and the Encoding is one of 7bit/8bit/quoted-printable/base64/binary.
- 6\b6.\b.3\b3.\b.1\b11\b17\b7.\b. m\bmi\bix\bx_\b_e\ben\bnt\btr\bry\by_\b_f\bfo\bor\brm\bma\bat\bt
+ 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) --]
- Type: string
- Default: "%4n %c %-16s %a"
+1.2. The Attachment Menu
- This variable describes the format of a remailer line on the mixmaster
- chain selection screen. The following printf-like sequences are
- supported:
+ 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 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.
- %\b%n\bn The running number on the menu.
+ Finally, you can apply the usual message-related functions (like resend-message, and the reply and forward functions) to attachments of type message/rfc822.
- %\b%c\bc Remailer capabilities.
+ See the help on the attachment menu for more information.
- %\b%s\bs The remailer's short name.
+1.3. The Compose Menu
- %\b%a\ba The remailer's e-mail address.
+ The compose menu is the menu you see before you send a message. It allows you to edit the recipient list, the subject, and other aspects of your message. It also contains a list of the attachments of your message, including the main body. From this menu, you can print, copy, filter, pipe, edit, compose, review, and rename an attachment or a list of tagged attachments. You can also modifying the attachment information, notably the type, encoding and description.
- 6\b6.\b.3\b3.\b.1\b11\b18\b8.\b. m\bmi\bix\bxm\bma\bas\bst\bte\ber\br
+ 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>
- Type: path
- Default: "mixmaster"
+ The '-' denotes that Mutt-ng 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 (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 (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). The final field is the description of the attachment, and can be changed with the edit-description command (default: d).
- This variable contains the path to the Mixmaster binary on your
- system. It is used with various sets of parameters to gather the list
- of known remailers, and to finally send a message through the
- mixmaster chain.
+2. MIME Type configuration with mime.types
- 6\b6.\b.3\b3.\b.1\b11\b19\b9.\b. m\bmo\bov\bve\be
+ When you add an attachment to your mail message, Mutt-ng 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 /etc/mime.types
- Type: quadoption
- Default: ask-no
+ The mime.types file consist of lines containing a MIME type and a space separated list of extensions. For example:
+application/postscript ps eps
+application/pgp pgp
+audio/x-aiff aif aifc aiff
- Controls whether you will be asked to confirm moving read messages
- from your spool mailbox to your ````$mbox'''' mailbox, or as a result
- of a ````mbox-hook'''' command.
+ A sample mime.types file comes with the Mutt-ng distribution, and should contain most of the MIME types you are likely to use.
- 6\b6.\b.3\b3.\b.1\b12\b20\b0.\b. m\bme\bes\bss\bsa\bag\bge\be_\b_f\bfo\bor\brm\bma\bat\bt
+ If Mutt-ng can not determine the mime type by the extension of the file you attach, it will look at the file. If the file is free of binary information, Mutt-ng will assume that the file is plain text, and mark it as text/plain. If the file contains binary information, then Mutt-ng will mark it as application/octet-stream. You can change the MIME type that Mutt-ng 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-ng recognises all of these if the appropriate entry is found in the mime.types file. It also recognises other major mime types, such as the chemical type that is widely used in the molecular modelling community to pass molecular data in various forms to various molecular viewers. Non-recognised mime types should only
+ be used if the recipient of the message is likely to be expecting such attachments.
- Type: string
- Default: "%s"
+3. MIME Viewer configuration with mailcap
- This is the string displayed in the ``attachment'' menu for
- attachments of type message/rfc822. For a full listing of defined
- printf()-like sequences see the section on ````$index_format''''.
+ Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix 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.
- 6\b6.\b.3\b3.\b.1\b12\b21\b1.\b. n\bna\bar\brr\bro\bow\bw_\b_t\btr\bre\bee\be
+ 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 handler. The default search string for these files is a colon delimited list set to
+${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
- Type: boolean
- Default: no
+ where $HOME is your home directory.
- This variable, when set, makes the thread tree narrower, allowing
- deeper threads to fit on the screen.
+ In particular, the metamail distribution will install a mailcap file, usually as /usr/local/etc/mailcap, which contains some baseline entries.
- 6\b6.\b.3\b3.\b.1\b12\b22\b2.\b. n\bne\bew\bws\bs_\b_c\bca\bac\bch\bhe\be_\b_d\bdi\bir\br
+3.1. The Basics of the mailcap file
- Type: path
- Default: "~/.mutt"
+ A mailcap file consists of a series of lines which are comments, blank, or definitions.
- This variable pointing to directory where Mutt will save cached news
- articles headers in. If _\bu_\bn_\bs_\be_\bt, headers will not be saved at all and
- will be reloaded each time when you enter to newsgroup.
+ A comment line consists of a # character followed by anything you want.
- 6\b6.\b.3\b3.\b.1\b12\b23\b3.\b. n\bne\bew\bws\bs_\b_s\bse\ber\brv\bve\ber\br
+ A blank line is blank.
- Type: string
- Default: ""
+ A definition line consists of a content type, a view command, and any number of optional fields. Each field of a definition line is divided by a semicolon ';' character.
- This variable specifies domain name or address of NNTP server. It
- defaults to the newsserver specified in the environment variable
- $NNTPSERVER or contained in the file /etc/nntpserver. You can also
- specify username and an alternative port for each newsserver, ie:
+ The content type is specified in the MIME standard type/subtype method. For example, text/plain, text/html, image/gif, etc. In addition, the mailcap format includes two formats for wildcards, one using the special '*' subtype, the other is the implicit wild, where you only include the major type. For example, image/*, or video, will match all image types and video types, respectively.
- [nntp[s]://][username[:password]@]newsserver[:port]
+ The view command is a Unix command for viewing the type specified. There are two different types of commands supported. The default is to send the body of the MIME message to the command on stdin. You can change this behavior by using %s as a parameter to your view command. This will cause Mutt-ng to save the body of the MIME message to a temporary file, and then call the view command with the %s replaced by the name of the temporary file. In both cases, Mutt-ng will turn over the terminal to the view program until the program quits, at which time Mutt will remove the temporary file if it exists.
- 6\b6.\b.3\b3.\b.1\b12\b24\b4.\b. n\bne\bew\bws\bsr\brc\bc
+ So, in the simplest form, you can send a text/plain message to the external pager more on stdin:
+text/plain; more
- Type: path
- Default: "~/.newsrc"
+ Or, you could send the message as a file:
+text/plain; more %s
- The file, containing info about subscribed newsgroups - names and
- indexes of read articles. The following printf-style sequence is
- understood:
+ Perhaps you would like to use lynx to interactively view a text/html message:
+text/html; lynx %s
- %s newsserver name
+ 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 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.
- 6\b6.\b.3\b3.\b.1\b12\b25\b5.\b. n\bnn\bnt\btp\bp_\b_c\bco\bon\bnt\bte\bex\bxt\bt
+ 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
- Type: number
- Default: 1000
+ 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 variable defines number of articles which will be in index when
- newsgroup entered. If active newsgroup have more articles than this
- number, oldest articles will be ignored. Also controls how many
- articles headers will be saved in cache when you quit newsgroup.
+ This is the simplest form of a mailcap file.
- 6\b6.\b.3\b3.\b.1\b12\b26\b6.\b. n\bnn\bnt\btp\bp_\b_l\blo\boa\bad\bd_\b_d\bde\bes\bsc\bcr\bri\bip\bpt\bti\bio\bon\bn
+3.2. Secure use of mailcap
- Type: boolean
- Default: yes
+ 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 mailcap-sanitize variable.
- This variable controls whether or not descriptions for each newsgroup
- must be loaded when newsgroup is added to list (first time list
- loading or new newsgroup adding).
+ 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:
- 6\b6.\b.3\b3.\b.1\b12\b27\b7.\b. n\bnn\bnt\btp\bp_\b_u\bus\bse\ber\br
+ Keep the %-expandos away from shell quoting. Don't quote them with single or double quotes. Mutt-ng does this for you, the right way, as should any other program which interprets mailcap. Don't put them into backtick expansions. Be highly careful with eval statements, and avoid them if possible at all. Trying to fix broken behaviour with quotes introduces new leaks - there is no alternative to correct quoting in the first place.
- Type: string
- Default: ""
+ If you have to use the %-expandos' values in context where you need quoting or backtick expansions, put that value into a shell variable and reference the shell variable where necessary, as in the following example (using $charset inside the backtick expansion is safe, 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
- Your login name on the NNTP server. If _\bu_\bn_\bs_\be_\bt and NNTP server requires
- authentification, Mutt will prompt you for your account name when you
- connect to newsserver.
+3.3. Advanced mailcap Usage
- 6\b6.\b.3\b3.\b.1\b12\b28\b8.\b. n\bnn\bnt\btp\bp_\b_p\bpa\bas\bss\bs
+3.3.1. Optional Fields
- Type: string
- Default: ""
+ 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 recognizes the following optional fields:
- Your password for NNTP account.
+ copiousoutput
+ This flag tells Mutt-ng that the command passes possibly large 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 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:
- 6\b6.\b.3\b3.\b.1\b12\b29\b9.\b. n\bnn\bnt\btp\bp_\b_p\bpo\bol\bll\bl
+text/html; lynx -dump %s ; copiousoutput
- Type: number
- Default: 60
+ This will cause lynx to format the text/html output as text/plain and Mutt-ng will use your standard pager to display the results.
- The time in seconds until any operations on newsgroup except post new
- article will cause recheck for new news. If set to 0, Mutt will
- recheck newsgroup on each operation in index (stepping, read article,
- etc.).
+ needsterminal
+ Mutt-ng 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-ng will use wait-key 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.
- 6\b6.\b.3\b3.\b.1\b13\b30\b0.\b. n\bnn\bnt\btp\bp_\b_r\bre\bec\bco\bon\bnn\bne\bec\bct\bt
+ compose=<command>
+ This flag specifies the command to use to create a new attachment of a specific MIME type. Mutt-ng supports this from the compose menu.
- Type: quadoption
- Default: ask-yes
+ composetyped=<command>
+ 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 used to specify parameters, filename, description, etc. for a new attachment. Mutt-ng supports this from the compose menu.
- Controls whether or not Mutt will try to reconnect to newsserver when
- connection lost.
+ print=<command>
+ This flag specifies the command to use to print a specific MIME type. Mutt-ng supports this from the attachment and compose menus.
- 6\b6.\b.3\b3.\b.1\b13\b31\b1.\b. p\bpa\bag\bge\ber\br
+ edit=<command>
+ This flag specifies the command to use to edit a specific MIME type. Mutt-ng supports this from the compose menu, and also uses it to compose new attachments. Mutt-ng will default to the defined editor for text attachments.
- Type: path
- Default: "builtin"
+ nametemplate=<template>
+ This field specifies the format for the file denoted by %s in the command fields. Certain programs will require a certain file extension, 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:
- This variable specifies which pager you would like to use to view
- messages. builtin means to use the builtin pager, otherwise this
- variable should specify the pathname of the external pager you would
- like to use.
+text/html; lynx %s; nametemplate=%s.html
- Using an external pager may have some disadvantages: Additional
- keystrokes are necessary because you can't call mutt functions
- directly from the pager, and screen resizes cause lines longer than
- the screen width to be badly formatted in the help menu.
+ test=<command>
+ This field specifies a command to run to test whether this mailcap 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-ng uses this entry. If the command returns non-zero, then the test failed, and Mutt-ng continues searching for the right entry. Note: the content-type must match before Mutt-ng performs the test. For example:
- 6\b6.\b.3\b3.\b.1\b13\b32\b2.\b. p\bpa\bag\bge\ber\br_\b_c\bco\bon\bnt\bte\bex\bxt\bt
+text/html; netscape -remote 'openURL(%s)' ; test=RunningX
+text/html; lynx %s
- Type: number
- Default: 0
+ In this example, Mutt-ng 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-ng will call netscape to display the text/html object. If RunningX doesn't return 0, then Mutt-ng will go on to the next entry and use lynx to display the text/html object.
- This variable controls the number of lines of context that are given
- when displaying the next or previous page in the internal pager. By
- default, Mutt will display the line after the last one on the screen
- at the top of the next page (0 lines of context).
+3.3.2. Search Order
- 6\b6.\b.3\b3.\b.1\b13\b33\b3.\b. p\bpa\bag\bge\ber\br_\b_f\bfo\bor\brm\bma\bat\bt
+ When searching for an entry in the mailcap file, Mutt-ng will search for 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-ng will search for an entry with the print command:
+image/*; xv %s
+image/gif; ; print= anytopnm %s | pnmtops | lpr; \
+ nametemplate=%s.gif
- Type: string
- Default: "-%Z- %C/%m: %-20.20n %s"
+ Mutt-ng will skip the image/* entry and use the image/gif entry with the print command.
- This variable controls the format of the one-line message ``status''
- displayed before each message in either the internal or an external
- pager. The valid sequences are listed in the ````$index_format''''
- section.
+ 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; lynx %s; nametemplate=%s.html
+text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
- 6\b6.\b.3\b3.\b.1\b13\b34\b4.\b. p\bpa\bag\bge\ber\br_\b_i\bin\bnd\bde\bex\bx_\b_l\bli\bin\bne\bes\bs
+ For auto-view, Mutt-ng 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-ng will use the second entry for interactive viewing.
- Type: number
- Default: 0
+3.3.3. Command Expansion
- Determines the number of lines of a mini-index which is shown when in
- the pager. The current message, unless near the top or bottom of the
- folder, will be roughly one third of the way down this mini-index,
- giving the reader the context of a few messages before and after the
- message. This is useful, for example, to determine how many messages
- remain to be read in the current thread. One of the lines is reserved
- for the status bar from the index, so a _\bp_\ba_\bg_\be_\br_\b__\bi_\bn_\bd_\be_\bx_\b__\bl_\bi_\bn_\be_\bs of 6 will
- only show 5 lines of the actual index. A value of 0 results in no
- index being shown. If the number of messages in the current folder is
- less than _\bp_\ba_\bg_\be_\br_\b__\bi_\bn_\bd_\be_\bx_\b__\bl_\bi_\bn_\be_\bs, then the index will only use as many
- lines as it needs.
+ The various commands defined in the mailcap files are passed to the /bin/sh shell using the system() function. Before the command is passed to /bin/sh -c, it is parsed to expand various special parameters with information from Mutt-ng. The keywords Mutt-ng expands are:
- 6\b6.\b.3\b3.\b.1\b13\b35\b5.\b. p\bpa\bag\bge\ber\br_\b_s\bst\bto\bop\bp
+ %s
+ As seen in the basic mailcap section, this variable is expanded to a filename specified by the calling program. This file contains the body of the message to view/print/edit or where the composing program should place the results of composition. In addition, the use of this keyword causes Mutt-ng to not pass the body of the message to the view/print/edit program on stdin.
- Type: boolean
- Default: no
+ %t
+ Mutt-ng will expand %t to the text representation of the content type of the message in the same form as the first parameter of the mailcap definition line, ie text/html or image/gif.
- When set, the internal-pager will n\bno\bot\bt move to the next message when
- you are at the end of a message and invoke the _\bn_\be_\bx_\bt_\b-_\bp_\ba_\bg_\be function.
+ %{<parameter>}
+ Mutt-ng 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:
- 6\b6.\b.3\b3.\b.1\b13\b36\b6.\b. c\bcr\bry\byp\bpt\bt_\b_a\bau\but\bto\bos\bsi\big\bgn\bn
+Content-Type: text/plain; charset=iso-8859-1
- Type: boolean
- Default: no
+ then Mutt-ng 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.
- Setting this variable will cause Mutt to always attempt to
- cryptographically sign outgoing messages. This can be overridden by
- use of the _\bp_\bg_\bp_\b-_\bm_\be_\bn_\bu, when signing is not required or encryption is
- requested as well. If ````$smime_is_default'''' is set, then OpenSSL
- is used instead to create S/MIME messages and settings can be
- overridden by use of the _\bs_\bm_\bi_\bm_\be_\b-_\bm_\be_\bn_\bu. (Crypto only)
+ \%
+ This will be replaced by a %
- 6\b6.\b.3\b3.\b.1\b13\b37\b7.\b. c\bcr\bry\byp\bpt\bt_\b_a\bau\but\bto\boe\ben\bnc\bcr\bry\byp\bpt\bt
+ Mutt-ng 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-ng.
- Type: boolean
- Default: no
+3.4. Example mailcap files
- Setting this variable will cause Mutt to always attempt to PGP encrypt
- outgoing messages. This is probably only useful in connection to the
- _\bs_\be_\bn_\bd_\b-_\bh_\bo_\bo_\bk command. It can be overridden by use of the _\bp_\bg_\bp_\b-_\bm_\be_\bn_\bu, when
- encryption is not required or signing is requested as well. IF
- ````$smime_is_default'''' is set, then OpenSSL is used instead to
- create S/MIME messages and settings can be overridden by use of the
- _\bs_\bm_\bi_\bm_\be_\b-_\bm_\be_\bn_\bu. (Crypto only)
- 6\b6.\b.3\b3.\b.1\b13\b38\b8.\b. p\bpg\bgp\bp_\b_i\big\bgn\bno\bor\bre\be_\b_s\bsu\bub\bbk\bke\bey\bys\bs
+ This mailcap file is fairly simple and standard:
+>
+# I'm always running X :)
+video/*; xanim %s > /dev/null
+image/*; xv %s > /dev/null
- Type: boolean
- Default: yes
+# I'm always running netscape (if my computer had more memory, maybe)
+text/html; netscape -remote 'openURL(%s)'
- Setting this variable will cause Mutt to ignore OpenPGP subkeys.
- Instead, the principal key will inherit the subkeys' capabilities.
- Unset this if you want to play interesting key selection games. (PGP
- only)
+ 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
- 6\b6.\b.3\b3.\b.1\b13\b39\b9.\b. c\bcr\bry\byp\bpt\bt_\b_r\bre\bep\bpl\bly\bye\ben\bnc\bcr\bry\byp\bpt\bt
+# Send html to a running netscape by remote
+text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
- Type: boolean
- Default: yes
+# If I'm not running netscape but I am running X, start netscape on the
+# object
+text/html; netscape %s; test=RunningX
- If set, automatically PGP or OpenSSL encrypt replies to messages which
- are encrypted. (Crypto only)
+# Else use lynx to view it as text
+text/html; lynx %s
- 6\b6.\b.3\b3.\b.1\b14\b40\b0.\b. c\bcr\bry\byp\bpt\bt_\b_r\bre\bep\bpl\bly\bys\bsi\big\bgn\bn
+# This version would convert the text/html to text/plain
+text/html; lynx -dump %s; copiousoutput
- Type: boolean
- Default: no
+# I use enscript to print text in two columns to a page
+text/*; more %s; print=enscript -2Gr %s
- If set, automatically PGP or OpenSSL sign replies to messages which
- are signed.
+# Netscape adds a flag to tell itself to view jpegs internally
+image/jpeg;xv %s; x-mozilla-flags=internal
- N\bNo\bot\bte\be:\b: this does not work on messages that are encrypted a\ban\bnd\bd signed!
- (Crypto only)
+# Use xv to view images if I'm running X
+# In addition, this uses the \ to extend the line and set my editor
+# for images
+image/*;xv %s; test=RunningX; \
+ edit=xpaint %s
- 6\b6.\b.3\b3.\b.1\b14\b41\b1.\b. c\bcr\bry\byp\bpt\bt_\b_r\bre\bep\bpl\bly\bys\bsi\big\bgn\bne\ben\bnc\bcr\bry\byp\bpt\bte\bed\bd
+# Convert images to text using the netpbm tools
+image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
+pbmtoascii -1x2 ) 2>&1 ; copiousoutput
- Type: boolean
- Default: no
+# Send excel spreadsheets to my NT box
+application/ms-excel; open.pl %s
- If set, automatically PGP or OpenSSL sign replies to messages which
- are encrypted. This makes sense in combination with
- ````$crypt_replyencrypt'''', because it allows you to sign all
- messages which are automatically encrypted. This works around the
- problem noted in ````$crypt_replysign'''', that mutt is not able to
- find out whether an encrypted message is also signed. (Crypto only)
+4. MIME Autoview
- 6\b6.\b.3\b3.\b.1\b14\b42\b2.\b. c\bcr\bry\byp\bpt\bt_\b_t\bti\bim\bme\bes\bst\bta\bam\bmp\bp
+ In addition to explicitly telling Mutt-ng to view an attachment with the MIME viewer defined in the mailcap file, Mutt-ng has support for automatically viewing MIME attachments while in the pager.
- Type: boolean
- Default: yes
+ 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.
- If set, mutt will include a time stamp in the lines surrounding PGP or
- S/MIME output, so spoofing such lines is more difficult. If you are
- using colors to mark these lines, and rely on these, you may unset
- this setting. (Crypto only)
+ You then use the auto_view muttrc command to list the content-types that you wish to view automatically.
- 6\b6.\b.3\b3.\b.1\b14\b43\b3.\b. p\bpg\bgp\bp_\b_u\bus\bse\be_\b_g\bgp\bpg\bg_\b_a\bag\bge\ben\bnt\bt
+ For instance, if you set auto_view to:
+auto_view text/html application/x-gunzip application/postscript image/gif application/x-tar-gz
- Type: boolean
- Default: no
+ Mutt-ng could use the following mailcap entries to automatically view attachments of these types.
+text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
+image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
+application/x-gunzip; gzcat; copiousoutput
+application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
+application/postscript; ps2ascii %s; copiousoutput
- If set, mutt will use a possibly-running gpg-agent process. (PGP
- only)
+ ``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.
- 6\b6.\b.3\b3.\b.1\b14\b44\b4.\b. c\bcr\bry\byp\bpt\bt_\b_v\bve\ber\bri\bif\bfy\by_\b_s\bsi\big\bg
+5. MIME Multipart/Alternative
- Type: quadoption
- Default: yes
+ Mutt-ng 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 MIME types in order, including support for implicit and explicit wildcards, for example:
+alternative_order text/enriched text/plain text application/postscript image/*
- If ``yes'', always attempt to verify PGP or S/MIME signatures. If
- ``ask'', ask whether or not to verify the signature. If ``no'', never
- attempt to verify cryptographic signatures. (Crypto only)
+ Next, mutt will check if any of the types have a defined auto-view, and use that. Failing that, Mutt-ng will look for any text type. As a last attempt, mutt will look for any type it knows how to handle.
- 6\b6.\b.3\b3.\b.1\b14\b45\b5.\b. s\bsm\bmi\bim\bme\be_\b_i\bis\bs_\b_d\bde\bef\bfa\bau\bul\blt\bt
+ To remove a MIME type from the alternative_order list, use the unalternative_order command.
- Type: boolean
- Default: no
+6. MIME Lookup
- The default behaviour of mutt is to use PGP on all auto-
- sign/encryption operations. To override and to use OpenSSL instead
- this must be set. However, this has no effect while replying, since
- mutt will automatically select the same application that was used to
- sign/encrypt the original message. (Note that this variable can be
- overridden by unsetting ``$crypt_autosmime''.) (S/MIME only)
+ Mutt-ng'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 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 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:
+mime_lookup application/octet-stream application/X-Lotus-Manuscript
- 6\b6.\b.3\b3.\b.1\b14\b46\b6.\b. s\bsm\bmi\bim\bme\be_\b_a\bas\bsk\bk_\b_c\bce\ber\brt\bt_\b_l\bla\bab\bbe\bel\bl
+ 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.
- Type: boolean
- Default: yes
+Chapter 6. Security Considerations
- This flag controls whether you want to be asked to enter a label for a
- certificate about to be added to the database or not. It is set by
- default. (S/MIME only)
+ Table of Contents
- 6\b6.\b.3\b3.\b.1\b14\b47\b7.\b. s\bsm\bmi\bim\bme\be_\b_d\bde\bec\bcr\bry\byp\bpt\bt_\b_u\bus\bse\be_\b_d\bde\bef\bfa\bau\bul\blt\bt_\b_k\bke\bey\by
+ 1. Passwords
+ 2. Temporary Files
+ 3. Information Leaks
- Type: boolean
- Default: yes
+ 3.1. Message-ID: headers
+ 3.2. mailto:-style links
- If set (default) this tells mutt to use the default key for
- decryption. Otherwise, if manage multiple certificate-key-pairs, mutt
- will try to use the mailbox-address to determine the key to use. It
- will ask you to supply a key, if it can't find one. (S/MIME only)
+ 4. External applications
- 6\b6.\b.3\b3.\b.1\b14\b48\b8.\b. p\bpg\bgp\bp_\b_e\ben\bnt\btr\bry\by_\b_f\bfo\bor\brm\bma\bat\bt
+ 4.1. mailcap
+ 4.2. Other
- Type: string
- Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
+ First of all, mutt-ng contains no security holes included by intention but may contain unknown security holes. As a consequence, please run mutt-ng only with as few permissions as possible.
- This variable allows you to customize the PGP key selection menu to
- your personal taste. This string is similar to ````$index_format'''',
- but has its own set of printf()-like sequences:
+ Please do not run mutt-ng as the super user.
- %\b%n\bn number
+ When configuring mutt-ng, there're some points to note about secure setups.
- %\b%k\bk key id
+ In practice, mutt-ng can be easily made as vulnerable as even the most insecure mail user agents (in their default configuration) just by changing mutt-ng's configuration files: it then can execute arbitrary programs and scripts attached to messages, send out private data on its own, etc. Although this is not believed to the common type of setup, please read this chapter carefully.
- %\b%u\bu user id
+1. Passwords
- %\b%a\ba algorithm
+ Although mutt-ng 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 replace the actual password with asterisks when reporting a bug or asking for help via, for example, a mailing list so that your mail including your password could be archived by internet search engines, etc. Please never store passwords on disk.
- %\b%l\bl key length
+2. Temporary Files
- %\b%f\bf flags
+ Mutt-ng uses many temporary files for viewing messages, verifying digital signatures, etc. The umask variable can be used to change the default permissions of these files. Please only change it if you really know what you are doing. Also, a different location for these files may be desired which can be changed via the tmpdir variable.
- %\b%c\bc capabilities
+3. Information Leaks
- %\b%t\bt trust/validity of the key-uid association
+3.1. Message-ID: headers
- %\b%[\b[<\b<s\bs>\b>]\b]
- date of the key where <s> is an strftime(3) expression
+ In the default configuration, mutt-ng will leak some information to the outside world when sending messages: the generation of Message-ID: headers includes a step counter which is increased (and rotated) with every message sent. If you'd like to hide this information probably telling others how many mail you sent in which time, you at least need to remove the %P expando from the default setting of the msgid-format variable. Please make sure that you really know how local parts of these Message-ID: headers are composed.
- (PGP only)
+3.2. mailto:-style links
- 6\b6.\b.3\b3.\b.1\b14\b49\b9.\b. p\bpg\bgp\bp_\b_g\bgo\boo\bod\bd_\b_s\bsi\big\bgn\bn
+ As mutt-ng be can be set up to be the mail client to handle mailto: style links in websites, there're security considerations, too. To keep the old behavior by default, mutt-ng will be strict in interpreting them which means that arbitrary header fields can be embedded in these links which could override existing header fields or attach arbitrary files. 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.
- Type: regular expression
- Default: ""
+ For example, following a link like
+mailto:joe@host?Attach=~/.gnupg/secring.gpg
- If you assign a text to this variable, then a PGP signature is only
- considered verified if the output from ``$pgp_verify_command''
- contains the text. Use this variable if the exit code from the command
- is 0 even for bad signatures. (PGP only)
+ will send out the user's private gnupg keyring to joe@host if the user doesn't follow the information on screen carefully enough.
- 6\b6.\b.3\b3.\b.1\b15\b50\b0.\b. p\bpg\bgp\bp_\b_c\bch\bhe\bec\bck\bk_\b_e\bex\bxi\bit\bt
+ When unsetting the strict-mailto variable, mutt-ng will
+ * be less strict when interpreting these links by prepending a X-Mailto- string to all header fields embedded in such a link and
+ * turn on the edit-headers variable by force to let the user see all the headers (because they still may leak information.)
- Type: boolean
- Default: yes
+4. External applications
- If set, mutt will check the exit code of the PGP subprocess when
- signing or encrypting. A non-zero exit code means that the subprocess
- failed. (PGP only)
+ Mutt-ng in many places has to rely on external applications or for convenience supports mechanisms involving external applications.
- 6\b6.\b.3\b3.\b.1\b15\b51\b1.\b. p\bpg\bgp\bp_\b_l\blo\bon\bng\bg_\b_i\bid\bds\bs
+4.1. mailcap
- Type: boolean
- Default: no
+ One of these is the mailcap mechanism as defined by RfC 1524. Mutt-ng can be set up to automatically execute any given utility as listed in one of the mailcap files (see the mailcap-path variable for details.)
- If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.
- (PGP only)
+ These utilities may have a variety of security vulnerabilities, including overwriting of arbitrary files, information leaks or other exploitable bugs. These vulnerabilities may go unnoticed by the user, especially when they are called automatically (and without interactive prompting) from the mailcap file(s). When using mutt-ng's autoview mechanism in combination with mailcap files, please be sure to...
+ * manually select trustworth applications with a reasonable calling sequence
+ * periodically check the contents of mailcap files, especially after software installations or upgrades
+ * keep the software packages referenced in the mailcap file up to date
+ * leave the mailcap-sanitize variable in its default state to restrict mailcap expandos to a safe set of characters
- 6\b6.\b.3\b3.\b.1\b15\b52\b2.\b. p\bpg\bgp\bp_\b_r\bre\bet\bta\bai\bin\bna\bab\bbl\ble\be_\b_s\bsi\big\bgs\bs
+4.2. Other
- Type: boolean
- Default: no
+ Besides the mailcap mechanism, mutt-ng uses a number of other external utilities for operation.
- If set, signed and encrypted messages will consist of nested
- multipart/signed and multipart/encrypted body parts.
+ The same security considerations apply for these as for tools involved via mailcap (for example, mutt-ng is vulnerable to Denial of Service Attacks with compressed folders support if the uncompressed mailbox is too large for the disk it is saved to.)
- This is useful for applications like encrypted and signed mailing
- lists, where the outer layer (multipart/encrypted) can be easily
- removed, while the inner multipart/signed part is retained. (PGP
- only)
+ As already noted, most of these problems are not built in but caused by wrong configuration, so please check your configuration.
- 6\b6.\b.3\b3.\b.1\b15\b53\b3.\b. p\bpg\bgp\bp_\b_s\bsh\bho\bow\bw_\b_u\bun\bnu\bus\bsa\bab\bbl\ble\be
+Chapter 7. Reference
- Type: boolean
- Default: yes
+ Table of Contents
- If set, mutt will display non-usable keys on the PGP key selection
- menu. This includes keys which have been revoked, have expired, or
- have been marked as ``disabled'' by the user. (PGP only)
+ 1. Command line options
+ 2. Patterns
+ 3. Configuration Commands
+ 4. Configuration variables
+ 5. Functions
- 6\b6.\b.3\b3.\b.1\b15\b54\b4.\b. p\bpg\bgp\bp_\b_s\bsi\big\bgn\bn_\b_a\bas\bs
+ 5.1. generic
+ 5.2. index
+ 5.3. pager
+ 5.4. alias
+ 5.5. query
+ 5.6. attach
+ 5.7. compose
+ 5.8. postpone
+ 5.9. browser
+ 5.10. pgp
+ 5.11. editor
- Type: string
- Default: ""
+1. Command line options
- If you have more than one key pair, this option allows you to specify
- which of your private keys to use. It is recommended that you use the
- keyid form to specify your key (e.g., ``0x00112233''). (PGP only)
+ Running mutt with no arguments will make Mutt-ng attempt to read your spool mailbox. However, it is possible to read other mailboxes and to send messages from the command line as well.
+-A expand an alias
+-a attach a file to a message
+-b specify a blind carbon-copy (BCC) address
+-c specify a carbon-copy (Cc) address
+-e specify a config command to be run after initialization files are read
+-f specify a mailbox to load
+-F specify an alternate file to read initialization commands
+-h print help on command line options
+-H specify a draft file from which to read a header and body
+-i specify a file to include in a message composition
+-m specify a default mailbox type
+-n do not read the system Muttngrc
+-p recall a postponed message
+-Q query a configuration variable
+-R open mailbox in read-only mode
+-s specify a subject (enclose in quotes if it contains spaces)
+-t dump the value of all variables to stdout
+-T dump the value of all changed variables to stdout
+-v show version number and compile-time definitions
+-x simulate the mailx(1) compose mode
+-y show a menu containing the files specified by the mailboxes command
+-z exit immediately if there are no messages in the mailbox
+-Z open the first folder with new message,exit immediately if none
+
+ To read messages in a mailbox
+
+ mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ]
+
+ To compose a new message
+
+ mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s subject ] address [ address ... ]
+
+ Mutt-ng 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''.
+
+2. Patterns
+
+~A all messages
+~b EXPR messages which contain EXPR in the message body
+~B EXPR messages which contain EXPR in the whole message
+~c USER messages carbon-copied to USER
+~C EXPR message is either to: or cc: EXPR
+~D deleted messages
+~d [MIN]-[MAX] messages with ``date-sent'' in a Date range
+~E expired messages
+~e EXPR message which contains EXPR in the ``Sender'' field
+~F flagged messages
+~f USER messages originating from USER
+~g cryptographically signed messages
+~G cryptographically encrypted messages
+~H EXPR messages with a spam attribute matching EXPR
+~h EXPR messages which contain EXPR in the message header
+~k message contains PGP key material
+~i ID message which match ID in the ``Message-ID'' field
+~L EXPR message is either originated or received by EXPR
+~l message is addressed to a known mailing list
+~m [MIN]-[MAX] message in the range MIN to MAX *)
+~M multipart messages
+~n [MIN]-[MAX] messages with a score in the range MIN to MAX *)
+~N new messages
+~O old messages
+~p message is addressed to you (consults alternates)
+~P message is from you (consults alternates)
+~Q messages which have been replied to
+~R read messages
+~r [MIN]-[MAX] messages with ``date-received'' in a Date range
+~S superseded messages
+~s SUBJECT messages having SUBJECT in the ``Subject'' field.
+~T tagged messages
+~t USER messages addressed to USER
+~U unread messages
+~v message is part of a collapsed thread.
+~V cryptographically verified messages
+~w EXPR messages which contain EXPR in the `Newsgroups' field
+ (if compiled with NNTP support)
+~x EXPR messages which contain EXPR in the `References' field
+~y EXPR messages 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)
+~* ``From'' contains realname and (syntactically) valid
+ address (excluded are addresses matching against
+ alternates or any alias)
+
+ Where EXPR, USER, ID, and SUBJECT are regexp. Special attention has to be made when using regular expressions inside of patterns. Specifically, Mutt-ng'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 (\\).
+
+ *) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too.
+
+3. Configuration Commands
+
+ The following are the commands understood by mutt.
+ * account-hook pattern command
+ * alias key address [ , address, ... ]
+ * alias [ * | key ... ]
+ * alternates regexp [ regexp ... ]
+ * alternates [ * | regexp ... ]
+ * alternative-order mimetype [ mimetype ... ]
+ * alternative-order mimetype [ mimetype ... ]
+ * append-hook regexp command
+ * auto-view mimetype [ mimetype ... ]
+ * auto-view mimetype [ mimetype ... ]
+ * bind map key function
+ * charset-hook alias charset
+ * close-hook regexp command
+ * color object foreground background [ regexp ]
+ * color index pattern [ pattern ... ]
+ * exec function [ function ... ]
+ * fcc-hook pattern mailbox
+ * fcc-save-hook pattern mailbox
+ * folder-hook pattern command
+ * hdr-order header [ header ... ]
+ * hdr-order header [ header ... ]
+ * charset-hook charset local-charset
+ * ignore pattern [ pattern ... ]
+ * ignore pattern [ pattern ... ]
+ * lists regexp [ regexp ... ]
+ * lists regexp [ regexp ... ]
+ * macro menu key sequence [ description ]
+ * mailboxes filename [ filename ... ]
+ * mbox-hook pattern mailbox
+ * message-hook pattern command
+ * mime-lookup mimetype [ mimetype ... ]
+ * mime-lookup mimetype [ mimetype ... ]
+ * color object attribute [ regexp ]
+ * color index pattern [ pattern ... ]
+ * my-hdr string
+ * my-hdr field [ field ... ]
+ * open-hook regexp command
+ * crypt-hook pattern key-id
+ * push string
+ * set variable [variable ... ]
+ * save-hook regexp filename
+ * score-command pattern value
+ * score-command pattern [ pattern ... ]
+ * send-hook regexp command
+ * reply-hook regexp command
+ * set [no|inv]variable[=value] [ variable ... ]
+ * set variable [variable ... ]
+ * source filename
+ * spam pattern format
+ * spam pattern
+ * lists regexp [ regexp ... ]
+ * lists regexp [ regexp ... ]
+ * set variable [variable ... ]
+ * unhook hook-type
+
+4. Configuration variables
+
+ The following list contains all variables which, in the process of providing more consistency, have been renamed and are partially even removed already. The left column contains the old synonym variables, the right column the full/new name:
+
+edit_hdrs edit_headers
+forw_decode forward_decode
+forw_format forward_format
+forw_quote forward_quote
+hdr_format index_format
+indent_str indent_string
+mime_fwd mime_forward
+msg_format message_format
+pgp_autosign crypt_autosign
+pgp_autoencrypt crypt_autoencrypt
+pgp_replyencrypt crypt_replyencrypt
+pgp_replysign crypt_replysign
+pgp_replysignencrypted crypt_replysignencrypted
+pgp_verify_sig crypt_verify_sig
+pgp_create_traditional pgp_autoinline
+pgp_auto_traditional pgp_replyinline
+forw_decrypt forward_decrypt
+smime_sign_as smime_default_key
+post_indent_str post_indent_string
+print_cmd print_command
+shorten_hierarchy sidebar_shorten_hierarchy
+ask_followup_to nntp_ask_followup_to
+ask_x_comment_to nntp_ask_x_comment_to
+catchup_newsgroup nntp_catchup
+followup_to_poster nntp_followup_to_poster
+group_index_format nntp_group_index_format
+inews nntp_inews
+mime_subject nntp_mime_subject
+news_cache_dir nntp_cache_dir
+news_server nntp_host
+newsrc nntp_newsrc
+nntp_poll nntp_mail_check
+pop_checkinterval pop_mail_check
+post_moderated nntp_post_moderated
+save_unsubscribed nntp_save_unsubscribed
+show_new_news nntp_show_new_news
+show_only_unread nntp_show_only_unread
+x_comment_to nntp_x_comment_to
+smtp_auth_username smtp_user
+smtp_auth_password smtp_pass
- 6\b6.\b.3\b3.\b.1\b15\b55\b5.\b. p\bpg\bgp\bp_\b_s\bst\btr\bri\bic\bct\bt_\b_e\ben\bnc\bc
+ The contrib subdirectory contains a script named update-config.pl which eases migration.
- Type: boolean
- Default: yes
+ A complete list of current variables follows.
- If set, Mutt will automatically encode PGP/MIME signed messages as
- _\bq_\bu_\bo_\bt_\be_\bd_\b-_\bp_\br_\bi_\bn_\bt_\ba_\bb_\bl_\be. Please note that unsetting this variable may lead
- to problems with non-verifyable PGP signatures, so only change this if
- you know what you are doing. (PGP only)
+1. abort_noattach
- 6\b6.\b.3\b3.\b.1\b15\b56\b6.\b. p\bpg\bgp\bp_\b_t\bti\bim\bme\beo\bou\but\bt
+ Type: quadoption
- Type: number
- Default: 300
+ Default: no
- The number of seconds after which a cached passphrase will expire if
- not used. (PGP only)
- 6\b6.\b.3\b3.\b.1\b15\b57\b7.\b. p\bpg\bgp\bp_\b_s\bso\bor\brt\bt_\b_k\bke\bey\bys\bs
+ This variable specifies whether to abort sending if no attachment was made but the content references them, i.e. the content matches the regular expression given in $attach_remind_regexp. If a match was found and this variable is set to yes, message sending will be aborted but the mail will be send nevertheless if set to no.
- Type: sort order
- Default: address
+ This variable and $attach_remind_regexp are intended to remind the user to attach files if the message's text references them.
- Specifies how the entries in the `pgp keys' menu are sorted. The
- following are legal values:
+ See also the $attach_remind_regexp variable.
- a\bad\bdd\bdr\bre\bes\bss\bs
- sort alphabetically by user id
+2. abort_nosubject
- k\bke\bey\byi\bid\bd
- sort alphabetically by key id
+ Type: quadoption
- d\bda\bat\bte\be
- sort by key creation date
+ Default: ask-yes
- t\btr\bru\bus\bst\bt
- sort by the trust of the key
+ If set to yes, when composing messages and no subject is given at the subject prompt, composition will be aborted. If set to no, composing messages with no subject given at the subject prompt will never be aborted.
- If you prefer reverse order of the above values, prefix it with
- `reverse-'. (PGP only)
+3. abort_unmodified
- 6\b6.\b.3\b3.\b.1\b15\b58\b8.\b. p\bpg\bgp\bp_\b_c\bcr\bre\bea\bat\bte\be_\b_t\btr\bra\bad\bdi\bit\bti\bio\bon\bna\bal\bl
+ Type: quadoption
- Type: quadoption
- Default: no
+ Default: yes
- This option controls whether Mutt generates old-style inline PGP
- encrypted or signed messages.
+ If set to yes, composition will automatically abort after editing the message body if no changes are made to the file (this check only happens after the first edit of the file). When set to no, composition will never be aborted.
- Note that PGP/MIME will be used automatically for messages which have
- a character set different from us-ascii, or which consist of more than
- a single MIME part.
+4. agent_string
- Also note that using the old-style PGP message format is s\bst\btr\bro\bon\bng\bgl\bly\by
- d\bde\bep\bpr\bre\bec\bca\bat\bte\bed\bd. (PGP only)
+ Type: boolean
- 6\b6.\b.3\b3.\b.1\b15\b59\b9.\b. p\bpg\bgp\bp_\b_a\bau\but\bto\bo_\b_t\btr\bra\bad\bdi\bit\bti\bio\bon\bna\bal\bl
+ Default: yes
- Type: boolean
- Default: no
+ When set, Mutt-ng will add a ``User-Agent:'' header to outgoing messages, indicating which version of Mutt-ng was used for composing them.
- This option causes Mutt to generate an old-style inline PGP encrypted
- or signed message when replying to an old-style message, and a
- PGP/MIME message when replying to a PGP/MIME message. Note that this
- option is only meaningful when using ````$crypt_replyencrypt'''',
- ````$crypt_replysign'''', or ````$crypt_replysignencrypted''''.
+5. alias_file
- Also note that PGP/MIME will be used automatically for messages which
- have a character set different from us-ascii, or which consist of more
- than a single MIME part.
+ Type: path
- This option overrides ````$pgp_create_traditional'''' (PGP only)
+ Default: "˜/.muttngrc"
- 6\b6.\b.3\b3.\b.1\b16\b60\b0.\b. p\bpg\bgp\bp_\b_d\bde\bec\bco\bod\bde\be_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ The default file in which to save aliases created by the ``create-alias'' function.
- Type: string
- Default: ""
+ Note: Mutt-ng will not automatically source this file; you must explicitly use the `` source'' command for it to be executed.
- This format strings specifies a command which is used to decode
- application/pgp attachments.
+6. alias_format
- The PGP command formats have their own set of printf-like sequences:
+ Type: string
- %\b%p\bp Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
- string otherwise. Note: This may be used with a %? construct.
+ Default: "%4n %2f %t %-10a %r"
- %\b%f\bf Expands to the name of a file containing a message.
+ Specifies the format of the data displayed for the ``alias'' menu. The following printf(3)-style sequences are available:
- %\b%s\bs Expands to the name of a file containing the signature part of a
- multipart/signed attachment when verifying it.
+ %a
+ alias name
- %\b%a\ba The value of ``$pgp_sign_as''.
+ %f
+ flags - currently, a "d" for an alias marked for deletion
- %\b%r\br One or more key IDs.
+ %n
+ index number
- For examples on how to configure these formats for the various
- versions of PGP which are floating around, see the pgp*.rc and gpg.rc
- files in the samples/ subdirectory which has been installed on your
- system alongside the documentation. (PGP only)
+ %r
+ address which alias expands to
- 6\b6.\b.3\b3.\b.1\b16\b61\b1.\b. p\bpg\bgp\bp_\b_g\bge\bet\btk\bke\bey\bys\bs_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ %t
+ character which indicates if the alias is tagged for inclusion
- Type: string
- Default: ""
+7. allow_8bit
- This command is invoked whenever mutt will need public key
- information. %r is the only printf-like sequence used with this
- format. (PGP only)
+ Type: boolean
- 6\b6.\b.3\b3.\b.1\b16\b62\b2.\b. p\bpg\bgp\bp_\b_v\bve\ber\bri\bif\bfy\by_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: yes
- Type: string
- Default: ""
+ Controls whether 8-bit data is converted to 7-bit using either quoted-printable or base64 encoding when sending mail.
- This command is used to verify PGP signatures. (PGP only)
+8. allow_ansi
- 6\b6.\b.3\b3.\b.1\b16\b63\b3.\b. p\bpg\bgp\bp_\b_d\bde\bec\bcr\bry\byp\bpt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Type: boolean
- Type: string
- Default: ""
+ Default: no
- This command is used to decrypt a PGP encrypted message. (PGP only)
+ Controls whether ANSI color codes in messages (and color tags in rich text messages) are to be interpreted. Messages containing these codes are rare, but if this option is set, their text will be colored accordingly. Note that this may override your color choices, and even present a security problem, since a message could include a line like ``[-- PGP output follows ..." and give it the same color as your attachment color.
- 6\b6.\b.3\b3.\b.1\b16\b64\b4.\b. p\bpg\bgp\bp_\b_c\bcl\ble\bea\bar\brs\bsi\big\bgn\bn_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+9. arrow_cursor
- Type: string
- Default: ""
+ Type: boolean
- This format is used to create a old-style "clearsigned" PGP message.
- Note that the use of this format is s\bst\btr\bro\bon\bng\bgl\bly\by d\bde\bep\bpr\bre\bec\bca\bat\bte\bed\bd. (PGP only)
+ Default: no
- 6\b6.\b.3\b3.\b.1\b16\b65\b5.\b. p\bpg\bgp\bp_\b_s\bsi\big\bgn\bn_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ When set, an arrow (``->'') will be used to indicate the current entry in menus instead of highlighting the whole line. On slow network or modem links this will make response faster because there is less that has to be redrawn on the screen when moving to the next or previous entries in the menu.
- Type: string
- Default: ""
+10. ascii_chars
- This command is used to create the detached PGP signature for a
- multipart/signed PGP/MIME body part. (PGP only)
+ Type: boolean
- 6\b6.\b.3\b3.\b.1\b16\b66\b6.\b. p\bpg\bgp\bp_\b_e\ben\bnc\bcr\bry\byp\bpt\bt_\b_s\bsi\big\bgn\bn_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: no
- Type: string
- Default: ""
+ If set, Mutt-ng will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters.
- This command is used to both sign and encrypt a body part. (PGP only)
+11. askbcc
- 6\b6.\b.3\b3.\b.1\b16\b67\b7.\b. p\bpg\bgp\bp_\b_e\ben\bnc\bcr\bry\byp\bpt\bt_\b_o\bon\bnl\bly\by_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Type: boolean
- Type: string
- Default: ""
+ Default: no
- This command is used to encrypt a body part without signing it. (PGP
- only)
+ If set, Mutt-ng will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message.
- 6\b6.\b.3\b3.\b.1\b16\b68\b8.\b. p\bpg\bgp\bp_\b_i\bim\bmp\bpo\bor\brt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+12. askcc
- Type: string
- Default: ""
+ Type: boolean
- This command is used to import a key from a message into the user's
- public key ring. (PGP only)
+ Default: no
- 6\b6.\b.3\b3.\b.1\b16\b69\b9.\b. p\bpg\bgp\bp_\b_e\bex\bxp\bpo\bor\brt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ If set, Mutt-ng will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message.
- Type: string
- Default: ""
+13. assumed_charset
- This command is used to export a public key from the user's key ring.
- (PGP only)
+ Type: string
- 6\b6.\b.3\b3.\b.1\b17\b70\b0.\b. p\bpg\bgp\bp_\b_v\bve\ber\bri\bif\bfy\by_\b_k\bke\bey\by_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: "us-ascii"
- Type: string
- Default: ""
+ This variable is a colon-separated list of character encoding schemes for messages without character encoding indication. Header field values and message body content without character encoding indication would be assumed that they are written in one of this list. By default, all the header fields and message body without any charset indication are assumed to be in us-ascii.
- This command is used to verify key information from the key selection
- menu. (PGP only)
+ For example, Japanese users might prefer this:
- 6\b6.\b.3\b3.\b.1\b17\b71\b1.\b. p\bpg\bgp\bp_\b_l\bli\bis\bst\bt_\b_s\bse\bec\bcr\bri\bin\bng\bg_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
- Type: string
- Default: ""
+ However, only the first content is valid for the message body. This variable is valid only if $strict_mime is unset.
- This command is used to list the secret key ring's contents. The
- output format must be analogous to the one used by gpg --list-keys
- --with-colons.
+14. attach_format
- This format is also generated by the pgpring utility which comes with
- mutt. (PGP only)
+ Type: string
- 6\b6.\b.3\b3.\b.1\b17\b72\b2.\b. p\bpg\bgp\bp_\b_l\bli\bis\bst\bt_\b_p\bpu\bub\bbr\bri\bin\bng\bg_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
- Type: string
- Default: ""
+ This variable describes the format of the ``attachment'' menu. The following printf(3)-style sequences are understood:
- This command is used to list the public key ring's contents. The
- output format must be analogous to the one used by gpg --list-keys
- --with-colons.
+ %C
+ charset
- This format is also generated by the pgpring utility which comes with
- mutt. (PGP only)
+ %c
+ requires charset conversion (n or c)
- 6\b6.\b.3\b3.\b.1\b17\b73\b3.\b. f\bfo\bor\brw\bwa\bar\brd\bd_\b_d\bde\bec\bcr\bry\byp\bpt\bt
+ %D
+ deleted flag
- Type: boolean
- Default: yes
+ %d
+ description
- Controls the handling of encrypted messages when forwarding a message.
- When set, the outer layer of encryption is stripped off. This
- variable is only used if ````$mime_forward'''' is _\bs_\be_\bt and
- ````$mime_forward_decode'''' is _\bu_\bn_\bs_\be_\bt. (PGP only)
+ %e
+ MIME Content-Transfer-Encoding: header field
- 6\b6.\b.3\b3.\b.1\b17\b74\b4.\b. s\bsm\bmi\bim\bme\be_\b_t\bti\bim\bme\beo\bou\but\bt
+ %f
+ filename
- Type: number
- Default: 300
+ %I
+ MIME Content-Disposition: header field (I=inline, A=attachment)
- The number of seconds after which a cached passphrase will expire if
- not used. (S/MIME only)
+ %m
+ major MIME type
- 6\b6.\b.3\b3.\b.1\b17\b75\b5.\b. s\bsm\bmi\bim\bme\be_\b_e\ben\bnc\bcr\bry\byp\bpt\bt_\b_w\bwi\bit\bth\bh
+ %M
+ MIME subtype
- Type: string
- Default: ""
+ %n
+ attachment number
- This sets the algorithm that should be used for encryption. Valid
- choices are "des", "des3", "rc2-40", "rc2-64", "rc2-128". If unset
- "3des" (TripleDES) is used. (S/MIME only)
+ %s
+ size
+
+ %t
+ tagged flag
+
+ %T
+ graphic tree characters
+
+ %u
+ unlink (=to delete) flag
+
+ %>X
+ right justify the rest of the string and pad with character "X"
+
+ %|X
+ pad to the end of the line with character "X"
+
+15. attach_remind_regexp
+
+ Type: regular expression
+
+ Default: "attach"
+
+ If this variable is non-empty, muttng will scan a message's contents before sending for this regular expression. If it is found, it will ask for what to do depending on the setting of $abort_noattach.
+
+ This variable and $abort_noattach are intended to remind the user to attach files if the message's text references them.
+
+16. attach_sep
+
+ Type: string
+
+ Default: "\n"
+
+ The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments.
+
+17. attach_split
+
+ Type: boolean
+
+ Default: yes
+
+ If this variable is unset, when operating (saving, printing, piping, etc) on a list of tagged attachments, Mutt-ng will concatenate the attachments and will operate on them as a single attachment. The ``$attach_sep'' separator is added after each attachment. When set, Mutt-ng will operate on the attachments one by one.
+
+18. attribution
+
+ Type: string
+
+ Default: "On %d, %n wrote:"
+
+ This is the string that will precede a message which has been included in a reply. For a full listing of defined printf(3)-like sequences see the section on ``$index_format''.
+
+19. auto_tag
+
+ Type: boolean
+
+ Default: no
+
+ When set, functions in the index menu which affect a message will be applied to all tagged messages (if there are any). When unset, you must first use the ``tag-prefix'' function (default: ";") to make the next function apply to all tagged messages.
+
+20. autoedit
+
+ Type: boolean
+
+ Default: no
+
+ When set along with ``$edit_headers'', Mutt-ng will skip the initial send-menu and allow you to immediately begin editing the body of your message. The send-menu may still be accessed once you have finished editing the body of your message.
+
+ Also see ``$fast_reply''.
+
+21. beep
+
+ Type: boolean
+
+ Default: yes
+
+ When this variable is set, Mutt-ng will beep when an error occurs.
+
+22. beep_new
+
+ Type: boolean
+
+ Default: no
+
+ When this variable is set, Mutt-ng will beep whenever it prints a message notifying you of new mail. This is independent of the setting of the ``$beep'' variable.
+
+23. bounce
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Controls whether you will be asked to confirm bouncing messages. If set to yes you don't get asked if you want to bounce a message. Setting this variable to no is not generally useful, and thus not recommended, because you are unable to bounce messages.
+
+24. bounce_delivered
+
+ Type: boolean
+
+ Default: yes
+
+ When this variable is set, Mutt-ng will include Delivered-To: header fields when bouncing messages. Postfix users may wish to unset this variable.
+
+25. braille_friendly
+
+ Type: boolean
+
+ Default: no
+
+ When this variable is set, mutt will place the cursor at the beginning of the current line in menus, even when the arrow_cursor variable is unset, making it easier for blind persons using Braille displays to follow these menus. The option is disabled by default because many visual terminals don't permit making the cursor invisible.
+
+26. certificate_file
+
+ Type: path
+
+ Default: "˜/.mutt_certificates"
+
+ Availability: SSL or GNUTLS
+
+ This variable specifies the file where the certificates you trust are saved. When an unknown certificate is encountered, you are asked if you accept it or not. If you accept it, the certificate can also be saved in this file and further connections are automatically accepted.
+
+ You can also manually add CA certificates in this file. Any server certificate that is signed with one of these CA certificates are also automatically accepted.
+
+ Example: set certificate_file=˜/.muttng/certificates
+
+27. charset
+
+ Type: string
+
+ Default: ""
+
+ Character set your terminal uses to display and enter textual data.
+
+28. check_new
+
+ Type: boolean
+
+ Default: yes
+
+ Note: this option only affects maildir and MH style mailboxes.
+
+ When set, Mutt-ng will check for new mail delivered while the mailbox is open. Especially with MH mailboxes, this operation can take quite some time since it involves scanning the directory and checking each file to see if it has already been looked at. If it's unset, no check for new mail is performed while the mailbox is open.
+
+29. collapse_unread
+
+ Type: boolean
+
+ Default: yes
+
+ When unset, Mutt-ng will not collapse a thread if it contains any unread messages.
+
+30. compose_format
+
+ Type: string
+
+ Default: "-- Mutt-ng: Compose [Approx. msg size: %l Atts: %a]%>-"
+
+ Controls the format of the status line displayed in the ``compose'' menu. This string is similar to ``$status_format'', but has its own set of printf(3)-like sequences:
+
+ %a
+ total number of attachments
+
+ %h
+ local hostname
+
+ %l
+ approximate size (in bytes) of the current message
+
+ %v
+ Mutt-ng version string
+
+ See the text describing the ``$status_format'' option for more information on how to set ``$compose_format''.
+
+31. config_charset
+
+ Type: string
+
+ Default: ""
+
+ When defined, Mutt-ng will recode commands in rc files from this encoding.
+
+32. confirmappend
+
+ Type: boolean
+
+ Default: yes
+
+ When set, Mutt-ng will prompt for confirmation when appending messages to an existing mailbox.
+
+33. confirmcreate
+
+ Type: boolean
+
+ Default: yes
+
+ When set, Mutt-ng will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it.
+
+34. connect_timeout
+
+ Type: number
+
+ Default: 30
+
+ Causes Mutt-ng to timeout a network connection (for IMAP or POP) after this many seconds if the connection is not able to be established. A negative value causes Mutt-ng to wait indefinitely for the connection to succeed.
+
+35. content_type
+
+ Type: string
+
+ Default: "text/plain"
+
+ Sets the default Content-Type: header field for the body of newly composed messages.
+
+36. copy
+
+ Type: quadoption
+
+ Default: yes
+
+ This variable controls whether or not copies of your outgoing messages will be saved for later references. Also see ``$record'', ``$save_name'', ``$force_name'' and ``fcc-hook''.
+
+37. crypt_autoencrypt
+
+ Type: boolean
+
+ Default: no
+
+ Setting this variable will cause Mutt-ng to always attempt to PGP encrypt outgoing messages. This is probably only useful in connection to the send-hook command. It can be overridden by use of the pgp-menu, when encryption is not required or signing is requested as well. If ``$smime_is_default'' is set, then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only)
+
+38. crypt_autopgp
+
+ Type: boolean
+
+ Default: yes
+
+ This variable controls whether or not Mutt-ng may automatically enable PGP encryption/signing for messages. See also ``$crypt_autoencrypt'', ``$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''.
+
+39. crypt_autosign
+
+ Type: boolean
+
+ Default: no
+
+ Setting this variable will cause Mutt-ng to always attempt to cryptographically sign outgoing messages. This can be overridden by use of the pgp-menu, when signing is not required or encryption is requested as well. If ``$smime_is_default'' is set, then OpenSSL is used instead to create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only)
+
+40. crypt_autosmime
+
+ Type: boolean
+
+ Default: yes
+
+ This variable controls whether or not Mutt-ng may automatically enable S/MIME encryption/signing for messages. See also ``$crypt_autoencrypt'', ``$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''.
+
+41. crypt_replyencrypt
+
+ Type: boolean
+
+ Default: yes
+
+ If set, automatically PGP or OpenSSL encrypt replies to messages which are encrypted. (Crypto only)
+
+42. crypt_replysign
+
+ Type: boolean
+
+ Default: no
+
+ If set, automatically PGP or OpenSSL sign replies to messages which are signed.
+
+ Note: this does not work on messages that are encrypted and signed! (Crypto only)
+
+43. crypt_replysignencrypted
+
+ Type: boolean
+
+ Default: no
+
+ If set, automatically PGP or OpenSSL sign replies to messages which are encrypted. This makes sense in combination with ``$crypt_replyencrypt'', because it allows you to sign all messages which are automatically encrypted. This works around the problem noted in ``$crypt_replysign'', that Mutt-ng is not able to find out whether an encrypted message is also signed. (Crypto only)
+
+44. crypt_timestamp
+
+ Type: boolean
+
+ Default: yes
+
+ If set, Mutt-ng will include a time stamp in the lines surrounding PGP or S/MIME output, so spoofing such lines is more difficult. If you are using colors to mark these lines, and rely on these, you may unset this setting. (Crypto only)
+
+45. crypt_use_gpgme
+
+ Type: boolean
+
+ Default: no
+
+ This variable controls the use the GPGME enabled crypto backends. If it is set and Mutt-ng was build with gpgme support, the gpgme code for S/MIME and PGP will be used instead of the classic code.
+
+ Note: You need to use this option in your .muttngrc configuration file as it won't have any effect when used interactively.
+
+46. crypt_verify_sig
+
+ Type: quadoption
+
+ Default: yes
+
+ If ``yes'', always attempt to verify PGP or S/MIME signatures. If ``ask'', ask whether or not to verify the signature. If ``no'', never attempt to verify cryptographic signatures. (Crypto only)
+
+47. date_format
+
+ Type: string
+
+ Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"
+
+ This variable controls the format of the date printed by the ``%d'' sequence in ``$index_format''. This is passed to strftime(3) to process the date.
+
+ Unless the first character in the string is a bang (``!''), the month and week day names are expanded according to the locale specified in the variable ``$locale''. If the first character in the string is a bang, the bang is discarded, and the month and week day names in the rest of the string are expanded in the C locale (that is in US English).
+
+48. debug_level
+
+ Type: number
+
+ Default: 0
+
+ Availability: debug
+
+ This variable specifies the current debug level and may be used to increase or decrease the verbosity level during runtime. It overrides the level given with the -d command line option.
+
+ Currently, this number must be >= 0 and <= 5 and muttng must be started with -d to enable debugging at all; enabling at runtime is not possible.
+
+49. default_hook
+
+ Type: string
+
+ Default: "˜f %s !˜P | (˜P ˜C %s)"
+
+ This variable controls how send-hooks, message-hooks, save-hooks, and fcc-hooks will be interpreted if they are specified with only a simple regexp, instead of a matching pattern. The hooks are expanded when they are declared, so a hook will be interpreted according to the value of this variable at the time the hook is declared. The default value matches if the message is either from a user matching the regular expression given, or if it is from you (if the from address matches ``alternates'') and is to or cc'ed to a user matching the given regular expression.
+
+50. delete
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Controls whether or not messages are really deleted when closing or synchronizing a mailbox. If set to yes, messages marked for deleting will automatically be purged without prompting. If set to no, messages marked for deletion will be kept in the mailbox.
+
+51. delete_space
+
+ Type: boolean
+
+ Default: no
+
+ When sending messages with format=flowed by setting the $text_flowed variable, this variable specifies whether to also set the DelSp parameter to yes. If this is unset, no additional parameter will be send as a value of no already is the default behavior.
+
+ Note: this variable only has an effect on outgoing messages (if $text_flowed is set) but not on incomming.
+
+52. delete_untag
+
+ Type: boolean
+
+ Default: yes
+
+ If this option is set, Mutt-ng will untag messages when marking them for deletion. This applies when you either explicitly delete a message, or when you save it to another folder.
+
+53. digest_collapse
+
+ Type: boolean
+
+ Default: yes
+
+ If this option is set, Mutt-ng's received-attachments menu will not show the subparts of individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.
+
+54. display_filter
+
+ Type: path
+
+ Default: ""
+
+ When set, specifies a command used to filter messages. When a message is viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output.
+
+55. dotlock_program
+
+ Type: path
+
+ Default: "$muttng_bindir/muttng_dotlock"
+
+ Availability: Standalone and Dotlock
+
+ Contains the path of the muttng_dotlock(1) binary to be used by Mutt-ng.
+
+56. dsn_notify
+
+ Type: string
+
+ Default: ""
+
+ Note: you should not enable this unless you are using Sendmail 8.8.x or greater or in connection with the SMTP support via libESMTP.
+
+ This variable sets the request for when notification is returned. The string consists of a comma separated list (no spaces!) of one or more of the following: never, to never request notification, failure, to request notification on transmission failure, delay, to be notified of message delays, success, to be notified of successful transmission.
+
+ Example: set dsn_notify="failure,delay"
+
+57. dsn_return
+
+ Type: string
+
+ Default: ""
+
+ Note: you should not enable this unless you are using Sendmail 8.8.x or greater or in connection with the SMTP support via libESMTP.
+
+ This variable controls how much of your message is returned in DSN messages. It may be set to either hdrs to return just the message header, or full to return the full message.
+
+ Example: set dsn_return=hdrs
+
+58. duplicate_threads
+
+ Type: boolean
+
+ Default: yes
+
+ This variable controls whether Mutt-ng, when sorting by threads, threads messages with the same Message-Id: header field together. If it is set, it will indicate that it thinks they are duplicates of each other with an equals sign in the thread diagram.
+
+59. edit_headers
+
+ Type: boolean
+
+ Default: no
+
+ This option allows you to edit the header of your outgoing messages along with the body of your message.
+
+ Which empty header fields to show is controlled by the $editor_headers option.
+
+60. editor
+
+ Type: path
+
+ Default: ""
+
+ This variable specifies which editor is used by Mutt-ng. It defaults to the value of the $VISUAL, or $EDITOR, environment variable, or to the string "vi" if neither of those are set.
+
+61. editor_headers
+
+ Type: string
+
+ Default: "From: To: Cc: Bcc: Subject: Reply-To: Newsgroups: Followup-To: X-Comment-To:"
+
+ If $edit_headers is set, this space-separated list specifies which non-empty header fields to edit in addition to user-defined headers.
+
+ Note: if $edit_headers had to be turned on by force because $strict_mailto is unset, this option has no effect.
+
+62. encode_from
+
+ Type: boolean
+
+ Default: no
+
+ When set, Mutt-ng will quoted-printable encode messages when they contain the string ``From '' (note the trailing space) in the beginning of a line. Useful to avoid the tampering certain mail delivery and transport agents tend to do with messages.
+
+ Note: as mutt-ng currently violates RfC3676 defining format=flowed, it's <em/strongly/ advised to set this option although discouraged by the standard. Alternatively, you must take care of space-stuffing <tt/From / lines (with a trailing space) yourself.
+
+63. entropy_file
+
+ Type: path
+
+ Default: ""
+
+ Availability: SSL
+
+ The file which includes random data that is used to initialize SSL library functions.
+
+64. envelope_from
+
+ Type: boolean
+
+ Default: no
+
+ When set, Mutt-ng will try to derive the message's envelope sender from the ``From:'' header field. Note that this information is passed to the sendmail command using the ``-f" command line switch, so don't set this option if you are using that switch in $sendmail yourself, or if the sendmail on your machine doesn't support that command line switch.
+
+65. escape
+
+ Type: string
+
+ Default: "˜"
+
+ Escape character to use for functions in the builtin editor.
+
+66. fast_reply
+
+ Type: boolean
+
+ Default: no
+
+ When set, the initial prompt for recipients and subject are skipped when replying to messages, and the initial prompt for subject is skipped when forwarding messages.
+
+ Note: this variable has no effect when the ``$autoedit'' variable is set.
+
+67. fcc_attach
+
+ Type: boolean
+
+ Default: yes
+
+ This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message.
+
+68. fcc_clear
+
+ Type: boolean
+
+ Default: no
+
+ When this variable is set, FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed. (PGP only)
+
+69. file_charset
+
+ Type: string
+
+ Default: ""
+
+ This variable is a colon-separated list of character encoding schemes for text file attatchments. If unset, $charset value will be used instead. For example, the following configuration would work for Japanese text handling:
+
+ set file_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
+
+ Note: ``iso-2022-*'' must be put at the head of the value as shown above if included.
+
+70. folder
+
+ Type: path
+
+ Default: "˜/Mail"
+
+ Specifies the default location of your mailboxes. A ``+'' or ``='' at the beginning of a pathname will be expanded to the value of this variable. Note that if you change this variable from the default value you need to make sure that the assignment occurs before you use ``+'' or ``='' for any other variables since expansion takes place during the ``set'' command.
+
+71. folder_format
+
+ Type: string
+
+ Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
+
+ This variable allows you to customize the file browser display to your personal taste. This string is similar to ``$index_format'', but has its own set of printf(3)-like sequences:
+
+ %C
+ current file number
+
+ %d
+ date/time folder was last modified
+
+ %f
+ filename
+
+ %F
+ file permissions
+
+ %g
+ group name (or numeric gid, if missing)
+
+ %l
+ number of hard links
+
+ %N
+ N if folder has new mail, blank otherwise
+
+ %s
+ size in bytes
+
+ %t
+ * if the file is tagged, blank otherwise
+
+ %u
+ owner name (or numeric uid, if missing)
+
+ %>X
+ right justify the rest of the string and pad with character "X"
+
+ %|X
+ pad to the end of the line with character "X"
+
+72. followup_to
+
+ Type: boolean
+
+ Default: yes
+
+ Controls whether or not the Mail-Followup-To: header field is generated when sending mail. When set, Mutt-ng will generate this field when you are replying to a known mailing list, specified with the ``subscribe'' or ``lists'' commands or detected by common mailing list headers.
+
+ This field has two purposes. First, preventing you from receiving duplicate copies of replies to messages which you send to mailing lists. Second, ensuring that you do get a reply separately for any messages sent to known lists to which you are not subscribed. The header will contain only the list's address for subscribed lists, and both the list address and your own email address for unsubscribed lists. Without this header, a group reply to your message sent to a subscribed list will be sent to both the list and your address, resulting in two copies of the same email for you.
+
+73. force_buffy_check
+
+ Type: boolean
+
+ Default: no
+
+ When set, it causes Mutt-ng to check for new mail when the buffy-list command is invoked. When unset, buffy_list will just list all mailboxes which are already known to have new mail.
+
+ Also see the following variables: ``$timeout'', ``$mail_check'' and ``$imap_mail_check''.
+
+74. force_name
+
+ Type: boolean
+
+ Default: no
+
+ This variable is similar to ``$save_name'', except that Mutt-ng will store a copy of your outgoing message by the username of the address you are sending to even if that mailbox does not exist.
+
+ Also see the ``$record'' variable.
+
+75. forward_decode
+
+ Type: boolean
+
+ Default: yes
+
+ Controls the decoding of complex MIME messages into text/plain when forwarding a message. The message header is also RFC2047 decoded. This variable is only used, if ``$mime_forward'' is unset, otherwise ``$mime_forward_decode'' is used instead.
+
+76. forward_decrypt
+
+ Type: boolean
+
+ Default: yes
+
+ Controls the handling of encrypted messages when forwarding a message. When set, the outer layer of encryption is stripped off. This variable is only used if ``$mime_forward'' is set and ``$mime_forward_decode'' is unset. (PGP only)
+
+77. forward_edit
+
+ Type: quadoption
+
+ Default: yes
+
+ This quadoption controls whether or not the user is automatically placed in the editor when forwarding messages. For those who always want to forward with no modification, use a setting of no.
+
+78. forward_format
+
+ Type: string
+
+ Default: "[%a: %s]"
+
+ This variable controls the default subject when forwarding a message. It uses the same format sequences as the ``$index_format'' variable.
+
+79. forward_quote
+
+ Type: boolean
+
+ Default: no
+
+ When set forwarded messages included in the main body of the message (when ``$mime_forward'' is unset) will be quoted using ``$indent_string''.
+
+80. from
+
+ Type: e-mail address
+
+ Default: ""
+
+ This variable contains a default from address. It can be overridden using my_hdr (including from send-hooks) and ``$reverse_name''. This variable is ignored if ``$use_from'' is unset.
+
+ E.g. you can use send-hook Mutt-ng-devel@lists.berlios.de 'my_hdr From: Foo Bar <foo@bar.fb>' when replying to the mutt-ng developer's mailing list and Mutt-ng takes this email address.
+
+ Defaults to the contents of the environment variable $EMAIL.
+
+81. gecos_mask
+
+ Type: regular expression
+
+ Default: "^[^,]*"
+
+ A regular expression used by Mutt-ng to parse the GECOS field of a password entry when expanding the alias. By default the regular expression is set to ``^[^,]*'' which will return the string up to the first ``,'' encountered. If the GECOS field contains a string like "lastname, firstname" then you should do: set gecos_mask=".*".
+
+ This can be useful if you see the following behavior: you address a e-mail to user ID stevef whose full name is Steve Franklin. If Mutt-ng expands stevef to ``Franklin'' stevef@foo.bar then you should set the gecos_mask to a regular expression that will match the whole name so Mutt-ng will expand ``Franklin'' to ``Franklin, Steve''.
+
+82. hdrs
+
+ Type: boolean
+
+ Default: yes
+
+ When unset, the header fields normally added by the ``my_hdr'' command are not created. This variable must be unset before composing a new message or replying in order to take effect. If set, the user defined header fields are added to every new message.
+
+83. header
+
+ Type: boolean
+
+ Default: no
+
+ When set, this variable causes Mutt-ng to include the header of the message you are replying to into the edit buffer. The ``$weed'' setting applies.
+
+84. header_cache
+
+ Type: path
+
+ Default: ""
+
+ Availability: Header Cache
+
+ The $header_cache variable points to the header cache database.
+
+ If $header_cache points to a directory it will contain a header cache database per folder. If $header_cache points to a file that file will be a single global header cache. By default it is unset so no header caching will be used.
+
+85. header_cache_compress
+
+ Type: boolean
+
+ Default: no
+
+ If enabled the header cache will be compressed. So only one fifth of the usual diskspace is used, but the uncompression can result in a slower open of the cached folder.
+
+86. help
+
+ Type: boolean
+
+ Default: yes
+
+ When set, help lines describing the bindings for the major functions provided by each menu are displayed on the first line of the screen.
+
+ Note: The binding will not be displayed correctly if the function is bound to a sequence rather than a single keystroke. Also, the help line may not be updated if a binding is changed while Mutt-ng is running. Since this variable is primarily aimed at new users, neither of these should present a major problem.
+
+87. hidden_host
+
+ Type: boolean
+
+ Default: no
+
+ When set, Mutt-ng will skip the host name part of ``$hostname'' variable when adding the domain part to addresses. This variable does not affect the generation of Message-ID: header fields, and it will not lead to the cut-off of first-level domains.
+
+88. hide_limited
+
+ Type: boolean
+
+ Default: no
+
+ When set, Mutt-ng will not show the presence of messages that are hidden by limiting, in the thread tree.
+
+89. hide_missing
+
+ Type: boolean
+
+ Default: yes
+
+ When set, Mutt-ng will not show the presence of missing messages in the thread tree.
+
+90. hide_thread_subject
+
+ Type: boolean
+
+ Default: yes
+
+ When set, Mutt-ng will not show the subject of messages in the thread tree that have the same subject as their parent or closest previously displayed sibling.
+
+91. hide_top_limited
+
+ Type: boolean
+
+ Default: no
+
+ When set, Mutt-ng will not show the presence of messages that are hidden by limiting, at the top of threads in the thread tree. Note that when $hide_missing is set, this option will have no effect.
+
+92. hide_top_missing
+
+ Type: boolean
+
+ Default: yes
+
+ When set, Mutt-ng will not show the presence of missing messages at the top of threads in the thread tree. Note that when $hide_limited is set, this option will have no effect.
+
+93. history
+
+ Type: number
+
+ Default: 10
+
+ This variable controls the size (in number of strings remembered) of the string history buffer. The buffer is cleared each time the variable is changed.
+
+94. honor_followup_to
+
+ Type: quadoption
+
+ Default: yes
+
+ This variable controls whether or not a Mail-Followup-To: header field is honored when group-replying to a message.
+
+95. hostname
+
+ Type: string
+
+ Default: ""
+
+ Specifies the hostname to use after the ``@'' in local e-mail addresses and during generation of Message-Id: headers.
+
+ Please be sure to really know what you are doing when changing this variable to configure a custom domain part of Message-IDs.
+
+96. ignore_list_reply_to
+
+ Type: boolean
+
+ Default: no
+
+ Affects the behaviour of the reply function when replying to messages from mailing lists. When set, if the ``Reply-To:'' header field is set to the same value as the ``To:'' header field, Mutt-ng assumes that the ``Reply-To:'' header field was set by the mailing list to automate responses to the list, and will ignore this field. To direct a response to the mailing list when this option is set, use the list-reply function; group-reply will reply to both the sender and the list.
+
+97. imap_authenticators
+
+ Type: string
+
+ Default: ""
+
+ Availability: IMAP
+
+ This is a colon-delimited list of authentication methods Mutt-ng may attempt to use to log in to an IMAP server, in the order Mutt-ng should try them. Authentication methods are either ``login'' or the right side of an IMAP ``AUTH='' capability string, e.g. ``digest-md5'', ``gssapi'' or ``cram-md5''. This parameter is case-insensitive.
+
+ If this parameter is unset (the default) Mutt-ng will try all available methods, in order from most-secure to least-secure.
+
+ Example: set imap_authenticators="gssapi:cram-md5:login"
+
+ Note: Mutt-ng will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, Mutt-ng will not connect to the IMAP server.
+
+98. imap_check_subscribed
+
+ Type: boolean
+
+ Default: no
+
+ When set, mutt will fetch the set of subscribed folders from your server on connection, and add them to the set of mailboxes it polls for new mail. See also the ``mailboxes'' command.
+
+99. imap_delim_chars
+
+ Type: string
+
+ Default: "/."
+
+ Availability: IMAP
+
+ This contains the list of characters which you would like to treat as folder separators for displaying IMAP paths. In particular it helps in using the '=' shortcut for your $folder variable.
+
+100. imap_headers
+
+ Type: string
+
+ Default: ""
+
+ Availability: IMAP
+
+ Mutt-ng requests these header fields in addition to the default headers (``DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL'') from IMAP servers before displaying the ``index'' menu. You may want to add more headers for spam detection.
+
+ Note: This is a space separated list.
+
+101. imap_home_namespace
+
+ Type: string
+
+ Default: ""
+
+ Availability: IMAP
+
+ You normally want to see your personal folders alongside your INBOX in the IMAP browser. If you see something else, you may set this variable to the IMAP path to your folders.
+
+102. imap_keepalive
+
+ Type: number
+
+ Default: 900
+
+ Availability: IMAP
+
+ This variable specifies the maximum amount of time in seconds that Mutt-ng will wait before polling open IMAP connections, to prevent the server from closing them before Mutt-ng has finished with them.
+
+ The default is well within the RFC-specified minimum amount of time (30 minutes) before a server is allowed to do this, but in practice the RFC does get violated every now and then.
+
+ Reduce this number if you find yourself getting disconnected from your IMAP server due to inactivity.
+
+103. imap_list_subscribed
+
+ Type: boolean
+
+ Default: no
+
+ Availability: IMAP
+
+ This variable configures whether IMAP folder browsing will look for only subscribed folders or all folders. This can be toggled in the IMAP browser with the toggle-subscribed function.
+
+104. imap_login
+
+ Type: string
+
+ Default: ""
+
+ Availability: IMAP
+
+ Your login name on the IMAP server.
+
+ This variable defaults to the value of ``$imap_user.''
+
+105. imap_mail_check
+
+ Type: number
+
+ Default: 300
+
+ This variable configures how often (in seconds) Mutt-ng should look for new mail in IMAP folders. This is split from the ``mail_check'' variable to generate less traffic and get more accurate information for local folders.
+
+106. imap_pass
+
+ Type: string
+
+ Default: ""
+
+ Availability: IMAP
+
+ Specifies the password for your IMAP account. If unset, Mutt-ng will prompt you for your password when you invoke the fetch-mail function.
+
+ Warning: you should only use this option when you are on a fairly secure machine, because the superuser can read your configuration even if you are the only one who can read the file.
+
+107. imap_passive
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: IMAP
+
+ When set, Mutt-ng will not open new IMAP connections to check for new mail. Mutt-ng will only check for new mail over existing IMAP connections. This is useful if you don't want to be prompted to user/password pairs on Mutt-ng invocation, or if opening the connection is slow.
+
+108. imap_peek
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: IMAP
+
+ If set, Mutt-ng will avoid implicitly marking your mail as read whenever you fetch a message from the server. This is generally a good thing, but can make closing an IMAP folder somewhat slower. This option exists to appease speed freaks.
+
+109. imap_reconnect
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Availability: IMAP
+
+ Controls whether or not Mutt-ng will try to reconnect to IMAP server when the connection is lost.
+
+110. imap_servernoise
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: IMAP
+
+ When set, Mutt-ng will display warning messages from the IMAP server as error messages. Since these messages are often harmless, or generated due to configuration problems on the server which are out of the users' hands, you may wish to suppress them at some point.
+
+111. imap_user
+
+ Type: string
+
+ Default: ""
+
+ Availability: IMAP
+
+ The name of the user whose mail you intend to access on the IMAP server.
+
+ This variable defaults to your user name on the local machine.
+
+112. implicit_autoview
+
+ Type: boolean
+
+ Default: no
+
+ If set, Mutt-ng will look for a mailcap entry with the ``copiousoutput'' flag set for every MIME attachment it doesn't have an internal viewer defined for. If such an entry is found, Mutt-ng will use the viewer defined in that entry to convert the body part to text form.
+
+113. include
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Controls whether or not a copy of the message(s) you are replying to is included in your reply.
+
+114. include_onlyfirst
+
+ Type: boolean
+
+ Default: no
+
+ Controls whether or not Mutt-ng includes only the first attachment of the message you are replying.
+
+115. indent_string
+
+ Type: string
+
+ Default: "> "
+
+ Specifies the string to prepend to each line of text quoted in a message to which you are replying. You are strongly encouraged not to change this value, as it tends to agitate the more fanatical netizens.
+
+116. index_format
+
+ Type: string
+
+ Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
+
+ This variable allows you to customize the message index display to your personal taste.
+
+ ``Format strings'' are similar to the strings used in the ``C'' function printf(3) to format output (see the man page for more detail). The following sequences are defined in Mutt-ng:
+
+ %a
+ address of the author
+
+ %A
+ reply-to address (if present; otherwise: address of author)
+
+ %b
+ filename of the original message folder (think mailBox)
+
+ %B
+ the list to which the letter was sent, or else the folder name (%b).
+
+ %c
+ number of characters (bytes) in the message
+
+ %C
+ current message number
+
+ %d
+ date and time of the message in the format specified by ``date_format'' converted to sender's time zone
+
+ %D
+ date and time of the message in the format specified by ``date_format'' converted to the local time zone
+
+ %e
+ current message number in thread
+
+ %E
+ number of messages in current thread
+
+ %f
+ entire From: line (address + real name)
+
+ %F
+ author name, or recipient name if the message is from you
+
+ %H
+ spam attribute(s) of this message
+
+ %g
+ newsgroup name (if compiled with nntp support)
+
+ %i
+ message-id of the current message
+
+ %l
+ number of lines in the message (does not work with maildir, mh, and possibly IMAP folders)
+
+ %L
+ If an address in the To or CC header field matches an address defined by the users ``subscribe'' command, this displays "To <list-name>", otherwise the same as %F.
+
+ %m
+ total number of message in the mailbox
+
+ %M
+ number of hidden messages if the thread is collapsed.
+
+ %N
+ message score
+
+ %n
+ author's real name (or address if missing)
+
+ %O
+ (_O_riginal save folder) Where Mutt-ng would formerly have stashed the message: list name or recipient name if no list
+
+ %s
+ subject of the message
+
+ %S
+ status of the message (N/D/d/!/r/*)
+
+ %t
+ `to:' field (recipients)
+
+ %T
+ the appropriate character from the $to_chars string
+
+ %u
+ user (login) name of the author
+
+ %v
+ first name of the author, or the recipient if the message is from you
+
+ %W
+ name of organization of author (`organization:' field)
+
+ %y
+ `x-label:' field, if present
+
+ %Y
+ `x-label' field, if present, and (1) not at part of a thread tree, (2) at the top of a thread, or (3) `x-label' is different from preceding message's `x-label'.
+
+ %Z
+ message status flags
+
+ %{fmt}
+ the date and time of the message is converted to sender's time zone, and ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales
+
+ %[fmt]
+ the date and time of the message is converted to the local time zone, and ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales
+
+ %(fmt)
+ the local date and time when the message was received. ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales
+
+ %<fmt>
+ the current local time. ``fmt'' is expanded by the library function ``strftime''; a leading bang disables locales.
+
+ %>X
+ right justify the rest of the string and pad with character "X"
+
+ %|X
+ pad to the end of the line with character "X"
+
+ See also: ``$to_chars''.
+
+117. ispell
+
+ Type: path
+
+ Default: "ispell"
+
+ How to invoke ispell (GNU's spell-checking software).
+
+118. keep_flagged
+
+ Type: boolean
+
+ Default: no
+
+ If set, read messages marked as flagged will not be moved from your spool mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
+
+119. list_reply
+
+ Type: quadoption
+
+ Default: no
+
+ When set, address replies to the mailing list the original message came from (instead to the author only). Setting this option to ``ask-yes'' or ``ask-no'' will ask if you really intended to reply to the author only.
+
+120. locale
+
+ Type: string
+
+ Default: "C"
+
+ The locale used by strftime(3) to format dates. Legal values are the strings your system accepts for the locale variable LC_TIME.
+
+121. mail_check
+
+ Type: number
+
+ Default: 5
+
+ This variable configures how often (in seconds) Mutt-ng should look for new mail.
+
+ Note: This does not apply to IMAP mailboxes, see $imap_mail_check.
+
+122. mailcap_path
+
+ Type: string
+
+ Default: ""
+
+ This variable specifies which files to consult when attempting to display MIME bodies not directly supported by Mutt-ng.
+
+123. mailcap_sanitize
+
+ Type: boolean
+
+ Default: yes
+
+ If set, Mutt-ng will restrict possible characters in mailcap % expandos to a well-defined set of safe characters. This is the safe setting, but we are not sure it doesn't break some more advanced MIME stuff.
+
+ DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING!
+
+124. maildir_header_cache_verify
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: Header Cache
+
+ Check for Maildir unaware programs other than Mutt-ng having modified maildir files when the header cache is in use. This incurs one stat(2) per message every time the folder is opened.
+
+125. maildir_trash
+
+ Type: boolean
+
+ Default: no
+
+ If set, messages marked as deleted will be saved with the maildir (T)rashed flag instead of physically deleted.
+
+ NOTE: this only applies to maildir-style mailboxes. Setting it will have no effect on other mailbox types.
+
+ It is similiar to the trash option.
+
+126. mark_old
+
+ Type: boolean
+
+ Default: yes
+
+ Controls whether or not Mutt-ng marks new unread messages as old if you exit a mailbox without reading them.
+
+ With this option set, the next time you start Mutt-ng, the messages will show up with an "O" next to them in the ``index'' menu, indicating that they are old.
+
+127. markers
+
+ Type: boolean
+
+ Default: yes
+
+ Controls the display of wrapped lines in the internal pager. If set, a ``+'' marker is displayed at the beginning of wrapped lines. Also see the ``$smart_wrap'' variable.
+
+128. mask
+
+ Type: regular expression
+
+ Default: "!^\.[^.]"
+
+ A regular expression used in the file browser, optionally preceded by the not operator ``!''. Only files whose names match this mask will be shown. The match is always case-sensitive.
+
+129. max_display_recips
+
+ Type: number
+
+ Default: 0
+
+ When set non-zero, this specifies the maximum number of recipient header lines (To:, Cc: and Bcc:) to display in the pager if header weeding is turned on. In case the number of lines exeeds its value, the last line will have 3 dots appended.
+
+130. max_line_length
+
+ Type: number
+
+ Default: 0
+
+ When set, the maximum line length for displaying ``format = flowed'' messages is limited to this length. A value of 0 (which is also the default) means that the maximum line length is determined by the terminal width and $wrapmargin.
+
+131. mbox
+
+ Type: path
+
+ Default: "˜/mbox"
+
+ This specifies the folder into which read mail in your ``$spoolfile'' folder will be appended.
+
+132. mbox_type
+
+ Type: folder magic
+
+ Default: mbox
+
+ The default mailbox type used when creating new folders. May be any of mbox, MMDF, MH and Maildir.
+
+133. menu_context
+
+ Type: number
+
+ Default: 0
+
+ This variable controls the number of lines of context that are given when scrolling through menus. (Similar to ``$pager_context''.)
+
+134. menu_move_off
+
+ Type: boolean
+
+ Default: yes
+
+ When unset, the bottom entry of menus will never scroll up past the bottom of the screen, unless there are less entries than lines. When set, the bottom entry may move off the bottom.
+
+135. menu_scroll
+
+ Type: boolean
+
+ Default: no
+
+ When set, menus will be scrolled up or down one line when you attempt to move across a screen boundary. If unset, the screen is cleared and the next or previous page of the menu is displayed (useful for slow links to avoid many redraws).
+
+136. message_format
+
+ Type: string
+
+ Default: "%s"
+
+ This is the string displayed in the ``attachment'' menu for attachments of type message/rfc822. For a full listing of defined printf(3)-like sequences see the section on ``$index_format''.
+
+137. meta_key
+
+ Type: boolean
+
+ Default: no
+
+ If set, forces Mutt-ng to interpret keystrokes with the high bit (bit 8) set as if the user had pressed the ESC key and whatever key remains after having the high bit removed. For example, if the key pressed has an ASCII value of 0xf4, then this is treated as if the user had pressed ESC then ``x''. This is because the result of removing the high bit from ``0xf4'' is ``0x74'', which is the ASCII character ``x''.
+
+138. metoo
+
+ Type: boolean
+
+ Default: no
+
+ If unset, Mutt-ng will remove your address (see the ``alternates'' command) from the list of recipients when replying to a message.
+
+139. mh_purge
+
+ Type: boolean
+
+ Default: no
+
+ When unset, Mutt-ng will mimic mh's behaviour and rename deleted messages to ,<old file name> in mh folders instead of really deleting them. If the variable is set, the message files will simply be deleted.
+
+140. mh_seq_flagged
+
+ Type: string
+
+ Default: "flagged"
+
+ The name of the MH sequence used for flagged messages.
+
+141. mh_seq_replied
+
+ Type: string
+
+ Default: "replied"
+
+ The name of the MH sequence used to tag replied messages.
+
+142. mh_seq_unseen
+
+ Type: string
+
+ Default: "unseen"
+
+ The name of the MH sequence used for unseen messages.
+
+143. mime_forward
+
+ Type: quadoption
+
+ Default: no
+
+ When set, the message you are forwarding will be attached as a separate MIME part instead of included in the main body of the message.
+
+ This is useful for forwarding MIME messages so the receiver can properly view the message as it was delivered to you. If you like to switch between MIME and not MIME from mail to mail, set this variable to ask-no or ask-yes.
+
+ Also see ``$forward_decode'' and ``$mime_forward_decode''.
+
+144. mime_forward_decode
+
+ Type: boolean
+
+ Default: no
+
+ Controls the decoding of complex MIME messages into text/plain when forwarding a message while ``$mime_forward'' is set. Otherwise ``$forward_decode'' is used instead.
+
+145. mime_forward_rest
+
+ Type: quadoption
+
+ Default: yes
+
+ When forwarding multiple attachments of a MIME message from the recvattach menu, attachments which cannot be decoded in a reasonable manner will be attached to the newly composed message if this option is set.
+
+146. mix_entry_format
+
+ Type: string
+
+ Default: "%4n %c %-16s %a"
+
+ Availability: Mixmaster
+
+ This variable describes the format of a remailer line on the mixmaster chain selection screen. The following printf(3)-like sequences are supported:
+
+ %n
+ The running number on the menu.
+
+ %c
+ Remailer capabilities.
+
+ %s
+ The remailer's short name.
+
+ %a
+ The remailer's e-mail address.
+
+147. mixmaster
+
+ Type: path
+
+ Default: "mixmaster"
+
+ Availability: Mixmaster
+
+ This variable contains the path to the Mixmaster binary on your system. It is used with various sets of parameters to gather the list of known remailers, and to finally send a message through the mixmaster chain.
+
+148. move
+
+ Type: quadoption
+
+ Default: ask-no
+
+ Controls whether or not Mutt-ng will move read messages from your spool mailbox to your ``$mbox'' mailbox, or as a result of a ``mbox-hook'' command.
+
+149. msgid_format
+
+ Type: string
+
+ Default: "%Y%m%d%h%M%s.G%P%p"
+
+ This is the format for the ``local part'' of the Message-Id: header field generated by Mutt-ng. If this variable is empty, no Message-Id: headers will be generated. The '%' character marks that certain data will be added to the string, similar to printf(3). The following characters are allowed:
+
+ %d
+ the current day of month
+
+ %h
+ the current hour
+
+ %m
+ the current month
+
+ %M
+ the current minute
+
+ %O
+ the current UNIX timestamp (octal)
+
+ %p
+ the process ID
+
+ %P
+ the current Message-ID prefix (a character rotating with every Message-ID being generated)
+
+ %r
+ a random integer value (decimal)
+
+ %R
+ a random integer value (hexadecimal)
+
+ %s
+ the current second
+
+ %T
+ the current UNIX timestamp (decimal)
+
+ %X
+ the current UNIX timestamp (hexadecimal)
+
+ %Y
+ the current year (Y2K compliant)
+
+ %%
+ the '%' character
+
+ Note: Please only change this setting if you know what you are doing. Also make sure to consult RFC2822 to produce technically valid strings.
+
+150. muttng_bindir
+
+ Type: system property
+
+ Value: /opt/freebsd4/mutt-ng/bin
+
+ This is a read-only system property and specifies the directory containing the muttng binary.
+
+151. muttng_docdir
+
+ Type: system property
+
+ Value: /opt/freebsd4/mutt-ng/doc/muttng
+
+ This is a read-only system property and specifies the directory containing the muttng documentation.
+
+152. muttng_folder_name
+
+ Type: system property
+
+ Value:
+
+ This is a read-only system property and, at runtime, specifies the last part of the full path or URI of the folder currently open (if any), i.e. everything after the last ``/''.
+
+153. muttng_folder_path
+
+ Type: system property
+
+ Value:
+
+ This is a read-only system property and, at runtime, specifies the full path or URI of the folder currently open (if any).
+
+154. muttng_hcache_backend
+
+ Type: system property
+
+ Value: qdbm
+
+ This is a read-only system property and specifies the header chaching's database backend.
+
+155. muttng_pwd
+
+ Type: system property
+
+ Value:
+
+ This is a read-only system property and, at runtime, specifies the current working directory of the muttng binary.
+
+156. muttng_revision
+
+ Type: system property
+
+ Value: 473
+
+ This is a read-only system property and specifies muttng's subversion revision string.
+
+157. muttng_sysconfdir
+
+ Type: system property
+
+ Value: /opt/freebsd4/mutt-ng/etc
+
+ This is a read-only system property and specifies the directory containing the muttng system-wide configuration.
+
+158. muttng_version
+
+ Type: system property
+
+ Value: devel
+
+ This is a read-only system property and specifies muttng's version string.
+
+159. narrow_tree
+
+ Type: boolean
+
+ Default: no
+
+ This variable, when set, makes the thread tree narrower, allowing deeper threads to fit on the screen.
+
+160. nntp_ask_followup_to
+
+ Type: boolean
+
+ Default: no
+
+ Availability: NNTP
+
+ If set, Mutt-ng will prompt you for the Followup-To: header field before editing the body of an outgoing news article.
+
+161. nntp_ask_x_comment_to
+
+ Type: boolean
+
+ Default: no
+
+ Availability: NNTP
+
+ If set, Mutt-ng will prompt you for the X-Comment-To: header field before editing the body of an outgoing news article.
+
+162. nntp_cache_dir
+
+ Type: path
+
+ Default: "˜/.muttng"
+
+ Availability: NNTP
+
+ This variable points to directory where Mutt-ng will cache news article headers. If unset, headers will not be saved at all and will be reloaded each time when you enter a newsgroup.
+
+ As for the header caching in connection with IMAP and/or Maildir, this drastically increases speed and lowers traffic.
+
+163. nntp_catchup
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Availability: NNTP
+
+ If this variable is set, Mutt-ng will mark all articles in a newsgroup as read when you leaving it.
+
+164. nntp_context
+
+ Type: number
+
+ Default: 1000
+
+ Availability: NNTP
+
+ This variable controls how many news articles to cache per newsgroup (if caching is enabled, see $nntp_cache_dir) and how many news articles to show in the ``index'' menu.
+
+ If there're more articles than defined with $nntp_context, all older ones will be removed/not shown in the index.
+
+165. nntp_followup_to_poster
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Availability: NNTP
+
+ If this variable is set and the keyword "poster" is present in the Followup-To: header field, a follow-up to the newsgroup is not permitted. The message will be mailed to the submitter of the message via mail.
+
+166. nntp_group_index_format
+
+ Type: string
+
+ Default: "%4C %M%N %5s %-45.45f %d"
+
+ Availability: NNTP
+
+ This variable allows you to customize the newsgroup browser display to your personal taste. This string is similar to ``index_format'', but has its own set of printf(3)-like sequences:
+%C current newsgroup number
+%d description of newsgroup (retrieved from server)
+%f newsgroup name
+%M ``-'' if newsgroup not allowed for direct post (moderated for example)
+%N ``N'' if newsgroup is new, ``u'' if unsubscribed, blank otherwise
+%n number of new articles in newsgroup
+%s number of unread articles in newsgroup
+%>X right justify the rest of the string and pad with character "X"
+%|X pad to the end of the line with character "X"
+
+167. nntp_host
+
+ Type: string
+
+ Default: ""
+
+ Availability: NNTP
+
+ This variable specifies the name (or address) of the NNTP server to be used.
+
+ It defaults to the value specified via the environment variable $NNTPSERVER or contained in the file /etc/nntpserver.
+
+ You can also specify a username and an alternative port for each newsserver, e.g.
+
+ [nntp[s]://][username[:password]@]newsserver[:port]
+
+ Note: Using a password as shown and stored in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
+
+168. nntp_inews
+
+ Type: path
+
+ Default: ""
+
+ Availability: NNTP
+
+ If set, specifies the program and arguments used to deliver news posted by Mutt-ng. Otherwise, Mutt-ng posts article using current connection. The following printf(3)-style sequence is understood:
+%s newsserver name
+
+ Example: set inews="/usr/local/bin/inews -hS"
+
+169. nntp_load_description
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: NNTP
+
+ This variable controls whether or not descriptions for newsgroups are to be loaded when subscribing to a newsgroup.
+
+170. nntp_mail_check
+
+ Type: number
+
+ Default: 60
+
+ Availability: NNTP
+
+ The time in seconds until any operations on a newsgroup except posting a new article will cause a recheck for new news. If set to 0, Mutt-ng will recheck on each operation in index (stepping, read article, etc.).
+
+171. nntp_mime_subject
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: NNTP
+
+ If unset, an 8-bit ``Subject:'' header field in a news article will not be encoded according to RFC2047.
+
+ Note: Only change this setting if you know what you are doing.
+
+172. nntp_newsrc
+
+ Type: path
+
+ Default: "˜/.newsrc"
+
+ Availability: NNTP
+
+ This file contains information about subscribed newsgroup and articles read so far.
+
+ To ease the use of multiple news servers, the following printf(3)-style sequence is understood:
+%s newsserver name
+
+173. nntp_pass
+
+ Type: string
+
+ Default: ""
+
+ Availability: NNTP
+
+ Your password for NNTP account.
+
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
+
+174. nntp_post_moderated
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Availability: NNTP
+
+ If set to yes, Mutt-ng will post articles to newsgroup that have not permissions to post (e.g. moderated).
+
+ Note: if the newsserver does not support posting to that newsgroup or a group is totally read-only, that posting will not have any effect.
+
+175. nntp_reconnect
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ Availability: NNTP
+
+ Controls whether or not Mutt-ng will try to reconnect to a newsserver when the was connection lost.
+
+176. nntp_save_unsubscribed
+
+ Type: boolean
+
+ Default: no
+
+ Availability: NNTP
+
+ When set, info about unsubscribed newsgroups will be saved into the ``newsrc'' file and into the news cache.
+
+177. nntp_show_new_news
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: NNTP
+
+ If set, the newsserver will be asked for new newsgroups on entering the browser. Otherwise, it will be done only once for a newsserver. Also controls whether or not the number of new articles of subscribed newsgroups will be checked.
+
+178. nntp_show_only_unread
+
+ Type: boolean
+
+ Default: no
+
+ Availability: NNTP
+
+ If set, only subscribed newsgroups that contain unread articles will be displayed in the newsgroup browser.
+
+179. nntp_user
+
+ Type: string
+
+ Default: ""
+
+ Availability: NNTP
+
+ Your login name on the NNTP server. If unset and the server requires authentification, Mutt-ng will prompt you for your account name.
+
+180. nntp_x_comment_to
+
+ Type: boolean
+
+ Default: no
+
+ Availability: NNTP
+
+ If set, Mutt-ng will add a ``X-Comment-To:'' header field (that contains full name of the original article author) to articles that you followup to.
+
+181. operating_system
+
+ Type: string
+
+ Default: ""
+
+ This specifies the operating system name for the User-Agent: header field. If this is unset, it will be set to the operating system name that uname(2) returns. If uname(2) fails, ``UNIX'' will be used.
+
+ It may, for example, look as: ``mutt-ng 1.5.9i (Linux)''.
+
+182. pager
+
+ Type: path
+
+ Default: "builtin"
+
+ This variable specifies which pager you would like to use to view messages. ``builtin'' means to use the builtin pager, otherwise this variable should specify the pathname of the external pager you would like to use.
+
+ Using an external pager may have some disadvantages: Additional keystrokes are necessary because you can't call Mutt-ng functions directly from the pager, and screen resizes cause lines longer than the screen width to be badly formatted in the help menu.
+
+183. pager_context
+
+ Type: number
+
+ Default: 0
+
+ This variable controls the number of lines of context that are given when displaying the next or previous page in the internal pager. By default, Mutt-ng will display the line after the last one on the screen at the top of the next page (0 lines of context).
+
+184. pager_format
+
+ Type: string
+
+ Default: "-%Z- %C/%m: %-20.20n %s"
+
+ This variable controls the format of the one-line message ``status'' displayed before each message in either the internal or an external pager. The valid sequences are listed in the ``$index_format'' section.
+
+185. pager_index_lines
+
+ Type: number
+
+ Default: 0
+
+ Determines the number of lines of a mini-index which is shown when in the pager. The current message, unless near the top or bottom of the folder, will be roughly one third of the way down this mini-index, giving the reader the context of a few messages before and after the message. This is useful, for example, to determine how many messages remain to be read in the current thread. One of the lines is reserved for the status bar from the index, so a pager_index_lines of 6 will only show 5 lines of the actual index. A value of 0 results in no index being shown. If the number of messages in the current folder is less than pager_index_lines, then the index will only use as many lines as it needs.
+
+186. pager_stop
+
+ Type: boolean
+
+ Default: no
+
+ When set, the internal-pager will not move to the next message when you are at the end of a message and invoke the next-page function.
+
+187. pgp_auto_decode
+
+ Type: boolean
+
+ Default: no
+
+ If set, Mutt-ng will automatically attempt to decrypt traditional PGP messages whenever the user performs an operation which ordinarily would result in the contents of the message being operated on. For example, if the user displays a pgp-traditional message which has not been manually checked with the check-traditional-pgp function, Mutt-ng will automatically check the message for traditional pgp.
+
+188. pgp_autoinline
+
+ Type: boolean
+
+ Default: no
+
+ This option controls whether Mutt-ng generates old-style inline (traditional) PGP encrypted or signed messages under certain circumstances. This can be overridden by use of the pgp-menu, when inline is not required.
+
+ Note that Mutt-ng might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt-ng can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work. See also: ``$pgp_mime_auto''.
+
+ Also note that using the old-style PGP message format is strongly deprecated. (PGP only)
+
+189. pgp_check_exit
+
+ Type: boolean
+
+ Default: yes
+
+ If set, Mutt-ng will check the exit code of the PGP subprocess when signing or encrypting. A non-zero exit code means that the subprocess failed. (PGP only)
+
+190. pgp_clearsign_command
+
+ Type: string
+
+ Default: ""
+
+ This format is used to create a old-style ``clearsigned'' PGP message.
+
+ Note that the use of this format is strongly deprecated. (PGP only)
+
+191. pgp_decode_command
+
+ Type: string
+
+ Default: ""
+
+ This format strings specifies a command which is used to decode application/pgp attachments.
+
+ The PGP command formats have their own set of printf(3)-like sequences:
+
+ %p
+ Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string otherwise. Note: This may be used with a %? construct.
+
+ %f
+ Expands to the name of a file containing a message.
+
+ %s
+ Expands to the name of a file containing the signature part of a multipart/signed attachment when verifying it.
+
+ %a
+ The value of $pgp_sign_as.
+
+ %r
+ One or more key IDs.
+
+ For examples on how to configure these formats for the various versions of PGP which are floating around, see the pgp*.rc and gpg.rc files in the samples/ subdirectory which has been installed on your system alongside the documentation. (PGP only)
+
+192. pgp_decrypt_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to decrypt a PGP encrypted message. (PGP only)
+
+193. pgp_encrypt_only_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to encrypt a body part without signing it. (PGP only)
+
+194. pgp_encrypt_sign_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to both sign and encrypt a body part. (PGP only)
+
+195. pgp_entry_format
+
+ Type: string
+
+ Default: "%4n %t%f %4l/0x%k %-4a %2c %u"
+
+ This variable allows you to customize the PGP key selection menu to your personal taste. This string is similar to ``$index_format'', but has its own set of printf(3)-like sequences:
+
+ %n
+ number
+
+ %k
+ key id
+
+ %u
+ user id
+
+ %a
+ algorithm
+
+ %l
+ key length
+
+ %f
+ flags
+
+ %c
+ capabilities
+
+ %t
+ trust/validity of the key-uid association
+
+ %[<s>]
+ date of the key where <s> is an strftime(3) expression
+
+ (PGP only)
+
+196. pgp_export_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to export a public key from the user's key ring. (PGP only)
+
+197. pgp_getkeys_command
+
+ Type: string
+
+ Default: ""
+
+ This command is invoked whenever Mutt-ng will need public key information. %r is the only printf(3)-like sequence used with this format. (PGP only)
+
+198. pgp_good_sign
+
+ Type: regular expression
+
+ Default: ""
+
+ If you assign a text to this variable, then a PGP signature is only considered verified if the output from $pgp_verify_command contains the text. Use this variable if the exit code from the command is 0 even for bad signatures. (PGP only)
+
+199. pgp_ignore_subkeys
+
+ Type: boolean
+
+ Default: yes
+
+ Setting this variable will cause Mutt-ng to ignore OpenPGP subkeys. Instead, the principal key will inherit the subkeys' capabilities. Unset this if you want to play interesting key selection games. (PGP only)
+
+200. pgp_import_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to import a key from a message into the user's public key ring. (PGP only)
+
+201. pgp_list_pubring_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to list the public key ring's contents. The output format must be analogous to the one used by gpg --list-keys --with-colons.
+
+ This format is also generated by the pgpring utility which comes with Mutt-ng. (PGP only)
+
+202. pgp_list_secring_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to list the secret key ring's contents. The output format must be analogous to the one used by gpg --list-keys --with-colons.
+
+ This format is also generated by the pgpring utility which comes with Mutt-ng. (PGP only)
+
+203. pgp_long_ids
+
+ Type: boolean
+
+ Default: no
+
+ If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs. (PGP only)
+
+204. pgp_mime_auto
+
+ Type: quadoption
+
+ Default: ask-yes
+
+ This option controls whether Mutt-ng will prompt you for automatically sending a (signed/encrypted) message using PGP/MIME when inline (traditional) fails (for any reason).
+
+ Also note that using the old-style PGP message format is strongly deprecated. (PGP only)
+
+205. pgp_replyinline
+
+ Type: boolean
+
+ Default: no
+
+ Setting this variable will cause Mutt-ng to always attempt to create an inline (traditional) message when replying to a message which is PGP encrypted/signed inline. This can be overridden by use of the pgp-menu, when inline is not required. This option does not automatically detect if the (replied-to) message is inline; instead it relies on Mutt-ng internals for previously checked/flagged messages.
+
+ Note that Mutt-ng might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt-ng can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work. See also: ``$pgp_mime_auto''.
+
+ Also note that using the old-style PGP message format is strongly deprecated. (PGP only)
+
+206. pgp_retainable_sigs
+
+ Type: boolean
+
+ Default: no
+
+ If set, signed and encrypted messages will consist of nested multipart/signed and multipart/encrypted body parts.
+
+ This is useful for applications like encrypted and signed mailing lists, where the outer layer (multipart/encrypted) can be easily removed, while the inner multipart/signed part is retained. (PGP only)
+
+207. pgp_show_unusable
+
+ Type: boolean
+
+ Default: yes
+
+ If set, Mutt-ng will display non-usable keys on the PGP key selection menu. This includes keys which have been revoked, have expired, or have been marked as ``disabled'' by the user. (PGP only)
+
+208. pgp_sign_as
+
+ Type: string
+
+ Default: ""
+
+ If you have more than one key pair, this option allows you to specify which of your private keys to use. It is recommended that you use the keyid form to specify your key (e.g., ``0x00112233''). (PGP only)
+
+209. pgp_sign_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to create the detached PGP signature for a multipart/signed PGP/MIME body part. (PGP only)
+
+210. pgp_sort_keys
+
+ Type: sort order
+
+ Default: address
+
+ Specifies how the entries in the ``pgp keys'' menu are sorted. The following are legal values:
+
+ address
+ sort alphabetically by user id
+
+ keyid
+ sort alphabetically by key id
+
+ date
+ sort by key creation date
+
+ trust
+ sort by the trust of the key
+
+ If you prefer reverse order of the above values, prefix it with ``reverse-''. (PGP only)
+
+211. pgp_strict_enc
+
+ Type: boolean
+
+ Default: yes
+
+ If set, Mutt-ng will automatically encode PGP/MIME signed messages as quoted-printable. Please note that unsetting this variable may lead to problems with non-verifyable PGP signatures, so only change this if you know what you are doing. (PGP only)
+
+212. pgp_timeout
+
+ Type: number
+
+ Default: 300
+
+ The number of seconds after which a cached passphrase will expire if not used. Default: 300. (PGP only)
+
+213. pgp_use_gpg_agent
+
+ Type: boolean
+
+ Default: no
+
+ If set, Mutt-ng will use a possibly-running gpg-agent process. (PGP only)
+
+214. pgp_verify_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to verify PGP signatures. (PGP only)
+
+215. pgp_verify_key_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to verify key information from the key selection menu. (PGP only)
+
+216. pipe_decode
+
+ Type: boolean
+
+ Default: no
+
+ Used in connection with the pipe-message command. When unset, Mutt-ng will pipe the messages without any preprocessing. When set, Mutt-ng will weed headers and will attempt to PGP/MIME decode the messages first.
+
+217. pipe_sep
+
+ Type: string
+
+ Default: "\n"
+
+ The separator to add between messages when piping a list of tagged messages to an external Unix command.
+
+218. pipe_split
+
+ Type: boolean
+
+ Default: no
+
+ Used in connection with the pipe-message command and the ``tag- prefix'' or ``tag-prefix-cond'' operators. If this variable is unset, when piping a list of tagged messages Mutt-ng will concatenate the messages and will pipe them as a single folder. When set, Mutt-ng will pipe the messages one by one. In both cases the messages are piped in the current sorted order, and the ``$pipe_sep'' separator is added after each message.
+
+219. pop_auth_try_all
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: POP
+
+ If set, Mutt-ng will try all available methods. When unset, Mutt-ng will only fall back to other authentication methods if the previous methods are unavailable. If a method is available but authentication fails, Mutt-ng will not connect to the POP server.
+
+220. pop_authenticators
+
+ Type: string
+
+ Default: ""
+
+ Availability: POP
+
+ This is a colon-delimited list of authentication methods Mutt-ng may attempt to use to log in to an POP server, in the order Mutt-ng should try them. Authentication methods are either ``user'', ``apop'' or any SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.
+
+ This parameter is case-insensitive. If this parameter is unset (the default) Mutt-ng will try all available methods, in order from most-secure to least-secure.
+
+ Example: set pop_authenticators="digest-md5:apop:user"
+
+221. pop_delete
+
+ Type: quadoption
+
+ Default: ask-no
+
+ Availability: POP
+
+ If set, Mutt-ng will delete successfully downloaded messages from the POP server when using the ``fetch-mail'' function. When unset, Mutt-ng will download messages but also leave them on the POP server.
+
+222. pop_host
+
+ Type: string
+
+ Default: ""
+
+ Availability: POP
+
+ The name of your POP server for the ``fetch-mail'' function. You can also specify an alternative port, username and password, i.e.:
+
+ [pop[s]://][username[:password]@]popserver[:port]
+
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
+
+223. pop_last
+
+ Type: boolean
+
+ Default: no
+
+ Availability: POP
+
+ If this variable is set, Mutt-ng will try to use the ``LAST'' POP command for retrieving only unread messages from the POP server when using the ``fetch-mail'' function.
+
+224. pop_mail_check
+
+ Type: number
+
+ Default: 60
+
+ Availability: POP
+
+ This variable configures how often (in seconds) POP should look for new mail.
+
+225. pop_pass
+
+ Type: string
+
+ Default: ""
+
+ Availability: POP
+
+ Specifies the password for your POP account. If unset, Mutt-ng will prompt you for your password when you open POP mailbox.
+
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
+
+226. pop_reconnect
- 6\b6.\b.3\b3.\b.1\b17\b76\b6.\b. s\bsm\bmi\bim\bme\be_\b_k\bke\bey\bys\bs
+ Type: quadoption
- Type: path
- Default: ""
+ Default: ask-yes
- Since there is no pubring/secring as with PGP, mutt has to handle
- storage ad retrieval of keys/certs by itself. This is very basic right
- now, and stores keys and certificates in two different directories,
- both named as the hash-value retrieved from OpenSSL. There is an index
- file which contains mailbox-address keyid pair, and which can be
- manually edited. This one points to the location of the private keys.
- (S/MIME only)
+ Availability: POP
- 6\b6.\b.3\b3.\b.1\b17\b77\b7.\b. s\bsm\bmi\bim\bme\be_\b_c\bca\ba_\b_l\blo\boc\bca\bat\bti\bio\bon\bn
+ Controls whether or not Mutt-ng will try to reconnect to a POP server when the connection is lost.
- Type: path
- Default: ""
+227. pop_user
- This variable contains the name of either a directory, or a file which
- contains trusted certificates for use with OpenSSL. (S/MIME only)
+ Type: string
- 6\b6.\b.3\b3.\b.1\b17\b78\b8.\b. s\bsm\bmi\bim\bme\be_\b_c\bce\ber\brt\bti\bif\bfi\bic\bca\bat\bte\bes\bs
+ Default: ""
- Type: path
- Default: ""
+ Availability: POP
- Since there is no pubring/secring as with PGP, mutt has to handle
- storage and retrieval of keys by itself. This is very basic right now,
- and keys and certificates are stored in two different directories,
- both named as the hash-value retrieved from OpenSSL. There is an index
- file which contains mailbox-address keyid pairs, and which can be
- manually edited. This one points to the location of the certificates.
- (S/MIME only)
+ Your login name on the POP server.
- 6\b6.\b.3\b3.\b.1\b17\b79\b9.\b. s\bsm\bmi\bim\bme\be_\b_d\bde\bec\bcr\bry\byp\bpt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ This variable defaults to your user name on the local machine.
- Type: string
- Default: ""
+228. post_indent_string
- This format string specifies a command which is used to decrypt
- application/x-pkcs7-mime attachments.
+ Type: string
- The OpenSSL command formats have their own set of printf-like
- sequences similar to PGP's:
- %\b%f\bf Expands to the name of a file containing a message.
+ Default: ""
- %\b%s\bs Expands to the name of a file containing the signature part of a
- multipart/signed attachment when verifying it.
+ Similar to the ``$attribution'' variable, Mutt-ng will append this string after the inclusion of a message which is being replied to.
- %\b%k\bk The key-pair specified with ``$smime_default_key''
+229. postpone
- %\b%c\bc One or more certificate IDs.
+ Type: quadoption
- %\b%a\ba The algorithm used for encryption.
+ Default: ask-yes
- %\b%C\bC CA location: Depending on whether ``$smime_ca_location'' points
- to a directory or file, this expands to "-CApath
- ``$smime_ca_location''" or "-CAfile ``$smime_ca_location''".
+ Controls whether or not messages are saved in the ``$postponed'' mailbox when you elect not to send immediately.
- For examples on how to configure these formats, see the smime.rc in
- the samples/ subdirectory which has been installed on your system
- alongside the documentation. (S/MIME only)
+230. postponed
- 6\b6.\b.3\b3.\b.1\b18\b80\b0.\b. s\bsm\bmi\bim\bme\be_\b_v\bve\ber\bri\bif\bfy\by_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Type: path
- Type: string
- Default: ""
+ Default: "˜/postponed"
- This command is used to verify S/MIME signatures of type
- multipart/signed. (S/MIME only)
+ Mutt-ng allows you to indefinitely ``postpone sending a message'' which you are editing. When you choose to postpone a message, Mutt-ng saves it in the mailbox specified by this variable. Also see the ``$postpone'' variable.
- 6\b6.\b.3\b3.\b.1\b18\b81\b1.\b. s\bsm\bmi\bim\bme\be_\b_v\bve\ber\bri\bif\bfy\by_\b_o\bop\bpa\baq\bqu\bue\be_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+231. preconnect
- Type: string
- Default: ""
+ Type: string
- This command is used to verify S/MIME signatures of type
- application/x-pkcs7-mime. (S/MIME only)
+ Default: ""
- 6\b6.\b.3\b3.\b.1\b18\b82\b2.\b. s\bsm\bmi\bim\bme\be_\b_s\bsi\big\bgn\bn_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ If set, a shell command to be executed if Mutt-ng fails to establish a connection to the server. This is useful for setting up secure connections, e.g. with ssh(1). If the command returns a nonzero status, Mutt-ng gives up opening the server. Example:
- Type: string
- Default: ""
+ preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 < /dev/null > /dev/null"
- This command is used to created S/MIME signatures of type
- multipart/signed, which can be read by all mail clients. (S/MIME
- only)
+ Mailbox ``foo'' on mailhost.net can now be reached as ``{localhost:1234}foo''.
- 6\b6.\b.3\b3.\b.1\b18\b83\b3.\b. s\bsm\bmi\bim\bme\be_\b_s\bsi\big\bgn\bn_\b_o\bop\bpa\baq\bqu\bue\be_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Note: For this example to work, you must be able to log in to the remote machine without having to enter a password.
- Type: string
- Default: ""
+232. print
- This command is used to created S/MIME signatures of type
- application/x-pkcs7-signature, which can only be handled by mail
- clients supporting the S/MIME extension. (S/MIME only)
+ Type: quadoption
- 6\b6.\b.3\b3.\b.1\b18\b84\b4.\b. s\bsm\bmi\bim\bme\be_\b_e\ben\bnc\bcr\bry\byp\bpt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: ask-no
- Type: string
- Default: ""
+ Controls whether or not Mutt-ng really prints messages. This is set to ask-no by default, because some people accidentally hit ``p'' often.
- This command is used to create encrypted S/MIME messages. (S/MIME
- only)
+233. print_command
- 6\b6.\b.3\b3.\b.1\b18\b85\b5.\b. s\bsm\bmi\bim\bme\be_\b_p\bpk\bk7\b7o\bou\but\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Type: path
- Type: string
- Default: ""
+ Default: "lpr"
- This command is used to extract PKCS7 structures of S/MIME signatures,
- in order to extract the public X509 certificate(s). (S/MIME only)
+ This specifies the command pipe that should be used to print messages.
- 6\b6.\b.3\b3.\b.1\b18\b86\b6.\b. s\bsm\bmi\bim\bme\be_\b_g\bge\bet\bt_\b_c\bce\ber\brt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+234. print_decode
- Type: string
- Default: ""
+ Type: boolean
- This command is used to extract X509 certificates from a PKCS7
- structure. (S/MIME only)
+ Default: yes
- 6\b6.\b.3\b3.\b.1\b18\b87\b7.\b. s\bsm\bmi\bim\bme\be_\b_g\bge\bet\bt_\b_s\bsi\big\bgn\bne\ber\br_\b_c\bce\ber\brt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Used in connection with the print-message command. If this option is set, the message is decoded before it is passed to the external command specified by $print_command. If this option is unset, no processing will be applied to the message when printing it. The latter setting may be useful if you are using some advanced printer filter which is able to properly format e-mail messages for printing.
- Type: string
- Default: ""
+235. print_split
- This command is used to extract only the signers X509 certificate from
- a S/MIME signature, so that the certificate's owner may get compared
- to the email's (S/MIME only)
+ Type: boolean
- 6\b6.\b.3\b3.\b.1\b18\b88\b8.\b. s\bsm\bmi\bim\bme\be_\b_i\bim\bmp\bpo\bor\brt\bt_\b_c\bce\ber\brt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: no
- Type: string
- Default: ""
+ Used in connection with the print-message command. If this option is set, the command specified by $print_command is executed once for each message which is to be printed. If this option is unset, the command specified by $print_command is executed only once, and all the messages are concatenated, with a form feed as the message separator.
- This command is used to import a certificate via smime_keys. (S/MIME
- only)
+ Those who use the enscript(1) program's mail-printing mode will most likely want to set this option.
- 6\b6.\b.3\b3.\b.1\b18\b89\b9.\b. s\bsm\bmi\bim\bme\be_\b_g\bge\bet\bt_\b_c\bce\ber\brt\bt_\b_e\bem\bma\bai\bil\bl_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+236. prompt_after
- Type: string
- Default: ""
+ Type: boolean
- This command is used to extract the mail address(es) used for storing
- X509 certificates, and for verification purposes (to check whether the
- certificate was issued for the sender's mailbox). (S/MIME only)
+ Default: yes
- 6\b6.\b.3\b3.\b.1\b19\b90\b0.\b. s\bsm\bmi\bim\bme\be_\b_d\bde\bef\bfa\bau\bul\blt\bt_\b_k\bke\bey\by
+ If you use an external ``$pager'', setting this variable will cause Mutt-ng to prompt you for a command when the pager exits rather than returning to the index menu. If unset, Mutt-ng will return to the index menu when the external pager exits.
- Type: string
- Default: ""
+237. query_command
- This is the default key-pair to use for signing. This must be set to
- the keyid (the hash-value that OpenSSL generates) to work properly
- (S/MIME only)
+ Type: path
- 6\b6.\b.3\b3.\b.1\b19\b91\b1.\b. s\bss\bsl\bl_\b_s\bst\bta\bar\brt\btt\btl\bls\bs
+ Default: ""
- Type: quadoption
- Default: yes
+ This specifies the command that Mutt-ng will use to make external address queries. The string should contain a %s, which will be substituted with the query string the user types. See ``query'' for more information.
- If set (the default), mutt will attempt to use STARTTLS on servers
- advertising the capability. When unset, mutt will not attempt to use
- STARTTLS regardless of the server's capabilities.
+238. quit
- 6\b6.\b.3\b3.\b.1\b19\b92\b2.\b. c\bce\ber\brt\bti\bif\bfi\bic\bca\bat\bte\be_\b_f\bfi\bil\ble\be
+ Type: quadoption
- Type: path
- Default: ""
+ Default: yes
- This variable specifies the file where the certificates you trust are
- saved. When an unknown certificate is encountered, you are asked if
- you accept it or not. If you accept it, the certificate can also be
- saved in this file and further connections are automatically accepted.
+ This variable controls whether ``quit'' and ``exit'' actually quit from Mutt-ng. If it set to yes, they do quit, if it is set to no, they have no effect, and if it is set to ask-yes or ask-no, you are prompted for confirmation when you try to quit.
- You can also manually add CA certificates in this file. Any server
- certificate that is signed with one of these CA certificates are also
- automatically accepted.
+239. quote_empty
- Example: set certificate_file=~/.mutt/certificates
+ Type: boolean
- 6\b6.\b.3\b3.\b.1\b19\b93\b3.\b. s\bss\bsl\bl_\b_u\bus\bse\bes\bsy\bys\bst\bte\bem\bmc\bce\ber\brt\bts\bs
+ Default: yes
- Type: boolean
- Default: yes
+ Controls whether or not empty lines will be quoted using ``indent_string''.
- If set to _\by_\be_\bs, mutt will use CA certificates in the system-wide
- certificate store when checking if server certificate is signed by a
- trusted CA.
+240. quote_quoted
- 6\b6.\b.3\b3.\b.1\b19\b94\b4.\b. e\ben\bnt\btr\bro\bop\bpy\by_\b_f\bfi\bil\ble\be
+ Type: boolean
- Type: path
- Default: ""
+ Default: no
- The file which includes random data that is used to initialize SSL
- library functions.
+ Controls how quoted lines will be quoted. If set, one quote character will be added to the end of existing prefix. Otherwise, quoted lines will be prepended by ``indent_string''.
- 6\b6.\b.3\b3.\b.1\b19\b95\b5.\b. s\bss\bsl\bl_\b_u\bus\bse\be_\b_s\bss\bsl\blv\bv2\b2
+241. quote_regexp
- Type: boolean
- Default: yes
+ Type: regular expression
- This variables specifies whether to attempt to use SSLv2 in the SSL
- authentication process.
+ Default: "^([ \t]*[|>:}#])+"
- 6\b6.\b.3\b3.\b.1\b19\b96\b6.\b. s\bss\bsl\bl_\b_u\bus\bse\be_\b_s\bss\bsl\blv\bv3\b3
+ A regular expression used in the internal-pager to determine quoted sections of text in the body of a message.
- Type: boolean
- Default: yes
+ Note: In order to use the quotedx patterns in the internal pager, you need to set this to a regular expression that matches exactly the quote characters at the beginning of quoted lines.
- This variables specifies whether to attempt to use SSLv3 in the SSL
- authentication process.
+242. read_inc
- 6\b6.\b.3\b3.\b.1\b19\b97\b7.\b. s\bss\bsl\bl_\b_u\bus\bse\be_\b_t\btl\bls\bsv\bv1\b1
+ Type: number
- Type: boolean
- Default: yes
+ Default: 10
- This variables specifies whether to attempt to use TLSv1 in the SSL
- authentication process.
+ If set to a value greater than 0, Mutt-ng will display which message it is currently on when reading a mailbox. The message is printed after read_inc messages have been read (e.g., if set to 25, Mutt-ng will print a message when it reads message 25, and then again when it gets to message 50). This variable is meant to indicate progress when reading large mailboxes which may take some time. When set to 0, only a single message will appear before the reading the mailbox.
- 6\b6.\b.3\b3.\b.1\b19\b98\b8.\b. p\bpi\bip\bpe\be_\b_s\bsp\bpl\bli\bit\bt
+ Also see the ``$write_inc'' variable.
- Type: boolean
- Default: no
+243. read_only
- Used in connection with the _\bp_\bi_\bp_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be command and the ``tag-
- prefix'' operator. If this variable is unset, when piping a list of
- tagged messages Mutt will concatenate the messages and will pipe them
- as a single folder. When set, Mutt will pipe the messages one by one.
- In both cases the messages are piped in the current sorted order, and
- the ````$pipe_sep'''' separator is added after each message.
+ Type: boolean
- 6\b6.\b.3\b3.\b.1\b19\b99\b9.\b. p\bpi\bip\bpe\be_\b_d\bde\bec\bco\bod\bde\be
+ Default: no
- Type: boolean
- Default: no
+ If set, all folders are opened in read-only mode.
- Used in connection with the _\bp_\bi_\bp_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be command. When unset, Mutt
- will pipe the messages without any preprocessing. When set, Mutt will
- weed headers and will attempt to PGP/MIME decode the messages first.
+244. realname
- 6\b6.\b.3\b3.\b.2\b20\b00\b0.\b. p\bpi\bip\bpe\be_\b_s\bse\bep\bp
+ Type: string
- Type: string
- Default: "\n"
+ Default: ""
- The separator to add between messages when piping a list of tagged
- messages to an external Unix command.
+ This variable specifies what ``real'' or ``personal'' name should be used when sending messages.
- 6\b6.\b.3\b3.\b.2\b20\b01\b1.\b. p\bpo\bop\bp_\b_a\bau\but\bth\bhe\ben\bnt\bti\bic\bca\bat\bto\bor\brs\bs
+ By default, this is the GECOS field from /etc/passwd.
- Type: string
- Default: ""
+ Note: This variable will not be used when the user has set a real name in the $from variable.
- This is a colon-delimited list of authentication methods mutt may
- attempt to use to log in to an POP server, in the order mutt should
- try them. Authentication methods are either 'user', 'apop' or any
- SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'. This
- parameter is case-insensitive. If this parameter is unset (the
- default) mutt will try all available methods, in order from most-
- secure to least-secure.
+245. recall
- Example: set pop_authenticators="digest-md5:apop:user"
+ Type: quadoption
- 6\b6.\b.3\b3.\b.2\b20\b02\b2.\b. p\bpo\bop\bp_\b_a\bau\but\bth\bh_\b_t\btr\bry\by_\b_a\bal\bll\bl
+ Default: ask-yes
- Type: boolean
- Default: yes
+ Controls whether or not Mutt-ng recalls postponed messages when composing a new message. Also see ``$postponed''.
- If set, Mutt will try all available methods. When unset, Mutt will
- only fall back to other authentication methods if the previous methods
- are unavailable. If a method is available but authentication fails,
- Mutt will not connect to the POP server.
+ Setting this variable to yes is not generally useful, and thus not recommended.
- 6\b6.\b.3\b3.\b.2\b20\b03\b3.\b. p\bpo\bop\bp_\b_c\bch\bhe\bec\bck\bki\bin\bnt\bte\ber\brv\bva\bal\bl
+246. record
- Type: number
- Default: 60
+ Type: path
- This variable configures how often (in seconds) POP should look for
- new mail.
+ Default: ""
- 6\b6.\b.3\b3.\b.2\b20\b04\b4.\b. p\bpo\bop\bp_\b_d\bde\bel\ble\bet\bte\be
+ This specifies the file into which your outgoing messages should be appended. (This is meant as the primary method for saving a copy of your messages, but another way to do this is using the ``my_hdr'' command to create a Bcc: header field with your email address in it.)
- Type: quadoption
- Default: ask-no
+ The value of $record is overridden by the ``$force_name'' and ``$save_name'' variables, and the ``fcc-hook'' command.
- If set, Mutt will delete successfully downloaded messages from the POP
- server when using the fetch-mail function. When unset, Mutt will
- download messages but also leave them on the POP server.
+247. reply_regexp
- 6\b6.\b.3\b3.\b.2\b20\b05\b5.\b. p\bpo\bop\bp_\b_h\bho\bos\bst\bt
+ Type: regular expression
- Type: string
- Default: ""
+ Default: "^(re([\[0-9\]+])*|aw):[ \t]*"
- The name of your POP server for the fetch-mail function. You can also
- specify an alternative port, username and password, ie:
+ A regular expression used to recognize reply messages when threading and replying. The default value corresponds to the English ``Re:'' and the German ``Aw:''.
- [pop[s]://][username[:password]@]popserver[:port]
+248. reply_self
- 6\b6.\b.3\b3.\b.2\b20\b06\b6.\b. p\bpo\bop\bp_\b_l\bla\bas\bst\bt
+ Type: boolean
- Type: boolean
- Default: no
+ Default: no
- If this variable is set, mutt will try to use the "LAST" POP command
- for retrieving only unread messages from the POP server when using the
- fetch-mail function.
+ If unset and you are replying to a message sent by you, Mutt-ng will assume that you want to reply to the recipients of that message rather than to yourself.
- 6\b6.\b.3\b3.\b.2\b20\b07\b7.\b. p\bpo\bop\bp_\b_r\bre\bec\bco\bon\bnn\bne\bec\bct\bt
+249. reply_to
- Type: quadoption
- Default: ask-yes
+ Type: quadoption
- Controls whether or not Mutt will try to reconnect to POP server when
- connection lost.
+ Default: ask-yes
- 6\b6.\b.3\b3.\b.2\b20\b08\b8.\b. p\bpo\bop\bp_\b_u\bus\bse\ber\br
+ If set, when replying to a message, Mutt-ng will use the address listed in the ``Reply-To:'' header field as the recipient of the reply. If unset, it will use the address in the ``From:'' header field instead.
- Type: string
- Default: ""
+ This option is useful for reading a mailing list that sets the ``Reply-To:'' header field to the list address and you want to send a private message to the author of a message.
- Your login name on the POP server.
+250. resolve
- This variable defaults to your user name on the local machine.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b20\b09\b9.\b. p\bpo\bop\bp_\b_p\bpa\bas\bss\bs
+ Default: yes
- Type: string
- Default: ""
+ When set, the cursor will be automatically advanced to the next (possibly undeleted) message whenever a command that modifies the current message is executed.
- Specifies the password for your POP account. If unset, Mutt will
- prompt you for your password when you open POP mailbox. W\bWa\bar\brn\bni\bin\bng\bg: you
- should only use this option when you are on a fairly secure machine,
- because the superuser can read your muttrc even if you are the only
- one who can read the file.
+251. reverse_alias
- 6\b6.\b.3\b3.\b.2\b21\b10\b0.\b. p\bpo\bos\bst\bt_\b_i\bin\bnd\bde\ben\bnt\bt_\b_s\bst\btr\bri\bin\bng\bg
+ Type: boolean
- Type: string
- Default: ""
+ Default: no
- Similar to the ````$attribution'''' variable, Mutt will append this
- string after the inclusion of a message which is being replied to.
+ This variable controls whether or not Mutt-ng will display the ``personal'' name from your aliases in the index menu if it finds an alias that matches the message's sender. For example, if you have the following alias:
- 6\b6.\b.3\b3.\b.2\b21\b11\b1.\b. p\bpo\bos\bst\bt_\b_m\bmo\bod\bde\ber\bra\bat\bte\bed\bd
+ alias juser abd30425@somewhere.net (Joe User)
- Type: quadoption
- Default: ask-yes
+ and then you receive mail which contains the following header:
- If set to _\by_\be_\bs, Mutt will post article to newsgroup that have not
- permissions to posting (e.g. moderated). N\bNo\bot\bte\be:\b: if newsserver does not
- support posting to that newsgroup or totally read-only, that posting
- will not have an effect.
+ From: abd30425@somewhere.net
- 6\b6.\b.3\b3.\b.2\b21\b12\b2.\b. p\bpo\bos\bst\btp\bpo\bon\bne\be
+ It would be displayed in the index menu as ``Joe User'' instead of ``abd30425@somewhere.net.'' This is useful when the person's e-mail address is not human friendly (like CompuServe addresses).
- Type: quadoption
- Default: ask-yes
+252. reverse_name
- Controls whether or not messages are saved in the ````$postponed''''
- mailbox when you elect not to send immediately.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b21\b13\b3.\b. p\bpo\bos\bst\btp\bpo\bon\bne\bed\bd
+ Default: no
- Type: path
- Default: "~/postponed"
+ It may sometimes arrive that you receive mail to a certain machine, move the messages to another machine, and reply to some the messages from there. If this variable is set, the default From: line of the reply messages is built using the address where you received the messages you are replying to if that address matches your alternates. If the variable is unset, or the address that would be used doesn't match your alternates, the From: line will use your address on the current machine.
- Mutt allows you to indefinitely ````postpone'' sending a message''
- which you are editing. When you choose to postpone a message, Mutt
- saves it in the mailbox specified by this variable. Also see the
- ````$postpone'''' variable.
+253. reverse_realname
- 6\b6.\b.3\b3.\b.2\b21\b14\b4.\b. p\bpr\bre\bec\bco\bon\bnn\bne\bec\bct\bt
+ Type: boolean
- Type: string
- Default: ""
+ Default: yes
- If set, a shell command to be executed if mutt fails to establish a
- connection to the server. This is useful for setting up secure
- connections, e.g. with ssh(1). If the command returns a nonzero
- status, mutt gives up opening the server. Example:
+ This variable fine-tunes the behaviour of the reverse_name feature. When it is set, Mutt-ng will use the address from incoming messages as-is, possibly including eventual real names. When it is unset, Mutt-ng will override any such real names with the setting of the realname variable.
- preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net sleep 20 <
- /dev/null > /dev/null"
+254. rfc2047_parameters
- Mailbox 'foo' on mailhost.net can now be reached as
- '{localhost:1234}foo'.
+ Type: boolean
- NOTE: For this example to work, you must be able to log in to the
- remote machine without having to enter a password.
+ Default: no
- 6\b6.\b.3\b3.\b.2\b21\b15\b5.\b. p\bpr\bri\bin\bnt\bt
+ When this variable is set, Mutt-ng will decode RFC-2047-encoded MIME parameters. You want to set this variable when Mutt-ng suggests you to save attachments to files named like this:
- Type: quadoption
- Default: ask-no
+ =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
- Controls whether or not Mutt asks for confirmation before printing.
- This is useful for people (like me) who accidentally hit ``p'' often.
+ When this variable is set interactively, the change doesn't have the desired effect before you have changed folders.
- 6\b6.\b.3\b3.\b.2\b21\b16\b6.\b. p\bpr\bri\bin\bnt\bt_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Note that this use of RFC 2047's encoding is explicitly, prohibited by the standard, but nevertheless encountered in the wild.
- Type: path
- Default: "lpr"
+ Also note that setting this parameter will not have the effect that Mutt-ng generates this kind of encoding. Instead, Mutt-ng will unconditionally use the encoding specified in RFC 2231.
- This specifies the command pipe that should be used to print messages.
+255. save_address
- 6\b6.\b.3\b3.\b.2\b21\b17\b7.\b. p\bpr\bri\bin\bnt\bt_\b_d\bde\bec\bco\bod\bde\be
+ Type: boolean
- Type: boolean
- Default: yes
+ Default: no
- Used in connection with the print-message command. If this option is
- set, the message is decoded before it is passed to the external
- command specified by ``$print_command''. If this option is unset, no
- processing will be applied to the message when printing it. The
- latter setting may be useful if you are using some advanced printer
- filter which is able to properly format e-mail messages for printing.
+ If set, Mutt-ng will take the sender's full address when choosing a default folder for saving a mail. If ``$save_name'' or ``$force_name'' is set too, the selection of the fcc folder will be changed as well.
- 6\b6.\b.3\b3.\b.2\b21\b18\b8.\b. p\bpr\bri\bin\bnt\bt_\b_s\bsp\bpl\bli\bit\bt
+256. save_empty
- Type: boolean
- Default: no
+ Type: boolean
- Used in connection with the print-message command. If this option is
- set, the command specified by ``$print_command'' is executed once for
- each message which is to be printed. If this option is unset, the
- command specified by ``$print_command'' is executed only once, and all
- the messages are concatenated, with a form feed as the message
- separator.
+ Default: yes
- Those who use the e\ben\bns\bsc\bcr\bri\bip\bpt\bt(1) program's mail-printing mode will most
- likely want to set this option.
+ When unset, mailboxes which contain no saved messages will be removed when closed (the exception is ``$spoolfile'' which is never removed). If set, mailboxes are never removed.
- 6\b6.\b.3\b3.\b.2\b21\b19\b9.\b. p\bpr\bro\bom\bmp\bpt\bt_\b_a\baf\bft\bte\ber\br
+ Note: This only applies to mbox and MMDF folders, Mutt-ng does not delete MH and Maildir directories.
- Type: boolean
- Default: yes
+257. save_name
- If you use an _\be_\bx_\bt_\be_\br_\bn_\ba_\bl ````$pager'''', setting this variable will
- cause Mutt to prompt you for a command when the pager exits rather
- than returning to the index menu. If unset, Mutt will return to the
- index menu when the external pager exits.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b22\b20\b0.\b. q\bqu\bue\ber\bry\by_\b_c\bco\bom\bmm\bma\ban\bnd\bd
+ Default: no
- Type: path
- Default: ""
+ This variable controls how copies of outgoing messages are saved. When set, a check is made to see if a mailbox specified by the recipient address exists (this is done by searching for a mailbox in the ``$folder'' directory with the username part of the recipient address). If the mailbox exists, the outgoing message will be saved to that mailbox, otherwise the message is saved to the ``$record'' mailbox.
- This specifies the command that mutt will use to make external address
- queries. The string should contain a %s, which will be substituted
- with the query string the user types. See ````query'''' for more
- information.
+ Also see the ``$force_name'' variable.
- 6\b6.\b.3\b3.\b.2\b22\b21\b1.\b. q\bqu\bui\bit\bt
+258. score
- Type: quadoption
- Default: yes
+ Type: boolean
- This variable controls whether ``quit'' and ``exit'' actually quit
- from mutt. If it set to yes, they do quit, if it is set to no, they
- have no effect, and if it is set to ask-yes or ask-no, you are
- prompted for confirmation when you try to quit.
+ Default: yes
- 6\b6.\b.3\b3.\b.2\b22\b22\b2.\b. q\bqu\buo\bot\bte\be_\b_r\bre\beg\bge\bex\bxp\bp
+ When this variable is unset, scoring is turned off. This can be useful to selectively disable scoring for certain folders when the ``$score_threshold_delete'' variable and friends are used.
- Type: regular expression
- Default: "^([ \t]*[|>:}#])+"
+259. score_threshold_delete
- A regular expression used in the internal-pager to determine quoted
- sections of text in the body of a message.
+ Type: number
- N\bNo\bot\bte\be:\b: In order to use the _\bq_\bu_\bo_\bt_\be_\bdx\bx patterns in the internal pager, you
- need to set this to a regular expression that matches _\be_\bx_\ba_\bc_\bt_\bl_\by the
- quote characters at the beginning of quoted lines.
+ Default: -1
- 6\b6.\b.3\b3.\b.2\b22\b23\b3.\b. r\bre\bea\bad\bd_\b_i\bin\bnc\bc
+ Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked for deletion by Mutt-ng. Since Mutt-ng scores are always greater than or equal to zero, the default setting of this variable will never mark a message for deletion.
- Type: number
- Default: 10
+260. score_threshold_flag
- If set to a value greater than 0, Mutt will display which message it
- is currently on when reading a mailbox. The message is printed after
- _\br_\be_\ba_\bd_\b__\bi_\bn_\bc messages have been read (e.g., if set to 25, Mutt will print
- a message when it reads message 25, and then again when it gets to
- message 50). This variable is meant to indicate progress when reading
- large mailboxes which may take some time. When set to 0, only a
- single message will appear before the reading the mailbox.
+ Type: number
- Also see the ````$write_inc'''' variable.
+ Default: 9999
- 6\b6.\b.3\b3.\b.2\b22\b24\b4.\b. r\bre\bea\bad\bd_\b_o\bon\bnl\bly\by
+ Messages which have been assigned a score greater than or equal to this variable's value are automatically marked ``flagged''.
- Type: boolean
- Default: no
+261. score_threshold_read
- If set, all folders are opened in read-only mode.
+ Type: number
- 6\b6.\b.3\b3.\b.2\b22\b25\b5.\b. r\bre\bea\bal\bln\bna\bam\bme\be
+ Default: -1
- Type: string
- Default: ""
+ Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked as read by Mutt-ng. Since Mutt-ng scores are always greater than or equal to zero, the default setting of this variable will never mark a message read.
- This variable specifies what "real" or "personal" name should be used
- when sending messages.
+262. send_charset
- By default, this is the GECOS field from /etc/passwd. Note that this
- variable will _\bn_\bo_\bt be used when the user has set a real name in the
- ``$from'' variable.
+ Type: string
- 6\b6.\b.3\b3.\b.2\b22\b26\b6.\b. r\bre\bec\bca\bal\bll\bl
+ Default: "us-ascii:iso-8859-1:utf-8"
- Type: quadoption
- Default: ask-yes
+ A list of character sets for outgoing messages. Mutt-ng will use the first character set into which the text can be converted exactly. If your ``$charset'' is not iso-8859-1 and recipients may not understand UTF-8, it is advisable to include in the list an appropriate widely used standard character set (such as iso-8859-2, koi8-r or iso-2022-jp) either instead of or after iso-8859-1.
- Controls whether or not you are prompted to recall postponed messages
- when composing a new message. Also see ````$postponed''''.
+263. sendmail
- Setting this variable to ``yes'' is not generally useful, and thus not
- recommended.
+ Type: path
- 6\b6.\b.3\b3.\b.2\b22\b27\b7.\b. r\bre\bec\bco\bor\brd\bd
+ Default: "/usr/sbin/sendmail -oem -oi"
- Type: path
- Default: ""
+ Specifies the program and arguments used to deliver mail sent by Mutt-ng. Mutt-ng expects that the specified program interprets additional arguments as recipient addresses.
- This specifies the file into which your outgoing messages should be
- appended. (This is meant as the primary method for saving a copy of
- your messages, but another way to do this is using the ````my_hdr''''
- command to create a _\bB_\bc_\bc_\b: field with your email address in it.)
+264. sendmail_wait
- The value of _\b`_\b`_\b$_\br_\be_\bc_\bo_\br_\bd_\b'_\b' is overridden by the ````$force_name'''' and
- ````$save_name'''' variables, and the ````fcc-hook'''' command.
+ Type: number
- 6\b6.\b.3\b3.\b.2\b22\b28\b8.\b. r\bre\bep\bpl\bly\by_\b_r\bre\beg\bge\bex\bxp\bp
+ Default: 0
- Type: regular expression
- Default: "^(re([\[0-9\]+])*|aw):[ \t]*"
+ Specifies the number of seconds to wait for the ``$sendmail'' process to finish before giving up and putting delivery in the background.
- A regular expression used to recognize reply messages when threading
- and replying. The default value corresponds to the English "Re:" and
- the German "Aw:".
+ Mutt-ng interprets the value of this variable as follows:
- 6\b6.\b.3\b3.\b.2\b22\b29\b9.\b. r\bre\bep\bpl\bly\by_\b_s\bse\bel\blf\bf
+ >0
+ number of seconds to wait for sendmail to finish before continuing
- Type: boolean
- Default: no
+ 0
+ wait forever for sendmail to finish
- If unset and you are replying to a message sent by you, Mutt will
- assume that you want to reply to the recipients of that message rather
- than to yourself.
- 6\b6.\b.3\b3.\b.2\b23\b30\b0.\b. r\bre\bep\bpl\bly\by_\b_t\bto\bo
+ <0
+ always put sendmail in the background without waiting
- Type: quadoption
- Default: ask-yes
+ Note that if you specify a value other than 0, the output of the child process will be put in a temporary file. If there is some error, you will be informed as to where to find the output.
- If set, Mutt will ask you if you want to use the address listed in the
- Reply-To: header field when replying to a message. If you answer no,
- it will use the address in the From: header field instead. This
- option is useful for reading a mailing list that sets the Reply-To:
- header field to the list address and you want to send a private
- message to the author of a message.
+265. shell
- 6\b6.\b.3\b3.\b.2\b23\b31\b1.\b. r\bre\bes\bso\bol\blv\bve\be
+ Type: path
- Type: boolean
- Default: yes
+ Default: ""
- When set, the cursor will be automatically advanced to the next
- (possibly undeleted) message whenever a command that modifies the
- current message is executed.
+ Command to use when spawning a subshell. By default, the user's login shell from /etc/passwd is used.
- 6\b6.\b.3\b3.\b.2\b23\b32\b2.\b. r\bre\bev\bve\ber\brs\bse\be_\b_a\bal\bli\bia\bas\bs
+266. sidebar_boundary
- Type: boolean
- Default: no
+ Type: string
- This variable controls whether or not Mutt will display the "personal"
- name from your aliases in the index menu if it finds an alias that
- matches the message's sender. For example, if you have the following
- alias:
+ Default: "."
- alias juser abd30425@somewhere.net (Joe User)
+ When the sidebar is displayed and $sidebar_shorten_hierarchy is set, this variable specifies the characters at which to split a folder name into ``hierarchy items.''
- and then you receive mail which contains the following header:
+267. sidebar_delim
- From: abd30425@somewhere.net
+ Type: string
- It would be displayed in the index menu as ``Joe User'' instead of
- ``abd30425@somewhere.net.'' This is useful when the person's e-mail
- address is not human friendly (like CompuServe addresses).
+ Default: "|"
- 6\b6.\b.3\b3.\b.2\b23\b33\b3.\b. r\bre\bev\bve\ber\brs\bse\be_\b_n\bna\bam\bme\be
+ This specifies the delimiter between the sidebar (if visible) and other screens.
- Type: boolean
- Default: no
- It may sometimes arrive that you receive mail to a certain machine,
- move the messages to another machine, and reply to some the messages
- from there. If this variable is set, the default _\bF_\br_\bo_\bm_\b: line of the
- reply messages is built using the address where you received the
- messages you are replying to. If the variable is unset, the _\bF_\br_\bo_\bm_\b:
- line will use your address on the current machine.
+268. sidebar_newmail_only
- 6\b6.\b.3\b3.\b.2\b23\b34\b4.\b. r\bre\bev\bve\ber\brs\bse\be_\b_r\bre\bea\bal\bln\bna\bam\bme\be
+ Type: boolean
- Type: boolean
- Default: yes
+ Default: no
- This variable fine-tunes the behaviour of the ``reverse_name''
- feature. When it is set, mutt will use the address from incoming
- messages as-is, possibly including eventual real names. When it is
- unset, mutt will override any such real names with the setting of the
- ``realname'' variable.
+ If set, only folders with new mail will be shown in the sidebar.
- 6\b6.\b.3\b3.\b.2\b23\b35\b5.\b. r\brf\bfc\bc2\b20\b04\b47\b7_\b_p\bpa\bar\bra\bam\bme\bet\bte\ber\brs\bs
+269. sidebar_number_format
- Type: boolean
- Default: no
+ Type: string
- When this variable is set, Mutt will decode RFC-2047-encoded MIME
- parameters. You want to set this variable when mutt suggests you to
- save attachments to files named like this:
- =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
+ Default: "%m%?n?(%n)?%?f?[%f]?"
- When this variable is set interactively, the change doesn't have the
- desired effect before you have changed folders.
+ This variable controls how message counts are printed when the sidebar is enabled. If this variable is empty (and only if), no numbers will be printed and mutt-ng won't frequently count mail (which may be a great speedup esp. with mbox-style mailboxes.)
- Note that this use of RFC 2047's encoding is explicitly, prohibited by
- the standard, but nevertheless encountered in the wild. Also note
- that setting this parameter will _\bn_\bo_\bt have the effect that mutt
- _\bg_\be_\bn_\be_\br_\ba_\bt_\be_\bs this kind of encoding. Instead, mutt will unconditionally
- use the encoding specified in RFC 2231.
+ The following printf(3)-like sequences are supported all of which may be printed non-zero:
- 6\b6.\b.3\b3.\b.2\b23\b36\b6.\b. s\bsa\bav\bve\be_\b_a\bad\bdd\bdr\bre\bes\bss\bs
+ %d
+ Number of deleted messages. 1)
- Type: boolean
- Default: no
+ %F
+ Number of flagged messages.
- If set, mutt will take the sender's full address when choosing a
- default folder for saving a mail. If ````$save_name'''' or
- ````$force_name'''' is set too, the selection of the fcc folder will
- be changed as well.
+ %m
+ Total number of messages.
- 6\b6.\b.3\b3.\b.2\b23\b37\b7.\b. s\bsa\bav\bve\be_\b_e\bem\bmp\bpt\bty\by
+ %M
+ Total number of messages shown, i.e. not hidden by a limit. 1)
- Type: boolean
- Default: yes
+ %n
+ Number of new messages.
- When unset, mailboxes which contain no saved messages will be removed
- when closed (the exception is ````$spoolfile'''' which is never
- removed). If set, mailboxes are never removed.
+ %t
+ Number of tagged messages. 1)
- N\bNo\bot\bte\be:\b: This only applies to mbox and MMDF folders, Mutt does not delete
- MH and Maildir directories.
+ 1) These expandos only have a non-zero value for the current mailbox and will always be zero otherwise.
- 6\b6.\b.3\b3.\b.2\b23\b38\b8.\b. s\bsa\bav\bve\be_\b_n\bna\bam\bme\be
+270. sidebar_shorten_hierarchy
- Type: boolean
- Default: no
+ Type: boolean
- This variable controls how copies of outgoing messages are saved.
- When set, a check is made to see if a mailbox specified by the
- recipient address exists (this is done by searching for a mailbox in
- the ````$folder'''' directory with the _\bu_\bs_\be_\br_\bn_\ba_\bm_\be part of the recipient
- address). If the mailbox exists, the outgoing message will be saved
- to that mailbox, otherwise the message is saved to the ````$record''''
- mailbox.
+ Default: no
- Also see the ````$force_name'''' variable.
+ When set, the ``hierarchy'' of the sidebar entries will be shortened only if they cannot be printed in full length (because ``$sidebar_width'' is set to a too low value). For example, if the newsgroup name ``de.alt.sysadmin.recovery'' doesn't fit on the screen, it'll get shortened ``d.a.s.recovery'' while ``de.alt.d0'' still would and thus will not get shortened.
- 6\b6.\b.3\b3.\b.2\b23\b39\b9.\b. s\bsc\bco\bor\bre\be
+ At which characters this compression is done is controled via the $sidebar_boundary variable.
- Type: boolean
- Default: yes
+271. sidebar_visible
- When this variable is _\bu_\bn_\bs_\be_\bt, scoring is turned off. This can be
- useful to selectively disable scoring for certain folders when the
- ````$score_threshold_delete'''' variable and friends are used.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b24\b40\b0.\b. s\bsc\bco\bor\bre\be_\b_t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd_\b_d\bde\bel\ble\bet\bte\be
+ Default: no
- Type: number
- Default: -1
+ This specifies whether or not to show the sidebar (a list of folders specified with the ``mailboxes'' command).
- Messages which have been assigned a score equal to or lower than the
- value of this variable are automatically marked for deletion by mutt.
- Since mutt scores are always greater than or equal to zero, the
- default setting of this variable will never mark a message for
- deletion.
+272. sidebar_width
- 6\b6.\b.3\b3.\b.2\b24\b41\b1.\b. s\bsc\bco\bor\bre\be_\b_t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd_\b_f\bfl\bla\bag\bg
+ Type: number
- Type: number
- Default: 9999
+ Default: 0
- Messages which have been assigned a score greater than or equal to
- this variable's value are automatically marked "flagged".
+ The width of the sidebar.
- 6\b6.\b.3\b3.\b.2\b24\b42\b2.\b. s\bsc\bco\bor\bre\be_\b_t\bth\bhr\bre\bes\bsh\bho\bol\bld\bd_\b_r\bre\bea\bad\bd
+273. sig_dashes
- Type: number
- Default: -1
- Messages which have been assigned a score equal to or lower than the
- value of this variable are automatically marked as read by mutt.
- Since mutt scores are always greater than or equal to zero, the
- default setting of this variable will never mark a message read.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b24\b43\b3.\b. s\bse\ben\bnd\bd_\b_c\bch\bha\bar\brs\bse\bet\bt
+ Default: yes
- Type: string
- Default: "us-ascii:iso-8859-1:utf-8"
+ If set, a line containing ``-- '' (dash, dash, space) will be inserted before your ``$signature''. It is strongly recommended that you not unset this variable unless your ``signature'' contains just your name. The reason for this is because many software packages use ``-- \n'' to detect your signature.
- A list of character sets for outgoing messages. Mutt will use the
- first character set into which the text can be converted exactly. If
- your ````$charset'''' is not iso-8859-1 and recipients may not
- understand UTF-8, it is advisable to include in the list an
- appropriate widely used standard character set (such as iso-8859-2,
- koi8-r or iso-2022-jp) either instead of or after "iso-8859-1".
+ For example, Mutt-ng has the ability to highlight the signature in a different color in the builtin pager.
- 6\b6.\b.3\b3.\b.2\b24\b44\b4.\b. s\bse\ben\bnd\bdm\bma\bai\bil\bl
+274. sig_on_top
- Type: path
- Default: "/usr/sbin/sendmail -oem -oi"
+ Type: boolean
- Specifies the program and arguments used to deliver mail sent by Mutt.
- Mutt expects that the specified program interprets additional
- arguments as recipient addresses.
+ Default: no
- 6\b6.\b.3\b3.\b.2\b24\b45\b5.\b. s\bse\ben\bnd\bdm\bma\bai\bil\bl_\b_w\bwa\bai\bit\bt
+ If set, the signature will be included before any quoted or forwarded text. It is strongly recommended that you do not set this variable unless you really know what you are doing, and are prepared to take some heat from netiquette guardians.
- Type: number
- Default: 0
+275. signature
- Specifies the number of seconds to wait for the ````$sendmail''''
- process to finish before giving up and putting delivery in the
- background.
+ Type: path
- Mutt interprets the value of this variable as follows:
+ Default: "˜/.signature"
- >\b>0\b0 number of seconds to wait for sendmail to finish before
- continuing
+ Specifies the filename of your signature, which is appended to all outgoing messages. If the filename ends with a pipe (``|''), it is assumed that filename is a shell command and input should be read from its stdout.
- 0\b0 wait forever for sendmail to finish
+276. signoff_string
- <\b<0\b0 always put sendmail in the background without waiting
+ Type: string
- Note that if you specify a value other than 0, the output of the child
- process will be put in a temporary file. If there is some error, you
- will be informed as to where to find the output.
+ Default: ""
- 6\b6.\b.3\b3.\b.2\b24\b46\b6.\b. s\bsh\bhe\bel\bll\bl
+ If set, this string will be inserted before the signature. This is useful for people that want to sign off every message they send with their name.
- Type: path
- Default: ""
+ If you want to insert your website's URL, additional contact information or witty quotes into your mails, better use a signature file instead of the signoff string.
- Command to use when spawning a subshell. By default, the user's login
- shell from /etc/passwd is used.
+277. simple_search
- 6\b6.\b.3\b3.\b.2\b24\b47\b7.\b. s\bsa\bav\bve\be_\b_u\bun\bns\bsu\bub\bbs\bsc\bcr\bri\bib\bbe\bed\bd
+ Type: string
- Type: boolean
- Default: no
+ Default: "˜f %s | ˜s %s"
- When _\bs_\be_\bt, info about unsubscribed newsgroups will be saved into
- ``newsrc'' file and into cache.
+ Specifies how Mutt-ng should expand a simple search into a real search pattern. A simple search is one that does not contain any of the ˜ operators. See ``patterns'' for more information on search patterns.
- 6\b6.\b.3\b3.\b.2\b24\b48\b8.\b. s\bsh\bho\bow\bw_\b_n\bne\bew\bw_\b_n\bne\bew\bws\bs
+ For example, if you simply type ``joe'' at a search or limit prompt, Mutt-ng will automatically expand it to the value specified by this variable. For the default value it would be:
- Type: boolean
- Default: yes
+ ˜f joe | ˜s joe
- If _\bs_\be_\bt, newsserver will be asked for new newsgroups on entering the
- browser. Otherwise, it will be done only once for a newsserver. Also
- controls whether or not number of new articles of subscribed
- newsgroups will be then checked.
+278. sleep_time
- 6\b6.\b.3\b3.\b.2\b24\b49\b9.\b. s\bsh\bho\bow\bw_\b_o\bon\bnl\bly\by_\b_u\bun\bnr\bre\bea\bad\bd
+ Type: number
- Type: boolean
- Default: no
+ Default: 1
- If _\bs_\be_\bt, only subscribed newsgroups that contain unread articles will
- be displayed in browser.
+ Specifies time, in seconds, to pause while displaying certain informational messages, while moving from folder to folder and after expunging messages from the current folder. The default is to pause one second, so a value of zero for this option suppresses the pause.
- 6\b6.\b.3\b3.\b.2\b25\b50\b0.\b. s\bsi\big\bg_\b_d\bda\bas\bsh\bhe\bes\bs
+279. smart_wrap
- Type: boolean
- Default: yes
+ Type: boolean
- If set, a line containing ``-- '' will be inserted before your
- ````$signature''''. It is s\bst\btr\bro\bon\bng\bgl\bly\by recommended that you not unset
- this variable unless your ``signature'' contains just your name. The
- reason for this is because many software packages use ``-- \n'' to
- detect your signature. For example, Mutt has the ability to highlight
- the signature in a different color in the builtin pager.
+ Default: yes
- 6\b6.\b.3\b3.\b.2\b25\b51\b1.\b. s\bsi\big\bg_\b_o\bon\bn_\b_t\bto\bop\bp
+ Controls the display of lines longer than the screen width in the internal pager. If set, long lines are wrapped at a word boundary. If unset, lines are simply wrapped at the screen edge. Also see the ``$markers'' variable.
- Type: boolean
- Default: no
+280. smileys
- If set, the signature will be included before any quoted or forwarded
- text. It is s\bst\btr\bro\bon\bng\bgl\bly\by recommended that you do not set this variable
- unless you really know what you are doing, and are prepared to take
- some heat from netiquette guardians.
+ Type: regular expression
- 6\b6.\b.3\b3.\b.2\b25\b52\b2.\b. s\bsi\big\bgn\bna\bat\btu\bur\bre\be
+ Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
- Type: path
- Default: "~/.signature"
+ The pager uses this variable to catch some common false positives of ``$quote_regexp'', most notably smileys in the beginning of a line
- Specifies the filename of your signature, which is appended to all
- outgoing messages. If the filename ends with a pipe (``|''), it is
- assumed that filename is a shell command and input should be read from
- its stdout.
+281. smime_ask_cert_label
- 6\b6.\b.3\b3.\b.2\b25\b53\b3.\b. s\bsi\bim\bmp\bpl\ble\be_\b_s\bse\bea\bar\brc\bch\bh
+ Type: boolean
- Type: string
- Default: "~f %s | ~s %s"
+ Default: yes
- Specifies how Mutt should expand a simple search into a real search
- pattern. A simple search is one that does not contain any of the ~
- operators. See ````patterns'''' for more information on search
- patterns.
+ This flag controls whether you want to be asked to enter a label for a certificate about to be added to the database or not. It is set by default. (S/MIME only)
- For example, if you simply type joe at a search or limit prompt, Mutt
- will automatically expand it to the value specified by this variable.
- For the default value it would be:
+282. smime_ca_location
- ~f joe | ~s joe
+ Type: path
- 6\b6.\b.3\b3.\b.2\b25\b54\b4.\b. s\bsm\bma\bar\brt\bt_\b_w\bwr\bra\bap\bp
+ Default: ""
- Type: boolean
- Default: yes
+ This variable contains the name of either a directory, or a file which contains trusted certificates for use with OpenSSL. (S/MIME only)
- Controls the display of lines longer than the screen width in the
- internal pager. If set, long lines are wrapped at a word boundary. If
- unset, lines are simply wrapped at the screen edge. Also see the
- ````$markers'''' variable.
+283. smime_certificates
- 6\b6.\b.3\b3.\b.2\b25\b55\b5.\b. s\bsm\bmi\bil\ble\bey\bys\bs
+ Type: path
- Type: regular expression
- Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
+ Default: ""
- The _\bp_\ba_\bg_\be_\br uses this variable to catch some common false positives of
- ````$quote_regexp'''', most notably smileys in the beginning of a line
+ Since there is no pubring/secring as with PGP, Mutt-ng has to handle storage and retrieval of keys by itself. This is very basic right now, and keys and certificates are stored in two different directories, both named as the hash-value retrieved from OpenSSL. There is an index file which contains mailbox-address keyid pairs, and which can be manually edited. This one points to the location of the certificates. (S/MIME only)
- 6\b6.\b.3\b3.\b.2\b25\b56\b6.\b. s\bsl\ble\bee\bep\bp_\b_t\bti\bim\bme\be
+284. smime_decrypt_command
- Type: number
- Default: 1
+ Type: string
- Specifies time, in seconds, to pause while displaying certain
- informational messages, while moving from folder to folder and after
- expunging messages from the current folder. The default is to pause
- one second, so a value of zero for this option suppresses the pause.
- 6\b6.\b.3\b3.\b.2\b25\b57\b7.\b. s\bso\bor\brt\bt
+ Default: ""
- Type: sort order
- Default: date
+ This format string specifies a command which is used to decrypt application/x-pkcs7-mime attachments.
- Specifies how to sort messages in the _\bi_\bn_\bd_\be_\bx menu. Valid values are:
+ The OpenSSL command formats have their own set of printf(3)-like sequences similar to PGP's:
- date or date-sent
- date-received
- from
- mailbox-order (unsorted)
- score
- size
- spam
- subject
- threads
- to
+ %f
+ Expands to the name of a file containing a message.
- You may optionally use the reverse- prefix to specify reverse sorting
- order (example: set sort=reverse-date-sent).
+ %s
+ Expands to the name of a file containing the signature part of a multipart/signed attachment when verifying it.
- 6\b6.\b.3\b3.\b.2\b25\b58\b8.\b. s\bso\bor\brt\bt_\b_a\bal\bli\bia\bas\bs
+ %k
+ The key-pair specified with $smime_default_key
- Type: sort order
- Default: alias
+ %c
+ One or more certificate IDs.
- Specifies how the entries in the `alias' menu are sorted. The
- following are legal values:
+ %a
+ The algorithm used for encryption.
- address (sort alphabetically by email address)
- alias (sort alphabetically by alias name)
- unsorted (leave in order specified in .muttrc)
+ %C
+ CA location: Depending on whether $smime_ca_location points to a directory or file, this expands to "-CApath $smime_ca_location" or "-CAfile $smime_ca_location".
- 6\b6.\b.3\b3.\b.2\b25\b59\b9.\b. s\bso\bor\brt\bt_\b_a\bau\bux\bx
+ For examples on how to configure these formats, see the smime.rc in the samples/ subdirectory which has been installed on your system alongside the documentation. (S/MIME only)
- Type: sort order
- Default: date
+285. smime_decrypt_use_default_key
- When sorting by threads, this variable controls how threads are sorted
- in relation to other threads, and how the branches of the thread trees
- are sorted. This can be set to any value that ````$sort'''' can,
- except threads (in that case, mutt will just use date-sent). You can
- also specify the last- prefix in addition to the reverse- prefix, but
- last- must come after reverse-. The last- prefix causes messages to
- be sorted against its siblings by which has the last descendant, using
- the rest of sort_aux as an ordering. For instance, set sort_aux=last-
- date-received would mean that if a new message is received in a
- thread, that thread becomes the last one displayed (or the first, if
- you have set sort=reverse-threads.) Note: For reversed ````$sort''''
- order ``$sort_aux'' is reversed again (which is not the right thing to
- do, but kept to not break any existing configuration setting).
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b26\b60\b0.\b. s\bso\bor\brt\bt_\b_b\bbr\bro\bow\bws\bse\ber\br
+ Default: yes
- Type: sort order
- Default: subject
+ If set (default) this tells Mutt-ng to use the default key for decryption. Otherwise, if manage multiple certificate-key-pairs, Mutt-ng will try to use the mailbox-address to determine the key to use. It will ask you to supply a key, if it can't find one. (S/MIME only)
- Specifies how to sort entries in the file browser. By default, the
- entries are sorted alphabetically. Valid values:
+286. smime_default_key
- alpha (alphabetically)
- date
- size
- unsorted
+ Type: string
+
+ Default: ""
+
+ This is the default key-pair to use for signing. This must be set to the keyid (the hash-value that OpenSSL generates) to work properly (S/MIME only)
+
+287. smime_encrypt_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to create encrypted S/MIME messages. (S/MIME only)
+
+288. smime_encrypt_with
+
+ Type: string
+
+ Default: ""
+
+ This sets the algorithm that should be used for encryption. Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``\frc2-128''.
+
+ If unset ``3des'' (TripleDES) is used. (S/MIME only)
+
+289. smime_get_cert_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to extract X509 certificates from a PKCS7 structure. (S/MIME only)
+
+290. smime_get_cert_email_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to extract the mail address(es) used for storing X509 certificates, and for verification purposes (to check whether the certificate was issued for the sender's mailbox). (S/MIME only)
+
+291. smime_get_signer_cert_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to extract only the signers X509 certificate from a S/MIME signature, so that the certificate's owner may get compared to the email's ``From:'' header field. (S/MIME only)
+
+292. smime_import_cert_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to import a certificate via smime_keysng. (S/MIME only)
+
+293. smime_is_default
+
+ Type: boolean
+
+ Default: no
+
+ The default behaviour of Mutt-ng is to use PGP on all auto-sign/encryption operations. To override and to use OpenSSL instead this must be set.
+
+ However, this has no effect while replying, since Mutt-ng will automatically select the same application that was used to sign/encrypt the original message.
+
+ (Note that this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only)
+
+294. smime_keys
+
+ Type: path
+
+ Default: ""
+
+ Since there is no pubring/secring as with PGP, Mutt-ng has to handle storage ad retrieval of keys/certs by itself. This is very basic right now, and stores keys and certificates in two different directories, both named as the hash-value retrieved from OpenSSL. There is an index file which contains mailbox-address keyid pair, and which can be manually edited. This one points to the location of the private keys. (S/MIME only)
+
+295. smime_pk7out_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to extract PKCS7 structures of S/MIME signatures, in order to extract the public X509 certificate(s). (S/MIME only)
+
+296. smime_sign_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to created S/MIME signatures of type multipart/signed, which can be read by all mail clients. (S/MIME only)
+
+297. smime_sign_opaque_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to created S/MIME signatures of type application/x-pkcs7-signature, which can only be handled by mail clients supporting the S/MIME extension. (S/MIME only)
+
+298. smime_timeout
+
+ Type: number
+
+ Default: 300
+
+ The number of seconds after which a cached passphrase will expire if not used. (S/MIME only)
+
+299. smime_verify_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to verify S/MIME signatures of type multipart/signed. (S/MIME only)
+
+300. smime_verify_opaque_command
+
+ Type: string
+
+ Default: ""
+
+ This command is used to verify S/MIME signatures of type application/x-pkcs7-mime. (S/MIME only)
+
+301. smtp_envelope
+
+ Type: string
+
+ Default: ""
+
+ Availability: SMTP
+
+ If this variable is non-empty, it'll be used as the envelope sender. If it's empty (the default), the value of the regular From: header will be used.
+
+ This may be necessary as some providers don't allow for arbitrary values as the envelope sender but only a particular one which may not be the same as the user's desired From: header.
+
+302. smtp_host
+
+ Type: string
+
+ Default: ""
+
+ Availability: SMTP
+
+ Defines the SMTP host which will be used to deliver mail, as opposed to invoking the sendmail binary. Setting this variable overrides the value of ``$sendmail'', and any associated variables.
+
+303. smtp_pass
+
+ Type: string
+
+ Default: ""
+
+ Availability: SMTP
+
+ Defines the password to use with SMTP AUTH. If ``$smtp_user'' is set, but this variable is not, you will be prompted for a password when sending.
+
+ Note: Storing passwords in a configuration file presents a security risk since the superuser of your machine may read it regardless of the file's permissions.
+
+304. smtp_port
+
+ Type: number
+
+ Default: 25
+
+ Availability: SMTP
+
+ Defines the port that the SMTP host is listening on for mail delivery. Must be specified as a number.
+
+ Defaults to 25, the standard SMTP port, but RFC 2476-compliant SMTP servers will probably desire 587, the mail submission port.
+
+305. smtp_use_tls
+
+ Type: string
+
+ Default: ""
+
+ Availability: SMTP (and SSL)
+
+ Defines wether to use STARTTLS. If this option is set to ``required'' and the server does not support STARTTLS or there is an error in the TLS Handshake, the connection will fail. Setting this to ``enabled'' will try to start TLS and continue without TLS in case of an error. Muttng still needs to have SSL support enabled in order to use it.
+
+306. smtp_user
+
+ Type: string
+
+ Default: ""
+
+ Availability: SMTP
+
+ Defines the username to use with SMTP AUTH. Setting this variable will cause Mutt-ng to attempt to use SMTP AUTH when sending.
+
+307. sort
+
+ Type: sort order
+
+ Default: date
+
+ Specifies how to sort messages in the index menu. Valid values are:
+ date or date-sent
+ date-received
+ from
+ mailbox-order (unsorted)
+ score
+ size
+ spam
+ subject
+ threads
+ to
+
+ You may optionally use the ``reverse-'' prefix to specify reverse sorting order (example: set sort=reverse-date-sent).
+
+308. sort_alias
+
+ Type: sort order
+
+ Default: alias
+
+ Specifies how the entries in the ``alias'' menu are sorted. The following are legal values:
+ address (sort alphabetically by email address)
+ alias (sort alphabetically by alias name)
+ unsorted (leave in order specified in .muttrc)
+
+309. sort_aux
+
+ Type: sort order
+
+ Default: date
+
+ When sorting by threads, this variable controls how threads are sorted in relation to other threads, and how the branches of the thread trees are sorted. This can be set to any value that ``$sort'' can, except threads (in that case, Mutt-ng will just use date-sent). You can also specify the ``last-'' prefix in addition to ``reverse-'' prefix, but last- must come after reverse-. The last- prefix causes messages to be sorted against its siblings by which has the last descendant, using the rest of sort_aux as an ordering.
+
+ For instance, set sort_aux=last-date-received would mean that if a new message is received in a thread, that thread becomes the last one displayed (or the first, if you have set sort=reverse-threads.)
+
+ Note: For reversed ``$sort'' order $sort_aux is reversed again (which is not the right thing to do, but kept to not break any existing configuration setting).
+
+310. sort_browser
+
+ Type: sort order
+
+ Default: alpha
+
+ Specifies how to sort entries in the file browser. By default, the entries are sorted alphabetically. Valid values:
+ alpha (alphabetically)
+ date
+ size
+ unsorted
+
+ You may optionally use the ``reverse-'' prefix to specify reverse sorting order (example: set sort_browser=reverse-date).
+
+311. sort_re
+
+ Type: boolean
+
+ Default: yes
+
+ This variable is only useful when sorting by threads with ``$strict_threads'' unset. In that case, it changes the heuristic Mutt-ng uses to thread messages by subject. With $sort_re set, Mutt-ng will only attach a message as the child of another message by subject if the subject of the child message starts with a substring matching the setting of ``$reply_regexp''. With $sort_re unset, Mutt-ng will attach the message whether or not this is the case, as long as the non-``$reply_regexp'' parts of both messages are identical.
+
+312. spam_separator
+
+ Type: string
+
+ Default: ","
+
+ ``spam_separator'' controls what happens when multiple spam headers are matched: if unset, each successive header will overwrite any previous matches value for the spam label. If set, each successive match will append to the previous, using ``spam_separator'' as a separator.
+
+313. spoolfile
+
+ Type: path
+
+ Default: ""
+
+ If your spool mailbox is in a non-default place where Mutt-ng cannot find it, you can specify its location with this variable. Mutt-ng will automatically set this variable to the value of the environment variable $MAIL if it is not set.
+
+314. ssl_ca_certificates_file
+
+ Type: path
+
+ Default: ""
+
+ This variable specifies a file containing trusted CA certificates. Any server certificate that is signed with one of these CA certificates are also automatically accepted.
+
+ Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
+
+315. ssl_client_cert
+
+ Type: path
+
+ Default: ""
+
+ Availability: SSL
+
+ The file containing a client certificate and its associated private key.
+
+316. ssl_force_tls
+
+ Type: boolean
+
+ Default: no
+
+ If this variable is set, mutt-ng will require that all connections to remote servers be encrypted. Furthermore it will attempt to negotiate TLS even if the server does not advertise the capability, since it would otherwise have to abort the connection anyway. This option supersedes ``$ssl_starttls''.
+
+317. ssl_min_dh_prime_bits
+
+ Type: number
+
+ Default: 0
+
+ Availability: GNUTLS
+
+ This variable specifies the minimum acceptable prime size (in bits) for use in any Diffie-Hellman key exchange. A value of 0 will use the default from the GNUTLS library.
+
+318. ssl_starttls
+
+ Type: quadoption
+
+ Default: yes
+
+ Availability: SSL or GNUTLS
+
+ If set (the default), Mutt-ng will attempt to use STARTTLS on servers advertising the capability. When unset, Mutt-ng will not attempt to use STARTTLS regardless of the server's capabilities.
+
+319. ssl_use_sslv2
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: SSL
+
+ This variables specifies whether to attempt to use SSLv2 in the SSL authentication process.
+
+320. ssl_use_sslv3
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: SSL or GNUTLS
+
+ This variables specifies whether to attempt to use SSLv3 in the SSL authentication process.
+
+321. ssl_use_tlsv1
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: SSL or GNUTLS
+
+ This variables specifies whether to attempt to use TLSv1 in the SSL authentication process.
+
+322. ssl_usesystemcerts
+
+ Type: boolean
+
+ Default: yes
+
+ Availability: SSL
+
+ If set to yes, Mutt-ng will use CA certificates in the system-wide certificate store when checking if server certificate is signed by a trusted CA.
+
+323. status_chars
+
+ Type: string
+
+ Default: "-*%A"
+
+ Controls the characters used by the ``%r'' indicator in ``$status_format''. The first character is used when the mailbox is unchanged. The second is used when the mailbox has been changed, and it needs to be resynchronized. The third is used if the mailbox is in read-only mode, or if the mailbox will not be written when exiting that mailbox (You can toggle whether to write changes to a mailbox with the toggle-write operation, bound by default to ``%''). The fourth is used to indicate that the current folder has been opened in attach-message mode (Certain operations like composing a new mail, replying, forwarding, etc. are not permitted in this mode).
+
+324. status_format
+
+ Type: string
+
+ Default: "-%r-Mutt-ng: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"
+
+ Controls the format of the status line displayed in the index menu. This string is similar to ``$index_format'', but has its own set of printf(3)-like sequences:
+
+ %b
+ number of mailboxes with new mail *
+
+ %B
+ the short pathname of the current mailbox
+
+ %d
+ number of deleted messages *
+
+ %f
+ the full pathname of the current mailbox
+
+ %F
+ number of flagged messages *
+
+ %h
+ local hostname
+
+ %l
+ size (in bytes) of the current mailbox *
+
+ %L
+ size (in bytes) of the messages shown (i.e., which match the current limit) *
+
+ %m
+ the number of messages in the mailbox *
+
+ %M
+ the number of messages shown (i.e., which match the current limit) *
+
+ %n
+ number of new messages in the mailbox *
+
+ %o
+ number of old unread messages *
+
+ %p
+ number of postponed messages *
+
+ %P
+ percentage of the way through the index
+
+ %r
+ modified/read-only/won't-write/attach-message indicator, according to $status_chars
+
+ %s
+ current sorting mode ($sort)
+
+ %S
+ current aux sorting method ($sort_aux)
+
+ %t
+ number of tagged messages *
+
+ %u
+ number of unread messages *
+
+ %v
+ Mutt-ng version string
+
+ %V
+ currently active limit pattern, if any *
+
+ %>X
+ right justify the rest of the string and pad with "X"
+
+ %|X
+ pad to the end of the line with "X"
+
+ * = can be optionally printed if nonzero
+
+ Some of the above 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 a character from the table above, 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:
+
+ %?n?%n new messages.?
+
+ Additionally you can switch between two strings, the first one, if a value is zero, the second one, if the value is nonzero, by using the following construct:
+
+ %?<sequence_char>?<if_string>&<else_string>?
+
+ You can additionally force the result of any printf(3)-like sequence to be lowercase by prefixing the sequence character with an underscore (_) sign. For example, if you want to display the local hostname in lowercase, you would use:
+
+ %_h
+
+ If you prefix the sequence character with a colon (:) character, Mutt-ng will replace any dots in the expansion by underscores. This might be helpful with IMAP folders that don't like dots in folder names.
+
+325. status_on_top
+
+ Type: boolean
+
+ Default: no
+
+ Setting this variable causes the ``status bar'' to be displayed on the first line of the screen rather than near the bottom.
+
+326. strict_mailto
+
+ Type: boolean
+
+ Default: yes
+
+ With mailto: style links, a body as well as arbitrary header information may be embedded. This may lead to (user) headers being overwriten without note if ``$edit_headers'' is unset.
+
+ If this variable is set, mutt-ng is strict and allows anything to be changed. If it's unset, all headers given will be prefixed with ``X-Mailto-'' and the message including headers will be shown in the editor regardless of what ``$edit_headers'' is set to.
+
+327. strict_mime
+
+ Type: boolean
+
+ Default: yes
+
+ When unset, non MIME-compliant messages that doesn't have any charset indication in the ``Content-Type:'' header field can be displayed (non MIME-compliant messages are often generated by old mailers or buggy mailers like MS Outlook Express). See also $assumed_charset.
+
+ This option also replaces linear-white-space between encoded-word and *text to a single space to prevent the display of MIME-encoded ``Subject:'' header field from being devided into multiple lines.
+
+328. strict_threads
+
+ Type: boolean
+
+ Default: no
+
+ If set, threading will only make use of the ``In-Reply-To:'' and ``References:'' header fields when you ``$sort'' by message threads. By default, messages with the same subject are grouped together in ``pseudo threads.'' This may not always be desirable, such as in a personal mailbox where you might have several unrelated messages with the subject ``hi'' which will get grouped together.
+
+329. strip_was
+
+ Type: boolean
+
+ Default: no
+
+ When set, mutt-ng will remove the trailing part of the ``Subject:'' line which matches $strip_was_regex when replying. This is useful to properly react on subject changes and reduce ``subject noise.'' (esp. in Usenet)
+
+330. strip_was_regex
+
+ Type: regular expression
+
+ Default: "\([Ww][Aa][RrSs]: .*\)[ ]*$"
+
+ When non-empty and $strip_was is set, mutt-ng will remove this trailing part of the ``Subject'' line when replying if it won't be empty afterwards.
+
+331. stuff_quoted
+
+ Type: boolean
+
+ Default: no
+
+ If set, attachments with flowed format will have their quoting ``stuffed'', i.e. a space will be inserted between the quote characters and the actual text.
+
+332. suspend
+
+ Type: boolean
+
+ Default: yes
+
+ When unset, Mutt-ng won't stop when the user presses the terminal's susp key, usually CTRL+Z. This is useful if you run Mutt-ng inside an xterm using a command like ``xterm -e muttng.''
+
+333. text_flowed
+
+ Type: boolean
+
+ Default: no
+
+ When set, Mutt-ng will generate text/plain; format=flowed attachments. This format is easier to handle for some mailing software, and generally just looks like ordinary text. To actually make use of this format's features, you'll need support in your editor.
+
+ Note that $indent_string is ignored when this option is set.
+
+334. thorough_search
+
+ Type: boolean
+
+ Default: no
- You may optionally use the reverse- prefix to specify reverse sorting
- order (example: set sort_browser=reverse-date).
+ Affects the ˜b and ˜h search operations described in section ``patterns'' above. If set, the headers and attachments of messages to be searched are decoded before searching. If unset, messages are searched as they appear in the folder.
- 6\b6.\b.3\b3.\b.2\b26\b61\b1.\b. s\bso\bor\brt\bt_\b_r\bre\be
+335. thread_received
- Type: boolean
- Default: yes
+ Type: boolean
- This variable is only useful when sorting by threads with
- ````$strict_threads'''' unset. In that case, it changes the heuristic
- mutt uses to thread messages by subject. With sort_re set, mutt will
- only attach a message as the child of another message by subject if
- the subject of the child message starts with a substring matching the
- setting of ````$reply_regexp''''. With sort_re unset, mutt will
- attach the message whether or not this is the case, as long as the
- non-````$reply_regexp'''' parts of both messages are identical.
+ Default: no
- 6\b6.\b.3\b3.\b.2\b26\b62\b2.\b. s\bsp\bpo\boo\bol\blf\bfi\bil\ble\be
+ When set, Mutt-ng uses the date received rather than the date sent to thread messages by subject.
- Type: path
- Default: ""
+336. tilde
- If your spool mailbox is in a non-default place where Mutt cannot find
- it, you can specify its location with this variable. Mutt will
- automatically set this variable to the value of the environment
- variable $MAIL if it is not set.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b26\b63\b3.\b. s\bst\bta\bat\btu\bus\bs_\b_c\bch\bha\bar\brs\bs
+ Default: no
- Type: string
- Default: "-*%A"
+ When set, the internal-pager will pad blank lines to the bottom of the screen with a tilde (˜).
- Controls the characters used by the "%r" indicator in
- ````$status_format''''. The first character is used when the mailbox
- is unchanged. The second is used when the mailbox has been changed,
- and it needs to be resynchronized. The third is used if the mailbox is
- in read-only mode, or if the mailbox will not be written when exiting
- that mailbox (You can toggle whether to write changes to a mailbox
- with the toggle-write operation, bound by default to "%"). The fourth
- is used to indicate that the current folder has been opened in attach-
- message mode (Certain operations like composing a new mail, replying,
- forwarding, etc. are not permitted in this mode).
+337. timeout
- 6\b6.\b.3\b3.\b.2\b26\b64\b4.\b. s\bst\bta\bat\btu\bus\bs_\b_f\bfo\bor\brm\bma\bat\bt
+ Type: number
- Type: string
- Default: "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d?
- Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l?
- %l?]---(%s/%S)-%>-(%P)---"
+ Default: 600
- Controls the format of the status line displayed in the _\bi_\bn_\bd_\be_\bx menu.
- This string is similar to ````$index_format'''', but has its own set
- of printf()-like sequences:
+ This variable controls the number of seconds Mutt-ng will wait for a key to be pressed in the main menu before timing out and checking for new mail. A value of zero or less will cause Mutt-ng to never time out.
- %\b%b\bb number of mailboxes with new mail *
+338. tmpdir
- %\b%d\bd number of deleted messages *
+ Type: path
- %\b%f\bf the full pathname of the current mailbox
+ Default: ""
- %\b%F\bF number of flagged messages *
+ This variable allows you to specify where Mutt-ng will place its temporary files needed for displaying and composing messages. If this variable is not set, the environment variable $TMPDIR is used. If $TMPDIR is not set then "/tmp" is used.
- %\b%h\bh local hostname
+339. to_chars
- %\b%l\bl size (in bytes) of the current mailbox *
+ Type: string
- %\b%L\bL size (in bytes) of the messages shown (i.e., which match the
- current limit) *
+ Default: " +TCFL"
- %\b%m\bm the number of messages in the mailbox *
+ Controls the character used to indicate mail addressed to you. The first character is the one used when the mail is NOT addressed to your address (default: space). The second is used when you are the only recipient of the message (default: +). The third is when your address appears in the ``To:'' header field, but you are not the only recipient of the message (default: T). The fourth character is used when your address is specified in the ``Cc:'' header field, but you are not the only recipient. The fifth character is used to indicate mail that was sent by you. The sixth character is used to indicate when a mail was sent to a mailing-list you're subscribe to (default: L).
- %\b%M\bM the number of messages shown (i.e., which match the current
- limit) *
+340. trash
- %\b%n\bn number of new messages in the mailbox *
+ Type: path
- %\b%o\bo number of old unread messages
+ Default: ""
- %\b%p\bp number of postponed messages *
+ If set, this variable specifies the path of the trash folder where the mails marked for deletion will be moved, instead of being irremediably purged.
- %\b%P\bP percentage of the way through the index
+ Note: When you delete a message in the trash folder, it is really deleted, so that there is no way to recover mail.
- %\b%r\br modified/read-only/won't-write/attach-message indicator,
- according to ``$status_chars''
+341. tunnel
- %\b%s\bs current sorting mode (``$sort'')
+ Type: string
- %\b%S\bS current aux sorting method (``$sort_aux'')
+ Default: ""
- %\b%t\bt number of tagged messages *
+ Setting this variable will cause Mutt-ng to open a pipe to a command instead of a raw socket. You may be able to use this to set up preauthenticated connections to your IMAP/POP3 server. Example:
- %\b%u\bu number of unread messages *
+ tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
- %\b%v\bv Mutt version string
+ Note: For this example to work you must be able to log in to the remote machine without having to enter a password.
- %\b%V\bV currently active limit pattern, if any *
+342. umask
- %\b%>\b>X\bX
- right justify the rest of the string and pad with "X"
+ Type: number
- %\b%|\b|X\bX
- pad to the end of the line with "X"
+ Default: 0077
- * = can be optionally printed if nonzero
+ This sets the umask that will be used by Mutt-ng when creating all kinds of files. If unset, the default value is 077.
- Some of the above 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
+343. uncollapse_jump
- %?<sequence_char>?<optional_string>?
+ Type: boolean
- where \e[4msequence_char\e[24m is a character from the table above, and
- \e[4moptional_string\e[24m is the string you would like printed if \e[4mstatus_char\e[24m is
- nonzero. \e[4moptional_string\e[24m \e[1mmay \e[22mcontain other sequence as well as normal
- text, but you may \e[1mnot \e[22mnest optional strings.
+ Default: no
- Here is an example illustrating how to optionally print the number of
- new messages in a mailbox: %?n?%n new messages.?
+ When set, Mutt-ng will jump to the next unread message, if any, when the current thread is uncollapsed.
- Additionally you can switch between two strings, the first one, if a
- value is zero, the second one, if the value is nonzero, by using the
- following construct: %?<sequence_char>?<if_string>&<else_string>?
+344. use_8bitmime
- You can additionally force the result of any printf-like sequence to
- be lowercase by prefixing the sequence character with an underscore
- (_) sign. For example, if you want to display the local hostname in
- lowercase, you would use: %_h
+ Type: boolean
- If you prefix the sequence character with a colon (:) character, mutt
- will replace any dots in the expansion by underscores. This might be
- helpful with IMAP folders that don't like dots in folder names.
+ Default: no
- 6\b6.\b.3\b3.\b.2\b26\b65\b5.\b. s\bst\bta\bat\btu\bus\bs_\b_o\bon\bn_\b_t\bto\bop\bp
+ Warning: do not set this variable unless you are using a version of sendmail which supports the -B8BITMIME flag (such as sendmail 8.8.x) or in connection with the SMTP support via libESMTP. Otherwise you may not be able to send mail.
- Type: boolean
- Default: no
+ When set, Mutt-ng will either invoke ``$sendmail'' with the -B8BITMIME flag when sending 8-bit messages to enable ESMTP negotiation or tell libESMTP to do so.
- Setting this variable causes the ``status bar'' to be displayed on the
- first line of the screen rather than near the bottom.
+345. use_domain
- 6\b6.\b.3\b3.\b.2\b26\b66\b6.\b. s\bst\btr\bri\bic\bct\bt_\b_t\bth\bhr\bre\bea\bad\bds\bs
+ Type: boolean
- Type: boolean
- Default: no
+ Default: yes
- If set, threading will only make use of the ``In-Reply-To'' and
- ``References'' fields when you ````$sort'''' by message threads. By
- default, messages with the same subject are grouped together in
- ``pseudo threads.'' This may not always be desirable, such as in a
- personal mailbox where you might have several unrelated messages with
- the subject ``hi'' which will get grouped together.
+ When set, Mutt-ng will qualify all local addresses (ones without the @host portion) with the value of ``$hostname''. If unset, no addresses will be qualified.
- 6\b6.\b.3\b3.\b.2\b26\b67\b7.\b. s\bsu\bus\bsp\bpe\ben\bnd\bd
+346. use_from
- Type: boolean
- Default: yes
+ Type: boolean
- When _\bu_\bn_\bs_\be_\bt, mutt won't stop when the user presses the terminal's _\bs_\bu_\bs_\bp
- key, usually ``control-Z''. This is useful if you run mutt inside an
- xterm using a command like xterm -e mutt.
+ Default: yes
- 6\b6.\b.3\b3.\b.2\b26\b68\b8.\b. t\bte\bex\bxt\bt_\b_f\bfl\blo\bow\bwe\bed\bd
+ When set, Mutt-ng will generate the ``From:'' header field when sending messages. If unset, no ``From:'' header field will be generated unless the user explicitly sets one using the ``my_hdr'' command.
- Type: boolean
- Default: no
+347. use_idn
- When set, mutt will generate text/plain; format=flowed attachments.
- This format is easier to handle for some mailing software, and
- generally just looks like ordinary text. To actually make use of this
- format's features, you'll need support in your editor.
+ Type: boolean
- Note that ``$indent_string'' is ignored when this option is set.
+ Default: yes
- 6\b6.\b.3\b3.\b.2\b26\b69\b9.\b. t\bth\bhr\bre\bea\bad\bd_\b_r\bre\bec\bce\bei\biv\bve\bed\bd
+ Availability: IDN
- Type: boolean
- Default: no
+ When set, Mutt-ng will show you international domain names decoded.
- When set, mutt uses the date received rather than the date sent to
- thread messages by subject.
+ Note: You can use IDNs for addresses even if this is unset. This variable only affects decoding.
- 6\b6.\b.3\b3.\b.2\b27\b70\b0.\b. t\bth\bho\bor\bro\bou\bug\bgh\bh_\b_s\bse\bea\bar\brc\bch\bh
+348. use_ipv6
- Type: boolean
- Default: no
+ Type: boolean
- Affects the _\b~_\bb and _\b~_\bh search operations described in section
- ````patterns'''' above. If set, the headers and attachments of
- messages to be searched are decoded before searching. If unset,
- messages are searched as they appear in the folder.
+ Default: yes
- 6\b6.\b.3\b3.\b.2\b27\b71\b1.\b. t\bti\bil\bld\bde\be
+ When set, Mutt-ng will look for IPv6 addresses of hosts it tries to contact. If this option is unset, Mutt-ng will restrict itself to IPv4 addresses. Normally, the default should work.
- Type: boolean
- Default: no
+349. visual
- When set, the internal-pager will pad blank lines to the bottom of the
- screen with a tilde (~).
+ Type: path
- 6\b6.\b.3\b3.\b.2\b27\b72\b2.\b. t\bti\bim\bme\beo\bou\but\bt
+ Default: ""
- Type: number
- Default: 600
+ Specifies the visual editor to invoke when the ˜v command is given in the builtin editor.
- This variable controls the _\bn_\bu_\bm_\bb_\be_\br _\bo_\bf _\bs_\be_\bc_\bo_\bn_\bd_\bs Mutt will wait for a key
- to be pressed in the main menu before timing out and checking for new
- mail. A value of zero or less will cause Mutt to never time out.
+350. wait_key
- 6\b6.\b.3\b3.\b.2\b27\b73\b3.\b. t\btm\bmp\bpd\bdi\bir\br
+ Type: boolean
- Type: path
- Default: ""
+ Default: yes
- This variable allows you to specify where Mutt will place its
- temporary files needed for displaying and composing messages. If this
- variable is not set, the environment variable TMPDIR is used. If
- TMPDIR is not set then "/tmp" is used.
+ Controls whether Mutt-ng will ask you to press a key after shell- escape, pipe-message, pipe-entry, print-message, and print-entry commands.
- 6\b6.\b.3\b3.\b.2\b27\b74\b4.\b. t\bto\bo_\b_c\bch\bha\bar\brs\bs
+ It is also used when viewing attachments with ``auto_view'', provided that the corresponding mailcap entry has a needsterminal flag, and the external program is interactive.
- Type: string
- Default: " +TCFL"
+ When set, Mutt-ng will always ask for a key. When unset, Mutt-ng will wait for a key only if the external command returned a non-zero status.
- Controls the character used to indicate mail addressed to you. The
- first character is the one used when the mail is NOT addressed to your
- address (default: space). The second is used when you are the only
- recipient of the message (default: +). The third is when your address
- appears in the TO header field, but you are not the only recipient of
- the message (default: T). The fourth character is used when your
- address is specified in the CC header field, but you are not the only
- recipient. The fifth character is used to indicate mail that was sent
- by _\by_\bo_\bu. The sixth character is used to indicate when a mail was sent
- to a mailing-list you subscribe to (default: L).
+351. weed
- 6\b6.\b.3\b3.\b.2\b27\b75\b5.\b. t\btu\bun\bnn\bne\bel\bl
+ Type: boolean
- Type: string
- Default: ""
+ Default: yes
- Setting this variable will cause mutt to open a pipe to a command
- instead of a raw socket. You may be able to use this to set up
- preauthenticated connections to your IMAP/POP3 server. Example:
+ When set, Mutt-ng will weed headers when displaying, forwarding, printing, or replying to messages.
- tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
+352. wrap_search
- NOTE: For this example to work you must be able to log in to the
- remote machine without having to enter a password.
+ Type: boolean
- 6\b6.\b.3\b3.\b.2\b27\b76\b6.\b. u\bus\bse\be_\b_8\b8b\bbi\bit\btm\bmi\bim\bme\be
+ Default: yes
- Type: boolean
- Default: no
+ Controls whether searches wrap around the end of the mailbox.
- W\bWa\bar\brn\bni\bin\bng\bg:\b: do not set this variable unless you are using a version of
- sendmail which supports the -B8BITMIME flag (such as sendmail 8.8.x)
- or you may not be able to send mail.
+ When set, searches will wrap around the first (or last) message. When unset, searches will not wrap.
- When _\bs_\be_\bt, Mutt will invoke ````$sendmail'''' with the -B8BITMIME flag
- when sending 8-bit messages to enable ESMTP negotiation.
+353. wrapmargin
- 6\b6.\b.3\b3.\b.2\b27\b77\b7.\b. u\bus\bse\be_\b_d\bdo\bom\bma\bai\bin\bn
+ Type: number
- Type: boolean
- Default: yes
+ Default: 0
- When set, Mutt will qualify all local addresses (ones without the
- @host portion) with the value of ````$hostname''''. If _\bu_\bn_\bs_\be_\bt, no
- addresses will be qualified.
+ Controls the size of the margin remaining at the right side of the terminal when Mutt-ng's pager does smart wrapping.
- 6\b6.\b.3\b3.\b.2\b27\b78\b8.\b. u\bus\bse\be_\b_f\bfr\bro\bom\bm
+354. write_bcc
- Type: boolean
- Default: yes
+ Type: boolean
- When _\bs_\be_\bt, Mutt will generate the `From:' header field when sending
- messages. If _\bu_\bn_\bs_\be_\bt, no `From:' header field will be generated unless
- the user explicitly sets one using the ````my_hdr'''' command.
+ Default: yes
- 6\b6.\b.3\b3.\b.2\b27\b79\b9.\b. u\bus\bse\be_\b_i\bip\bpv\bv6\b6
+ Controls whether Mutt-ng writes out the Bcc header when preparing messages to be sent. Exim users may wish to unset this.
- Type: boolean
- Default: yes
+355. write_inc
- When _\bs_\be_\bt, Mutt will look for IPv6 addresses of hosts it tries to
- contact. If this option is unset, Mutt will restrict itself to IPv4
- addresses. Normally, the default should work.
+ Type: number
- 6\b6.\b.3\b3.\b.2\b28\b80\b0.\b. u\bus\bse\ber\br_\b_a\bag\bge\ben\bnt\bt
+ Default: 10
- Type: boolean
- Default: yes
+ When writing a mailbox, a message will be printed every write_inc messages to indicate progress. If set to 0, only a single message will be displayed before writing a mailbox.
- When _\bs_\be_\bt, mutt will add a "User-Agent" header to outgoing messages,
- indicating which version of mutt was used for composing them.
+ Also see the ``$read_inc'' variable.
- 6\b6.\b.3\b3.\b.2\b28\b81\b1.\b. v\bvi\bis\bsu\bua\bal\bl
+356. xterm_icon
- Type: path
- Default: ""
+ Type: string
- Specifies the visual editor to invoke when the _\b~_\bv command is given in
- the builtin editor.
+ Default: "M%?n?AIL&ail?"
- 6\b6.\b.3\b3.\b.2\b28\b82\b2.\b. w\bwa\bai\bit\bt_\b_k\bke\bey\by
+ Controls the format of the X11 icon title, as long as $xterm_set_titles is set. This string is identical in formatting to the one used by ``$status_format''.
- Type: boolean
- Default: yes
+357. xterm_leave
- Controls whether Mutt will ask you to press a key after _\bs_\bh_\be_\bl_\bl_\b- _\be_\bs_\bc_\ba_\bp_\be,
- _\bp_\bi_\bp_\be_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be, _\bp_\bi_\bp_\be_\b-_\be_\bn_\bt_\br_\by, _\bp_\br_\bi_\bn_\bt_\b-_\bm_\be_\bs_\bs_\ba_\bg_\be, and _\bp_\br_\bi_\bn_\bt_\b-_\be_\bn_\bt_\br_\by commands.
+ Type: string
- It is also used when viewing attachments with ````auto_view'''',
- provided that the corresponding mailcap entry has a _\bn_\be_\be_\bd_\bs_\bt_\be_\br_\bm_\bi_\bn_\ba_\bl
- flag, and the external program is interactive.
+ Default: ""
- When set, Mutt will always ask for a key. When unset, Mutt will wait
- for a key only if the external command returned a non-zero status.
+ If $xterm_set_titles is set, this string will be used to set the title when leaving mutt-ng. For terminal-based programs, there's no easy and portable way to read the current title so mutt-ng cannot read it upon startup and restore it when exiting.
- 6\b6.\b.3\b3.\b.2\b28\b83\b3.\b. w\bwe\bee\bed\bd
+ Based on the xterm FAQ, the following might work:
- Type: boolean
- Default: yes
+ set xterm_leave = "`test x$DISPLAY != x && xprop -id $WINDOWID | grep WM_NAME | cut -d '"' -f 2`"
- When set, mutt will weed headers when when displaying, forwarding,
- printing, or replying to messages.
+358. xterm_set_titles
- 6\b6.\b.3\b3.\b.2\b28\b84\b4.\b. w\bwr\bra\bap\bp_\b_s\bse\bea\bar\brc\bch\bh
+ Type: boolean
- Type: boolean
- Default: yes
+ Default: no
- Controls whether searches wrap around the end of the mailbox.
+ Controls whether Mutt-ng sets the xterm title bar and icon name (as long as you're in an appropriate terminal). The default must be unset to force in the validity checking.
- When set, searches will wrap around the first (or last) message. When
- unset, searches will not wrap.
+359. xterm_title
- 6\b6.\b.3\b3.\b.2\b28\b85\b5.\b. w\bwr\bra\bap\bpm\bma\bar\brg\bgi\bin\bn
+ Type: string
- Type: number
- Default: 0
+ Default: "Mutt-ng with %?m?%m messages&no messages?%?n? [%n New]?"
- Controls the size of the margin remaining at the right side of the
- terminal when mutt's pager does smart wrapping.
+ Controls the format of the title bar of the xterm provided that $xterm_set_titles has been set. This string is identical in formatting to the one used by ``$status_format''.
- 6\b6.\b.3\b3.\b.2\b28\b86\b6.\b. w\bwr\bri\bit\bte\be_\b_i\bin\bnc\bc
+5. Functions
- Type: number
- Default: 10
+ The following is the list of available functions listed by the mapping in which they are available. The default key setting is given, and an explanation of what the function does. The key bindings of these functions can be changed with the bind command.
- When writing a mailbox, a message will be printed every _\bw_\br_\bi_\bt_\be_\b__\bi_\bn_\bc
- messages to indicate progress. If set to 0, only a single message
- will be displayed before writing a mailbox.
-
- Also see the ````$read_inc'''' variable.
-
- 6\b6.\b.3\b3.\b.2\b28\b87\b7.\b. w\bwr\bri\bit\bte\be_\b_b\bbc\bcc\bc
-
- Type: boolean
- Default: yes
-
- Controls whether mutt writes out the Bcc header when preparing
- messages to be sent. Exim users may wish to use this.
-
- 6\b6.\b.3\b3.\b.2\b28\b88\b8.\b. x\bx_\b_c\bco\bom\bmm\bme\ben\bnt\bt_\b_t\bto\bo
-
- Type: boolean
- Default: no
-
- If _\bs_\be_\bt, Mutt will add ``X-Comment-To:'' field (that contains full name
- of original article author) to article that followuped to newsgroup.
-
- \e[1m6.4. Functions\e[0m
-
- The following is the list of available functions listed by the mapping
- in which they are available. The default key setting is given, and an
- explanation of what the function does. The key bindings of these
- functions can be changed with the ``bind'' command.
-
- \e[1m6.4.1. generic\e[0m
-
- The \e[4mgeneric\e[24m menu is not a real menu, but specifies common functions
- (such as movement) available in all menus except for \e[4mpager\e[24m and \e[4meditor\e[24m.
- Changing settings for this menu will affect the default bindings for
- all menus (except as noted).
-
- bottom-page L move to the bottom of the page
- current-bottom not bound move current entry to bottom of page
- current-middle not bound move current entry to middle of page
- current-top not bound move current entry to top of page
- enter-command : enter a muttrc command
- exit q exit this menu
- first-entry = move to the first entry
- half-down ] scroll down 1/2 page
- half-up [ scroll up 1/2 page
- help ? this screen
- jump number jump to an index number
- last-entry * move to the last entry
- middle-page M move to the middle of the page
- next-entry j move to the next entry
- next-line > scroll down one line
- next-page z move to the next page
- previous-entry k move to the previous entry
- previous-line < scroll up one line
- previous-page Z move to the previous page
- refresh ^L clear and redraw the screen
- search / search for a regular expression
- search-next n search for next match
- search-opposite not bound search for next match in opposite direction
- search-reverse ESC / search backwards for a regular expression
- select-entry RET select the current entry
- shell-escape ! run a program in a subshell
- tag-entry t toggle the tag on the current entry
- tag-prefix ; apply next command to tagged entries
- tag-prefix-cond not bound apply next function ONLY to tagged messages
- top-page H move to the top of the page
-
- \e[1m6.4.2. index\e[0m
-
- bounce-message b remail a message to another user
- change-folder c open a different folder
- change-folder-readonly ESC c open a different folder in read only mode
- check-traditional-pgp ESC P check for classic pgp
- clear-flag W clear a status flag from a message
- copy-message C copy a message to a file/mailbox
- create-alias a create an alias from a message sender
- decode-copy ESC C decode a message and copy it to a file/mailbox
- decode-save ESC s decode a message and save it to a file/mailbox
- delete-message d delete the current entry
- delete-pattern D delete messages matching a pattern
- delete-subthread ESC d delete all messages in subthread
- delete-thread ^D delete all messages in thread
- display-address @ display full address of sender
- display-toggle-weed h display message and toggle header weeding
- display-message RET display a message
- edit e edit the current message
- edit-type ^E edit the current message's Content-Type
- exit x exit without saving changes
- extract-keys ^K extract PGP public keys
- fetch-mail G retrieve mail from POP server
- flag-message F toggle a message's 'important' flag
- forget-passphrase ^F wipe PGP passphrase from memory
- forward-message f forward a message with comments
- group-reply g reply to all recipients
- limit l show only messages matching a pattern
- list-reply L reply to specified mailing list
- mail m compose a new mail message
- mail-key ESC k mail a PGP public key
- next-new TAB jump to the next new message
- next-subthread ESC n jump to the next subthread
- next-thread ^N jump to the next thread
- next-undeleted j move to the next undeleted message
- next-unread not bound jump to the next unread message
- parent-message P jump to parent message in thread
- pipe-message | pipe message/attachment to a shell command
- previous-new ESC TAB jump to the previous new message
- previous-page Z move to the previous page
- previous-subthread ESC p jump to previous subthread
- previous-thread ^P jump to previous thread
- previous-undeleted k move to the last undelete message
- previous-unread not bound jump to the previous unread message
- print-message p print the current entry
- query Q query external program for addresses
- quit q save changes to mailbox and quit
- read-subthread ESC r mark the current subthread as read
- read-thread ^R mark the current thread as read
- recall-message R recall a postponed message
- reply r reply to a message
- resend-message ESC e resend message and preserve MIME structure
- save-message s save message/attachment to a file
- set-flag w set a status flag on a message
- show-version V show the Mutt version number and date
- show-limit ESC l show currently active limit pattern, if any
- sort-mailbox o sort messages
- sort-reverse O sort messages in reverse order
- sync-mailbox $ save changes to mailbox
- tag-pattern T tag messages matching a pattern
- tag-thread ESC t tag/untag all messages in the current thread
- toggle-new N toggle a message's 'new' flag
- toggle-write % toggle whether the mailbox will be rewritten
- undelete-message u undelete the current entry
- undelete-pattern U undelete messages matching a pattern
- undelete-subthread ESC u undelete all messages in subthread
- undelete-thread ^U undelete all messages in thread
- untag-pattern ^T untag messages matching a pattern
- view-attachments v show MIME attachments
-
- \e[1m6.4.3. pager\e[0m
-
- bottom not bound jump to the bottom of the message
- bounce-message b remail a message to another user
- change-folder c open a different folder
- change-folder-readonly ESC c open a different folder in read only mode
- check-traditional-pgp ESC P check for classic pgp
- copy-message C copy a message to a file/mailbox
- create-alias a create an alias from a message sender
- decode-copy ESC C decode a message and copy it to a file/mailbox
- decode-save ESC s decode a message and save it to a file/mailbox
- delete-message d delete the current entry
- delete-subthread ESC d delete all messages in subthread
- delete-thread ^D delete all messages in thread
- display-address @ display full address of sender
- display-toggle-weed h display message and toggle header weeding
- edit e edit the current message
- edit-type ^E edit the current message's Content-Type
- enter-command : enter a muttrc command
- exit i return to the main-menu
- extract-keys ^K extract PGP public keys
- flag-message F toggle a message's 'important' flag
- forget-passphrase ^F wipe PGP passphrase from memory
- forward-message f forward a message with comments
- group-reply g reply to all recipients
- half-up not bound move up one-half page
- half-down not bound move down one-half page
- help ? this screen
- list-reply L reply to specified mailing list
- mail m compose a new mail message
- mail-key ESC k mail a PGP public key
- mark-as-new N toggle a message's 'new' flag
- next-line RET scroll down one line
- next-entry J move to the next entry
- next-new TAB jump to the next new message
- next-page move to the next page
- next-subthread ESC n jump to the next subthread
- next-thread ^N jump to the next thread
- next-undeleted j move to the next undeleted message
- next-unread not bound jump to the next unread message
- parent-message P jump to parent message in thread
- pipe-message | pipe message/attachment to a shell command
- previous-line BackSpace scroll up one line
- previous-entry K move to the previous entry
- previous-new not bound jump to the previous new message
- previous-page - move to the previous page
- previous-subthread ESC p jump to previous subthread
- previous-thread ^P jump to previous thread
- previous-undeleted k move to the last undelete message
- previous-unread not bound jump to the previous unread message
- print-message p print the current entry
- quit Q save changes to mailbox and quit
- read-subthread ESC r mark the current subthread as read
- read-thread ^R mark the current thread as read
- recall-message R recall a postponed message
- redraw-screen ^L clear and redraw the screen
- reply r reply to a message
- save-message s save message/attachment to a file
- search / search for a regular expression
- search-next n search for next match
- search-opposite not bound search for next match in opposite direction
- search-reverse ESC / search backwards for a regular expression
- search-toggle \ toggle search pattern coloring
- shell-escape ! invoke a command in a subshell
- show-version V show the Mutt version number and date
- skip-quoted S skip beyond quoted text
- sync-mailbox $ save changes to mailbox
- tag-message t tag a message
- toggle-quoted T toggle display of quoted text
- top ^ jump to the top of the message
- undelete-message u undelete the current entry
- undelete-subthread ESC u undelete all messages in subthread
- undelete-thread ^U undelete all messages in thread
- view-attachments v show MIME attachments
-
- \e[1m6.4.4. alias\e[0m
-
- search / search for a regular expression
- search-next n search for next match
- search-reverse ESC / search backwards for a regular expression
-
- \e[1m6.4.5. query\e[0m
-
- create-alias a create an alias from a message sender
- mail m compose a new mail message
- query Q query external program for addresses
- query-append A append new query results to current results
- search / search for a regular expression
- search-next n search for next match
- search-opposite not bound search for next match in opposite direction
- search-reverse ESC / search backwards for a regular expression
-
- \e[1m6.4.6. attach\e[0m
-
- bounce-message b remail a message to another user
- collapse-parts v toggle display of subparts
- delete-entry d delete the current entry
- display-toggle-weed h display message and toggle header weeding
- edit-type ^E edit the current entry's Content-Type
- extract-keys ^K extract PGP public keys
- forward-message f forward a message with comments
- group-reply g reply to all recipients
- list-reply L reply to specified mailing list
- pipe-entry | pipe message/attachment to a shell command
- print-entry p print the current entry
- reply r reply to a message
- resend-message ESC e resend message and preserve MIME structure
- save-entry s save message/attachment to a file
- undelete-entry u undelete the current entry
- view-attach RET view attachment using mailcap entry if necessary
- view-mailcap m force viewing of attachment using mailcap
- view-text T view attachment as text
-
- \e[1m6.4.7. compose\e[0m
-
- attach-file a attach a file(s) to this message
- attach-message A attach message(s) to this message
- attach-key ESC k attach a PGP public key
- copy-file C save message/attachment to a file
- detach-file D delete the current entry
- display-toggle-weed h display message and toggle header weeding
- edit-bcc b edit the BCC list
- edit-cc c edit the CC list
- edit-description d edit attachment description
- edit-encoding ^E edit attachment transfer-encoding
- edit-fcc f enter a file to save a copy of this message in
- edit-from ESC f edit the from: field
- edit-file ^X e edit the file to be attached
- edit-headers E edit the message with headers
- edit e edit the message
- edit-mime m edit attachment using mailcap entry
- edit-reply-to r edit the Reply-To field
- edit-subject s edit the subject of this message
- edit-to t edit the TO list
- edit-type ^T edit attachment type
- filter-entry F filter attachment through a shell command
- forget-passphrase ^F wipe PGP passphrase from memory
- ispell i run ispell on the message
- new-mime n compose new attachment using mailcap entry
- pgp-menu p show PGP options
- pipe-entry | pipe message/attachment to a shell command
- postpone-message P save this message to send later
- print-entry l print the current entry
- rename-file R rename/move an attached file
- send-message y send the message
- toggle-unlink u toggle whether to delete file after sending it
- view-attach RET view attachment using mailcap entry if necessary
- write-fcc w write the message to a folder
-
- \e[1m6.4.8. postpone\e[0m
-
- delete-entry d delete the current entry
- undelete-entry u undelete the current entry
-
- \e[1m6.4.9. browser\e[0m
-
- change-dir c change directories
- check-new TAB check mailboxes for new mail
- enter-mask m enter a file mask
- search / search for a regular expression
- search-next n search for next match
- search-reverse ESC / search backwards for a regular expression
- select-new N select a new file in this directory
- sort o sort messages
- sort-reverse O sort messages in reverse order
- toggle-mailboxes TAB toggle whether to browse mailboxes or all files
- view-file SPACE view file
- subscribe s subscribe to current mailbox (IMAP Only)
- unsubscribe u unsubscribe to current mailbox (IMAP Only)
- toggle-subscribed T toggle view all/subscribed mailboxes (IMAP Only)
-
- \e[1m6.4.10. pgp\e[0m
-
- view-name % view the key's user id
- verify-key c verify a PGP public key
-
- \e[1m6.4.11. editor\e[0m
-
- backspace BackSpace delete the char in front of the cursor
- backward-char ^B move the cursor one character to the left
- backward-word ESC b move the cursor to the previous word
- bol ^A jump to the beginning of the line
- buffy-cycle Space cycle among incoming mailboxes
- capitalize-word ESC c uppercase the first character in the word
- complete TAB complete filename or alias
- complete-query ^T complete address with query
- delete-char ^D delete the char under the cursor
- downcase-word ESC l lowercase all characters in current word
- eol ^E jump to the end of the line
- forward-char ^F move the cursor one character to the right
- forward-word ESC f move the cursor to the next word
- history-down not bound scroll down through the history list
- history-up not bound scroll up through the history list
- kill-eol ^K delete chars from cursor to end of line
- kill-eow ESC d delete chars from cursor to end of word
- kill-line ^U delete all chars on the line
- kill-word ^W delete the word in front of the cursor
- quote-char ^V quote the next typed key
- transpose-chars not bound transpose character under cursor with previous
- upcase-word ESC u uppercase all characters in current word
-
- \e[1m7. Miscellany\e[0m
-
- \e[1m7.1. Acknowledgements\e[0m
-
- Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME
- parsing code back in the ELM-ME days.
-
- The following people have been very helpful to the development of
- Mutt:
-
- Vikas Agnihotri <vikasa@writeme.com>,
- Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>,
- Aric Blumer <aric@fore.com>,
- John Capo <jc@irbs.com>,
- David Champion <dgc@uchicago.edu,
- Brendan Cully <brendan@kublai.com>,
- Liviu Daia <daia@stoilow.imar.ro>,
- Thomas E. Dickey <dickey@herndon4.his.com>,
- David DeSimone <fox@convex.hp.com>,
- Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>,
- Ruslan Ermilov <ru@freebsd.org>,
- Edmund Grimley Evans <edmundo@rano.org,
- Michael Finken <finken@conware.de>,
- Sven Guckes <guckes@math.fu-berlin.de>,
- Lars Hecking <lhecking@nmrc.ie>,
- Mark Holloman <holloman@nando.net>,
- Andreas Holzmann <holzmann@fmi.uni-passau.de>,
- Marco d'Itri <md@linux.it>,
- Björn Jacke <bjacke@suse.com>,
- Byrial Jensen <byrial@image.dk>,
- David Jeske <jeske@igcom.net>,
- Christophe Kalt <kalt@hugo.int-evry.fr>,
- Tommi Komulainen <Tommi.Komulainen@iki.fi>,
- Felix von Leitner (a.k.a ``Fefe'') <leitner@math.fu-berlin.de>,
- Brandon Long <blong@fiction.net>,
- Jimmy Mäkelä <jmy@flashback.net>,
- Lars Marowsky-Bree <lmb@pointer.in-minden.de>,
- Thomas ``Mike'' Michlmayr <mike@cosy.sbg.ac.at>,
- Andrew W. Nosenko <awn@bcs.zp.ua>,
- David O'Brien <obrien@Nuxi.cs.ucdavis.edu>,
- Clint Olsen <olsenc@ichips.intel.com>,
- Park Myeong Seok <pms@romance.kaist.ac.kr>,
- Thomas Parmelan <tom@ankh.fr.eu.org>,
- Ollivier Robert <roberto@keltia.freenix.fr>,
- Thomas Roessler <roessler@does-not-exist.org>,
- Roland Rosenfeld <roland@spinnaker.de>,
- TAKIZAWA Takashi <taki@luna.email.ne.jp>,
- Allain Thivillon <Allain.Thivillon@alma.fr>,
- Gero Treuner <gero@faveve.uni-stuttgart.de>,
- Vsevolod Volkov <vvv@lucky.net>,
- Ken Weinert <kenw@ihs.com>
-
- \e[1m7.2. About this document\e[0m
-
- This document was written in SGML, and then rendered using the sgml-
- tools package.
+5.1. generic
+ The generic menu is not a real menu, but specifies common functions (such as movement) available in all menus except for pager and editor. Changing settings for this menu will affect the default bindings for all menus (except as noted).
+bottom-page L move to the bottom of the page
+current-bottom not bound move current entry to bottom of page
+current-middle not bound move current entry to middle of page
+current-top not bound move current entry to top of page
+enter-command : enter a muttngrc command
+exit q exit this menu
+first-entry = move to the first entry
+half-down ] scroll down 1/2 page
+half-up [ scroll up 1/2 page
+help ? this screen
+jump number jump to an index number
+last-entry * move to the last entry
+middle-page M move to the middle of the page
+next-entry j move to the next entry
+next-line > scroll down one line
+next-page z move to the next page
+previous-entry k move to the previous entry
+previous-line < scroll up one line
+previous-page Z move to the previous page
+refresh ^L clear and redraw the screen
+search / search for a regular expression
+search-next n search for next match
+search-opposite not bound search for next match in opposite direction
+search-reverse ESC / search backwards for a regular expression
+select-entry RET select the current entry
+shell-escape ! run a program in a subshell
+tag-entry t toggle the tag on the current entry
+tag-prefix ; apply next command to tagged entries
+tag-prefix-cond not bound apply next function ONLY to tagged messages
+top-page H move to the top of the page
+what-key not bound display the keycode for a key press
+
+5.2. index
+
+bounce-message b remail a message to another user
+change-folder c open a different folder
+change-folder-readonly ESC c open a different folder in read only mode
+check-traditional-pgp ESC P check for classic pgp
+clear-flag W clear a status flag from a message
+copy-message C copy a message to a file/mailbox
+create-alias a create an alias from a message sender
+decode-copy ESC C decode a message and copy it to a file/mailbox
+decode-save ESC s decode a message and save it to a file/mailbox
+delete-message d delete the current entry
+delete-pattern D delete messages matching a pattern
+delete-subthread ESC d delete all messages in subthread
+delete-thread ^D delete all messages in thread
+display-address @ display full address of sender
+display-toggle-weed h display message and toggle header weeding
+display-message RET display a message
+edit e edit the current message
+edit-type ^E edit the current message's Content-Type
+exit x exit without saving changes
+extract-keys ^K extract PGP public keys
+fetch-mail G retrieve mail from POP server
+flag-message F toggle a message's 'important' flag
+forget-passphrase ^F wipe PGP passphrase from memory
+forward-message f forward a message with comments
+group-reply g reply to all recipients
+limit l show only messages matching a pattern
+list-reply L reply to specified mailing list
+mail m compose a new mail message
+mail-key ESC k mail a PGP public key
+next-new TAB jump to the next new message
+next-subthread ESC n jump to the next subthread
+next-thread ^N jump to the next thread
+next-undeleted j move to the next undeleted message
+next-unread not bound jump to the next unread message
+parent-message P jump to parent message in thread
+pipe-message | pipe message/attachment to a shell command
+previous-new ESC TAB jump to the previous new message
+previous-page Z move to the previous page
+previous-subthread ESC p jump to previous subthread
+previous-thread ^P jump to previous thread
+previous-undeleted k move to the last undelete message
+previous-unread not bound jump to the previous unread message
+print-message p print the current entry
+query Q query external program for addresses
+quit q save changes to mailbox and quit
+read-subthread ESC r mark the current subthread as read
+read-thread ^R mark the current thread as read
+recall-message R recall a postponed message
+reply r reply to a message
+resend-message ESC e resend message and preserve MIME structure
+save-message s save message/attachment to a file
+set-flag w set a status flag on a message
+show-version V show the Mutt-ng version number and date
+show-limit ESC l show currently active limit pattern, if any
+sort-mailbox o sort messages
+sort-reverse O sort messages in reverse order
+sync-mailbox $ save changes to mailbox
+tag-pattern T tag messages matching a pattern
+tag-thread ESC t tag/untag all messages in the current thread
+toggle-new N toggle a message's 'new' flag
+toggle-write % toggle whether the mailbox will be rewritten
+undelete-message u undelete the current entry
+undelete-pattern U undelete messages matching a pattern
+undelete-subthread ESC u undelete all messages in subthread
+undelete-thread ^U undelete all messages in thread
+untag-pattern ^T untag messages matching a pattern
+view-attachments v show MIME attachments
+
+5.3. pager
+
+bottom not bound jump to the bottom of the message
+bounce-message b remail a message to another user
+change-folder c open a different folder
+change-folder-readonly ESC c open a different folder in read only mode
+check-traditional-pgp ESC P check for classic pgp
+copy-message C copy a message to a file/mailbox
+create-alias a create an alias from a message sender
+decode-copy ESC C decode a message and copy it to a file/mailbox
+decode-save ESC s decode a message and save it to a file/mailbox
+delete-message d delete the current entry
+delete-subthread ESC d delete all messages in subthread
+delete-thread ^D delete all messages in thread
+display-address @ display full address of sender
+display-toggle-weed h display message and toggle header weeding
+edit e edit the current message
+edit-type ^E edit the current message's Content-Type
+enter-command : enter a muttngrc command
+exit i return to the main-menu
+extract-keys ^K extract PGP public keys
+flag-message F toggle a message's 'important' flag
+forget-passphrase ^F wipe PGP passphrase from memory
+forward-message f forward a message with comments
+group-reply g reply to all recipients
+half-up not bound move up one-half page
+half-down not bound move down one-half page
+help ? this screen
+list-reply L reply to specified mailing list
+mail m compose a new mail message
+mail-key ESC k mail a PGP public key
+mark-as-new N toggle a message's 'new' flag
+next-line RET scroll down one line
+next-entry J move to the next entry
+next-new TAB jump to the next new message
+next-page move to the next page
+next-subthread ESC n jump to the next subthread
+next-thread ^N jump to the next thread
+next-undeleted j move to the next undeleted message
+next-unread not bound jump to the next unread message
+parent-message P jump to parent message in thread
+pipe-message | pipe message/attachment to a shell command
+previous-line BackSpace scroll up one line
+previous-entry K move to the previous entry
+previous-new not bound jump to the previous new message
+previous-page - move to the previous page
+previous-subthread ESC p jump to previous subthread
+previous-thread ^P jump to previous thread
+previous-undeleted k move to the last undelete message
+previous-unread not bound jump to the previous unread message
+print-message p print the current entry
+quit Q save changes to mailbox and quit
+read-subthread ESC r mark the current subthread as read
+read-thread ^R mark the current thread as read
+recall-message R recall a postponed message
+redraw-screen ^L clear and redraw the screen
+reply r reply to a message
+save-message s save message/attachment to a file
+search / search for a regular expression
+search-next n search for next match
+search-opposite not bound search for next match in opposite direction
+search-reverse ESC / search backwards for a regular expression
+search-toggle \ toggle search pattern coloring
+shell-escape ! invoke a command in a subshell
+show-version V show the Mutt-ng version number and date
+skip-quoted S skip beyond quoted text
+sync-mailbox $ save changes to mailbox
+tag-message t tag a message
+toggle-quoted T toggle display of quoted text
+top ^ jump to the top of the message
+undelete-message u undelete the current entry
+undelete-subthread ESC u undelete all messages in subthread
+undelete-thread ^U undelete all messages in thread
+view-attachments v show MIME attachments
+
+5.4. alias
+
+search / search for a regular expression
+search-next n search for next match
+search-reverse ESC / search backwards for a regular expression
+
+5.5. query
+
+create-alias a create an alias from a message sender
+mail m compose a new mail message
+query Q query external program for addresses
+query-append A append new query results to current results
+search / search for a regular expression
+search-next n search for next match
+search-opposite not bound search for next match in opposite direction
+search-reverse ESC / search backwards for a regular expression
+
+5.6. attach
+
+bounce-message b remail a message to another user
+collapse-parts v toggle display of subparts
+delete-entry d delete the current entry
+display-toggle-weed h display message and toggle header weeding
+edit-type ^E edit the current entry's Content-Type
+extract-keys ^K extract PGP public keys
+forward-message f forward a message with comments
+group-reply g reply to all recipients
+list-reply L reply to specified mailing list
+pipe-entry | pipe message/attachment to a shell command
+print-entry p print the current entry
+reply r reply to a message
+resend-message ESC e resend message and preserve MIME structure
+save-entry s save message/attachment to a file
+undelete-entry u undelete the current entry
+view-attach RET view attachment using mailcap entry if necessary
+view-mailcap m force viewing of attachment using mailcap
+view-text T view attachment as text
+
+5.7. compose
+
+attach-file a attach a file(s) to this message
+attach-message A attach message(s) to this message
+attach-key ESC k attach a PGP public key
+copy-file C save message/attachment to a file
+detach-file D delete the current entry
+display-toggle-weed h display message and toggle header weeding
+edit-bcc b edit the BCC list
+edit-cc c edit the CC list
+edit-description d edit attachment description
+edit-encoding ^E edit attachment transfer-encoding
+edit-fcc f enter a file to save a copy of this message in
+edit-from ESC f edit the from: field
+edit-file ^X e edit the file to be attached
+edit-headers E edit the message with headers
+edit e edit the message
+edit-mime m edit attachment using mailcap entry
+edit-reply-to r edit the Reply-To field
+edit-subject s edit the subject of this message
+edit-to t edit the TO list
+edit-type ^T edit attachment type
+filter-entry F filter attachment through a shell command
+forget-passphrase ^F wipe PGP passphrase from memory
+ispell i run ispell on the message
+new-mime n compose new attachment using mailcap entry
+pgp-menu p show PGP options
+pipe-entry | pipe message/attachment to a shell command
+postpone-message P save this message to send later
+print-entry l print the current entry
+rename-file R rename/move an attached file
+send-message y send the message
+toggle-unlink u toggle whether to delete file after sending it
+view-attach RET view attachment using mailcap entry if necessary
+write-fcc w write the message to a folder
+
+5.8. postpone
+
+delete-entry d delete the current entry
+undelete-entry u undelete the current entry
+
+5.9. browser
+
+change-dir c change directories
+check-new TAB check mailboxes for new mail
+enter-mask m enter a file mask
+search / search for a regular expression
+search-next n search for next match
+search-reverse ESC / search backwards for a regular expression
+select-new N select a new file in this directory
+sort o sort messages
+sort-reverse O sort messages in reverse order
+toggle-mailboxes TAB toggle whether to browse mailboxes or all files
+view-file SPACE view file
+subscribe s subscribe to current mailbox (IMAP Only)
+unsubscribe u unsubscribe to current mailbox (IMAP Only)
+toggle-subscribed T toggle view all/subscribed mailboxes (IMAP Only)
+
+5.10. pgp
+
+view-name % view the key's user id
+verify-key c verify a PGP public key
+
+5.11. editor
+
+backspace BackSpace delete the char in front of the cursor
+backward-char ^B move the cursor one character to the left
+backward-word ESC b move the cursor to the previous word
+bol ^A jump to the beginning of the line
+buffy-cycle Space cycle among incoming mailboxes
+capitalize-word ESC c uppercase the first character in the word
+complete TAB complete filename or alias
+complete-query ^T complete address with query
+delete-char ^D delete the char under the cursor
+downcase-word ESC l lowercase all characters in current word
+eol ^E jump to the end of the line
+forward-char ^F move the cursor one character to the right
+forward-word ESC f move the cursor to the next word
+history-down not bound scroll down through the history list
+history-up not bound scroll up through the history list
+kill-eol ^K delete chars from cursor to end of line
+kill-eow ESC d delete chars from cursor to end of word
+kill-line ^U delete all chars on the line
+kill-word ^W delete the word in front of the cursor
+quote-char ^V quote the next typed key
+transpose-chars not bound transpose character under cursor with previous
+upcase-word ESC u uppercase all characters in current word
+
+Chapter 8. Miscellany
+
+ Table of Contents
+
+ 1. Acknowledgments
+
+1. Acknowledgments
+
+ Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME >parsing code back in the ELM-ME days.
+
+ The following people have been very helpful to the development of Mutt:
+
+ Vikas Agnihotri <vikasa@writeme.com>, Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>, Aric Blumer <aric@fore.com>, John Capo <jc@irbs.com>, David Champion <dgc@uchicago.edu, Brendan Cully <brendan@kublai.com>, Liviu Daia <daia@stoilow.imar.ro>, Thomas E. Dickey <dickey@herndon4.his.com>, David DeSimone <fox@convex.hp.com>, Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>, Ruslan Ermilov <ru@freebsd.org>, Edmund Grimley Evans <edmundo@rano.org, Michael Finken <finken@conware.de>, Sven Guckes <guckes@math.fu-berlin.de>, Lars Hecking <lhecking@nmrc.ie>, Mark Holloman <holloman@nando.net>, Andreas Holzmann <holzmann@fmi.uni-passau.de>, Marco d'Itri <md@linux.it>, Björn Jacke <bjacke@suse.com>, Byrial Jensen <byrial@image.dk>, David Jeske <jeske@igcom.net>, Christophe Kalt <kalt@hugo.int-evry.fr>, Tommi Komulainen <Tommi.Komulainen@iki.fi>, Felix von Leitner (a.k.a ``Fefe'') <leitner@math.fu-berlin.de>, Brandon Long <blong@fiction.net>, Jimmy Mäkelä <jmy@f
+ lashback.net>, Lars Marowsky-Bree <lmb@pointer.in-minden.de>, Thomas ``Mike'' Michlmayr <mike@cosy.sbg.ac.at>, Andrew W. Nosenko <awn@bcs.zp.ua>, David O'Brien <obrien@Nuxi.cs.ucdavis.edu>, Clint Olsen <olsenc@ichips.intel.com>, Park Myeong Seok <pms@romance.kaist.ac.kr>, Thomas Parmelan <tom@ankh.fr.eu.org>, Ollivier Robert <roberto@keltia.freenix.fr>, Thomas Roessler <roessler@does-not-exist.org>, Roland Rosenfeld <roland@spinnaker.de>, TAKIZAWA Takashi <taki@luna.email.ne.jp>, Allain Thivillon <Allain.Thivillon@alma.fr> Gero Treuner <gero@faveve.uni-stuttgart.de>, Vsevolod Volkov <vvv@lucky.net>, Ken Weinert <kenw@ihs.com>
+
+ Mutt-ng is developed by the following people:
+
+ Andreas Krennmair <ak@synflood.at>, Nico Golde <nico@ngolde.de>, Rocco Rutte <pdmef@cs.tu-berlin.de>
+
+ The following people have been very helpful to the development of Mutt-ng:
+
+ Christian Gall <cg@cgall.de>, Iain Lea <iain@bricbrac.de>, Andreas Kneib <akneib@gmx.net>, Carsten Schoelzki <cjs@weisshuhn.de>, Elimar Riesebieter <riesebie@lxtec.de>
projects / apps / madmutt.git / blobdiff