X-Git-Url: https://git.llucax.com/software/mutt-debian.git/blobdiff_plain/14c29200cb58d3c4a0830265f2433849781858d0..7430e8e25ae5bf699cdb09724ba9ac1df2d9e6ae:/doc/reference.html?ds=sidebyside diff --git a/doc/reference.html b/doc/reference.html index e922b90..03e316d 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -1,147 +1,392 @@ -Chapter 8. Reference

Chapter 8. Reference

Table of Contents

1. Command line options
2. Configuration Commands
3. Configuration variables
3.1. abort_nosubject
3.2. abort_unmodified
3.3. alias_file
3.4. alias_format
3.5. allow_8bit
3.6. allow_ansi
3.7. arrow_cursor
3.8. ascii_chars
3.9. askbcc
3.10. askcc
3.11. assumed_charset
3.12. attach_charset
3.13. attach_format
3.14. attach_sep
3.15. attach_split
3.16. attribution
3.17. autoedit
3.18. auto_tag
3.19. beep
3.20. beep_new
3.21. bounce
3.22. bounce_delivered
3.23. braille_friendly
3.24. check_mbox_size
3.25. charset
3.26. check_new
3.27. collapse_unread
3.28. uncollapse_jump
3.29. compose_format
3.30. config_charset
3.31. confirmappend
3.32. confirmcreate
3.33. connect_timeout
3.34. content_type
3.35. copy
3.36. crypt_use_gpgme
3.37. crypt_use_pka
3.38. crypt_autopgp
3.39. crypt_autosmime
3.40. date_format
3.41. default_hook
3.42. delete
3.43. delete_untag
3.44. digest_collapse
3.45. display_filter
3.46. dotlock_program
3.47. dsn_notify
3.48. dsn_return
3.49. duplicate_threads
3.50. edit_headers
3.51. editor
3.52. encode_from
3.53. envelope_from_address
3.54. escape
3.55. fast_reply
3.56. fcc_attach
3.57. fcc_clear
3.58. folder
3.59. folder_format
3.60. followup_to
3.61. force_name
3.62. forward_decode
3.63. forward_edit
3.64. forward_format
3.65. forward_quote
3.66. from
3.67. gecos_mask
3.68. hdrs
3.69. header
3.70. help
3.71. hidden_host
3.72. hide_limited
3.73. hide_missing
3.74. hide_thread_subject
3.75. hide_top_limited
3.76. hide_top_missing
3.77. history
3.78. history_file
3.79. honor_followup_to
3.80. hostname
3.81. ignore_linear_white_space
3.82. ignore_list_reply_to
3.83. imap_authenticators
3.84. imap_check_subscribed
3.85. imap_delim_chars
3.86. imap_headers
3.87. imap_idle
3.88. imap_keepalive
3.89. imap_list_subscribed
3.90. imap_login
3.91. imap_pass
3.92. imap_passive
3.93. imap_peek
3.94. imap_servernoise
3.95. imap_user
3.96. implicit_autoview
3.97. include
3.98. include_onlyfirst
3.99. indent_string
3.100. index_format
3.101. ispell
3.102. keep_flagged
3.103. locale
3.104. mail_check
3.105. mailcap_path
3.106. mailcap_sanitize
3.107. header_cache
3.108. maildir_header_cache_verify
3.109. header_cache_pagesize
3.110. header_cache_compress
3.111. maildir_trash
3.112. mark_old
3.113. markers
3.114. mask
3.115. mbox
3.116. mbox_type
3.117. metoo
3.118. menu_context
3.119. menu_move_off
3.120. menu_scroll
3.121. meta_key
3.122. mh_purge
3.123. mh_seq_flagged
3.124. mh_seq_replied
3.125. mh_seq_unseen
3.126. mime_forward
3.127. mime_forward_decode
3.128. mime_forward_rest
3.129. mix_entry_format
3.130. mixmaster
3.131. move
3.132. message_cachedir
3.133. message_cache_clean
3.134. message_format
3.135. narrow_tree
3.136. net_inc
3.137. pager
3.138. pager_context
3.139. pager_format
3.140. pager_index_lines
3.141. pager_stop
3.142. crypt_autosign
3.143. crypt_autoencrypt
3.144. pgp_ignore_subkeys
3.145. crypt_replyencrypt
3.146. crypt_replysign
3.147. crypt_replysignencrypted
3.148. crypt_timestamp
3.149. pgp_use_gpg_agent
3.150. crypt_verify_sig
3.151. smime_is_default
3.152. smime_ask_cert_label
3.153. smime_decrypt_use_default_key
3.154. pgp_entry_format
3.155. pgp_good_sign
3.156. pgp_check_exit
3.157. pgp_long_ids
3.158. pgp_retainable_sigs
3.159. pgp_autoinline
3.160. pgp_replyinline
3.161. pgp_show_unusable
3.162. pgp_sign_as
3.163. pgp_strict_enc
3.164. pgp_timeout
3.165. pgp_sort_keys
3.166. pgp_mime_auto
3.167. pgp_auto_decode
3.168. pgp_decode_command
3.169. pgp_getkeys_command
3.170. pgp_verify_command
3.171. pgp_decrypt_command
3.172. pgp_clearsign_command
3.173. pgp_sign_command
3.174. pgp_encrypt_sign_command
3.175. pgp_encrypt_only_command
3.176. pgp_import_command
3.177. pgp_export_command
3.178. pgp_verify_key_command
3.179. pgp_list_secring_command
3.180. pgp_list_pubring_command
3.181. forward_decrypt
3.182. smime_timeout
3.183. smime_encrypt_with
3.184. smime_keys
3.185. smime_ca_location
3.186. smime_certificates
3.187. smime_decrypt_command
3.188. smime_verify_command
3.189. smime_verify_opaque_command
3.190. smime_sign_command
3.191. smime_sign_opaque_command
3.192. smime_encrypt_command
3.193. smime_pk7out_command
3.194. smime_get_cert_command
3.195. smime_get_signer_cert_command
3.196. smime_import_cert_command
3.197. smime_get_cert_email_command
3.198. smime_default_key
3.199. ssl_client_cert
3.200. ssl_force_tls
3.201. ssl_starttls
3.202. certificate_file
3.203. ssl_usesystemcerts
3.204. entropy_file
3.205. ssl_use_sslv2
3.206. ssl_use_sslv3
3.207. ssl_use_tlsv1
3.208. ssl_min_dh_prime_bits
3.209. ssl_ca_certificates_file
3.210. pipe_split
3.211. pipe_decode
3.212. pipe_sep
3.213. pop_authenticators
3.214. pop_auth_try_all
3.215. pop_checkinterval
3.216. pop_delete
3.217. pop_host
3.218. pop_last
3.219. pop_reconnect
3.220. pop_user
3.221. pop_pass
3.222. post_indent_string
3.223. postpone
3.224. postponed
3.225. preconnect
3.226. print
3.227. print_command
3.228. print_decode
3.229. print_split
3.230. prompt_after
3.231. query_command
3.232. query_format
3.233. quit
3.234. quote_regexp
3.235. read_inc
3.236. read_only
3.237. realname
3.238. recall
3.239. record
3.240. reply_regexp
3.241. reply_self
3.242. reply_to
3.243. resolve
3.244. reverse_alias
3.245. reverse_name
3.246. reverse_realname
3.247. rfc2047_parameters
3.248. save_address
3.249. save_empty
3.250. save_history
3.251. save_name
3.252. score
3.253. score_threshold_delete
3.254. score_threshold_flag
3.255. score_threshold_read
3.256. send_charset
3.257. sendmail
3.258. sendmail_wait
3.259. shell
3.260. sig_dashes
3.261. sig_on_top
3.262. signature
3.263. simple_search
3.264. smart_wrap
3.265. smileys
3.266. sleep_time
3.267. smtp_authenticators
3.268. smtp_pass
3.269. smtp_url
3.270. sort
3.271. sort_alias
3.272. sort_aux
3.273. sort_browser
3.274. sort_re
3.275. spam_separator
3.276. spoolfile
3.277. status_chars
3.278. status_format
3.279. status_on_top
3.280. strict_threads
3.281. suspend
3.282. text_flowed
3.283. thread_received
3.284. thorough_search
3.285. tilde
3.286. time_inc
3.287. timeout
3.288. tmpdir
3.289. to_chars
3.290. tunnel
3.291. use_8bitmime
3.292. use_domain
3.293. use_envelope_from
3.294. use_from
3.295. use_idn
3.296. use_ipv6
3.297. user_agent
3.298. visual
3.299. wait_key
3.300. weed
3.301. wrap
3.302. wrap_search
3.303. wrapmargin
3.304. write_inc
3.305. write_bcc
4. Functions
4.1. generic
4.2. index
4.3. pager
4.4. alias
4.5. query
4.6. attach
4.7. compose
4.8. postpone
4.9. browser
4.10. pgp
4.11. smime
4.12. mix
4.13. editor

1. Command line options

+Chapter 9. Reference

Chapter 9. Reference

Table of Contents

1. Command-Line Options
2. Configuration Commands
3. Configuration Variables
3.1. abort_nosubject
3.2. abort_unmodified
3.3. alias_file
3.4. alias_format
3.5. allow_8bit
3.6. allow_ansi
3.7. arrow_cursor
3.8. ascii_chars
3.9. askbcc
3.10. askcc
3.11. assumed_charset
3.12. attach_charset
3.13. attach_format
3.14. attach_sep
3.15. attach_split
3.16. attribution
3.17. auto_tag
3.18. autoedit
3.19. beep
3.20. beep_new
3.21. bounce
3.22. bounce_delivered
3.23. braille_friendly
3.24. certificate_file
3.25. charset
3.26. check_mbox_size
3.27. check_new
3.28. collapse_unread
3.29. compose_format
3.30. config_charset
3.31. confirmappend
3.32. confirmcreate
3.33. connect_timeout
3.34. content_type
3.35. copy
3.36. crypt_autoencrypt
3.37. crypt_autopgp
3.38. crypt_autosign
3.39. crypt_autosmime
3.40. crypt_replyencrypt
3.41. crypt_replysign
3.42. crypt_replysignencrypted
3.43. crypt_timestamp
3.44. crypt_use_gpgme
3.45. crypt_use_pka
3.46. crypt_verify_sig
3.47. date_format
3.48. default_hook
3.49. delete
3.50. delete_untag
3.51. digest_collapse
3.52. display_filter
3.53. dotlock_program
3.54. dsn_notify
3.55. dsn_return
3.56. duplicate_threads
3.57. edit_headers
3.58. editor
3.59. encode_from
3.60. entropy_file
3.61. envelope_from_address
3.62. escape
3.63. fast_reply
3.64. fcc_attach
3.65. fcc_clear
3.66. folder
3.67. folder_format
3.68. followup_to
3.69. force_name
3.70. forward_decode
3.71. forward_decrypt
3.72. forward_edit
3.73. forward_format
3.74. forward_quote
3.75. from
3.76. gecos_mask
3.77. hdrs
3.78. header
3.79. header_cache
3.80. header_cache_compress
3.81. header_cache_pagesize
3.82. help
3.83. hidden_host
3.84. hide_limited
3.85. hide_missing
3.86. hide_thread_subject
3.87. hide_top_limited
3.88. hide_top_missing
3.89. history
3.90. history_file
3.91. honor_disposition
3.92. honor_followup_to
3.93. hostname
3.94. ignore_linear_white_space
3.95. ignore_list_reply_to
3.96. imap_authenticators
3.97. imap_check_subscribed
3.98. imap_delim_chars
3.99. imap_headers
3.100. imap_idle
3.101. imap_keepalive
3.102. imap_list_subscribed
3.103. imap_login
3.104. imap_pass
3.105. imap_passive
3.106. imap_peek
3.107. imap_pipeline_depth
3.108. imap_servernoise
3.109. imap_user
3.110. implicit_autoview
3.111. include
3.112. include_onlyfirst
3.113. indent_string
3.114. index_format
3.115. ispell
3.116. keep_flagged
3.117. locale
3.118. mail_check
3.119. mailcap_path
3.120. mailcap_sanitize
3.121. maildir_header_cache_verify
3.122. maildir_trash
3.123. mark_old
3.124. markers
3.125. mask
3.126. mbox
3.127. mbox_type
3.128. menu_context
3.129. menu_move_off
3.130. menu_scroll
3.131. message_cache_clean
3.132. message_cachedir
3.133. message_format
3.134. meta_key
3.135. metoo
3.136. mh_purge
3.137. mh_seq_flagged
3.138. mh_seq_replied
3.139. mh_seq_unseen
3.140. mime_forward
3.141. mime_forward_decode
3.142. mime_forward_rest
3.143. mix_entry_format
3.144. mixmaster
3.145. move
3.146. narrow_tree
3.147. net_inc
3.148. pager
3.149. pager_context
3.150. pager_format
3.151. pager_index_lines
3.152. pager_stop
3.153. pgp_auto_decode
3.154. pgp_autoinline
3.155. pgp_check_exit
3.156. pgp_clearsign_command
3.157. pgp_decode_command
3.158. pgp_decrypt_command
3.159. pgp_encrypt_only_command
3.160. pgp_encrypt_sign_command
3.161. pgp_entry_format
3.162. pgp_export_command
3.163. pgp_getkeys_command
3.164. pgp_good_sign
3.165. pgp_ignore_subkeys
3.166. pgp_import_command
3.167. pgp_list_pubring_command
3.168. pgp_list_secring_command
3.169. pgp_long_ids
3.170. pgp_mime_auto
3.171. pgp_replyinline
3.172. pgp_retainable_sigs
3.173. pgp_show_unusable
3.174. pgp_sign_as
3.175. pgp_sign_command
3.176. pgp_sort_keys
3.177. pgp_strict_enc
3.178. pgp_timeout
3.179. pgp_use_gpg_agent
3.180. pgp_verify_command
3.181. pgp_verify_key_command
3.182. pipe_decode
3.183. pipe_sep
3.184. pipe_split
3.185. pop_auth_try_all
3.186. pop_authenticators
3.187. pop_checkinterval
3.188. pop_delete
3.189. pop_host
3.190. pop_last
3.191. pop_pass
3.192. pop_reconnect
3.193. pop_user
3.194. post_indent_string
3.195. postpone
3.196. postponed
3.197. preconnect
3.198. print
3.199. print_command
3.200. print_decode
3.201. print_split
3.202. prompt_after
3.203. query_command
3.204. query_format
3.205. quit
3.206. quote_regexp
3.207. read_inc
3.208. read_only
3.209. realname
3.210. recall
3.211. record
3.212. reply_regexp
3.213. reply_self
3.214. reply_to
3.215. resolve
3.216. reverse_alias
3.217. reverse_name
3.218. reverse_realname
3.219. rfc2047_parameters
3.220. save_address
3.221. save_empty
3.222. save_history
3.223. save_name
3.224. score
3.225. score_threshold_delete
3.226. score_threshold_flag
3.227. score_threshold_read
3.228. search_context
3.229. send_charset
3.230. sendmail
3.231. sendmail_wait
3.232. shell
3.233. sig_dashes
3.234. sig_on_top
3.235. signature
3.236. simple_search
3.237. sleep_time
3.238. smart_wrap
3.239. smileys
3.240. smime_ask_cert_label
3.241. smime_ca_location
3.242. smime_certificates
3.243. smime_decrypt_command
3.244. smime_decrypt_use_default_key
3.245. smime_default_key
3.246. smime_encrypt_command
3.247. smime_encrypt_with
3.248. smime_get_cert_command
3.249. smime_get_cert_email_command
3.250. smime_get_signer_cert_command
3.251. smime_import_cert_command
3.252. smime_is_default
3.253. smime_keys
3.254. smime_pk7out_command
3.255. smime_sign_command
3.256. smime_sign_opaque_command
3.257. smime_timeout
3.258. smime_verify_command
3.259. smime_verify_opaque_command
3.260. smtp_authenticators
3.261. smtp_pass
3.262. smtp_url
3.263. sort
3.264. sort_alias
3.265. sort_aux
3.266. sort_browser
3.267. sort_re
3.268. spam_separator
3.269. spoolfile
3.270. ssl_ca_certificates_file
3.271. ssl_client_cert
3.272. ssl_force_tls
3.273. ssl_min_dh_prime_bits
3.274. ssl_starttls
3.275. ssl_use_sslv2
3.276. ssl_use_sslv3
3.277. ssl_use_tlsv1
3.278. ssl_usesystemcerts
3.279. ssl_verify_dates
3.280. ssl_verify_host
3.281. status_chars
3.282. status_format
3.283. status_on_top
3.284. strict_threads
3.285. suspend
3.286. text_flowed
3.287. thorough_search
3.288. thread_received
3.289. tilde
3.290. time_inc
3.291. timeout
3.292. tmpdir
3.293. to_chars
3.294. tunnel
3.295. uncollapse_jump
3.296. use_8bitmime
3.297. use_domain
3.298. use_envelope_from
3.299. use_from
3.300. use_idn
3.301. use_ipv6
3.302. user_agent
3.303. visual
3.304. wait_key
3.305. weed
3.306. wrap
3.307. wrap_search
3.308. wrapmargin
3.309. write_bcc
3.310. write_inc
4. Functions
4.1. Generic Menu
4.2. Index Menu
4.3. Pager Menu
4.4. Alias Menu
4.5. Query Menu
4.6. Attach Menu
4.7. Compose Menu
4.8. Postpone Menu
4.9. Browser Menu
4.10. Pgp Menu
4.11. Smime Menu
4.12. Mix Menu
4.13. Editor Menu

1. Command-Line Options

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. -

- -

Table 8.1. Command line options

OptionDescription
-Aexpand an alias
-aattach a file to a message
-bspecify a blind carbon-copy (BCC) address
-cspecify a carbon-copy (Cc) address
-Dprint the value of all mutt variables to stdout
-especify a config command to be run after initialization files are read
-fspecify a mailbox to load
-Fspecify an alternate file to read initialization commands
-hprint help on command line options
-Hspecify a draft file from which to read a header and body
-ispecify a file to include in a message composition
-mspecify a default mailbox type
-ndo not read the system Muttrc
-precall a postponed message
-Qquery a configuration variable
-Ropen mailbox in read-only mode
-sspecify a subject (enclose in quotes if it contains spaces)
-vshow version number and compile-time definitions
-xsimulate the mailx(1) compose mode
-yshow a menu containing the files specified by the mailboxes command
-zexit immediately if there are no messages in the mailbox
-Zopen the first folder with new message,exit immediately if none


- -

+

Table 9.1. Command line options

OptionDescription
-Aexpand an alias
-aattach a file to a message
-bspecify a blind carbon-copy (BCC) address
-cspecify a carbon-copy (Cc) address
-Dprint the value of all Mutt variables to stdout
-especify a config command to be run after initialization files are read
-fspecify a mailbox to load
-Fspecify an alternate file to read initialization commands
-hprint help on command line options
-Hspecify a draft file from which to read a header and body
-ispecify a file to include in a message composition
-mspecify a default mailbox type
-ndo not read the system Muttrc
-precall a postponed message
-Qquery a configuration variable
-Ropen mailbox in read-only mode
-sspecify a subject (enclose in quotes if it contains spaces)
-vshow version number and compile-time definitions
-xsimulate the mailx(1) compose mode
-yshow a menu containing the files specified by the mailboxes command
-zexit immediately if there are no messages in the mailbox
-Zopen the first folder with new message, exit immediately if none

To read messages in a mailbox -

-mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ] -

+

mutt [-nz] [-F +muttrc +] [-m +type +] [-f +mailbox +]

To compose a new message -

-mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s subject ] -[ [ file ... ] -- ] address [ address ... ] -

-Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect +

mutt [-n] [-F +muttrc +] [-c +address +] [-i +filename +] [-s +subject +] [ +-a +file + [...] +-- +] +address +...

+Mutt also supports a “batch” mode to send prepared messages. Simply redirect input from the file you wish to send. For example, -

-mutt -s "data set for run #2" professor@bigschool.edu -< ˜/run2.dat -

-This command will send a message to ``professor@bigschool.edu'' with a subject -of ``data set for run #2''. In the body of the message will be the contents -of the file ``˜/run2.dat''. -

-All files passed with -a file will be attached as a MIME -part to the message. To attach several files, use ``--'' to separate files and -recipient addresses: mutt -a *.png -- some@one.org -

2. Configuration Commands

-The following are the commands understood by mutt. -

- -

- -

3. Configuration variables

3.1. abort_nosubject

Type: quadoption
+

+mutt -s "data set for run #2" professor@bigschool.edu < ˜/run2.dat

+will send a message to <professor@bigschool.edu> with a subject +of “data set for run #2”. In the body of the message will be the contents +of the file “˜/run2.dat”. +

+All files passed with -a file will be attached as a MIME +part to the message. To attach a single or several files, use “--” to separate files and +recipient addresses: +

+mutt -a image.png -- some@one.org

+or +

+mutt -a *.png -- some@one.org

Note

+The -a option must be last in the option list. +

2. Configuration Commands

+The following are the commands understood by Mutt: +

  • account-hook +pattern +command +

  • alias [ +-group +name +...] +key + +address + [ +address +...]
    unalias [ +-group +name +...] { +* + | +key +... }

  • alternates [ +-group +name +...] +regexp + [ +regexp +...]
    unalternates [ +-group +name +...] { +* + | +regexp +... }

  • alternative-order +mimetype + [ +mimetype +...]
    unalternative-order { +* + | +mimetype +... }

  • attachments +{ + | - }disposition + +mime-type +
    unattachments +{ + | - }disposition + +mime-type +

  • auto-view +mimetype + [ +mimetype +...]
    unauto-view { +* + | +mimetype +... }

  • bind +map + +key + +function +

  • charset-hook +alias + +charset +

  • iconv-hook +charset + +local-charset +

  • color +object + +foreground + +background +
    color { +header + | +body + } +foreground + +background + +regexp +
    color +index + +foreground + +background + +pattern +
    uncolor { +index + | +header + | +body + } { +* + | +pattern +... }

  • crypt-hook +pattern + +keyid +

  • exec +function + [ +function +...]

  • fcc-hook +[!]pattern + +mailbox +

  • fcc-save-hook +[!]pattern + +mailbox +

  • folder-hook +[!]regexp + +command +

  • group [ +-group +name +...] { +-rx +expr +... | +-addr +expr +... }
    ungroup [ +-group +name +...] { +* + | +-rx +expr +... | +-addr +expr +... }

  • hdr_order +header + [ +header +...]
    unhdr_order { +* + | +header +... }

  • ignore +pattern + [ +pattern +...]
    unignore { +* + | +pattern +... }

  • lists [ +-group +name +] +regexp + [ +regexp +...]
    unlists [ +-group +name +...] { +* + | +regexp +... }

  • macro +menu + +key + +sequence + [ +description +]

  • mailboxes +mailbox + [ +mailbox +...]
    unmailboxes { +* + | +mailbox +... }

  • mbox-hook +[!]pattern + +mailbox +

  • message-hook +[!]pattern + +command +

  • mime-lookup +mimetype + [ +mimetype +...]
    unmime-lookup { +* + | +mimetype +... }

  • mono +object + +attribute +
    mono { +header + | +body + } +attribute + +regexp +
    mono +index + +attribute + +pattern +
    unmono { +index + | +header + | +body + } { +* + | +pattern +... }

  • my_hdr +string +
    unmy_hdr { +* + | +field +... }

  • push +string +

  • save-hook +[!]pattern + +mailbox +

  • score +pattern + +value +
    unscore { +* + | +pattern +... }

  • reply-hook +[!]pattern + +command +

  • send-hook +[!]pattern + +command +

  • send2-hook +[!]pattern + +command +

  • set { +[ no | inv ] +variable + | +variable=value + } [...]
    toggle +variable + [ +variable +...]
    unset +variable + [ +variable +...]
    reset +variable + [ +variable +...]

  • source +filename +

  • spam +pattern + +format +
    nospam { +* + | +pattern + }

  • subscribe [ +-group +name +...] +regexp + [ +regexp +...]
    unsubscribe [ +-group +name +...] { +* + | +regexp +... }

  • unhook { +* + | +hook-type + }

3. Configuration Variables

3.1. abort_nosubject

Type: quadoption
Default: ask-yes

If set to yes, when composing messages and no subject is given at the subject prompt, composition will be aborted. If set to @@ -154,153 +399,166 @@ 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.

3.3. alias_file

Type: path
-Default: "˜/.muttrc"

-The default file in which to save aliases created by the -``create-alias'' function. +Default: “˜/.muttrc”

+The default file in which to save aliases created by the +<create-alias> function. Entries added to this file are +encoded in the character set specified by $config_charset if it +is set or the current character set otherwise.

Note: Mutt will not automatically source this file; you must -explicitly use the ``source'' command for it to be executed. +explicitly use the “source” command for it to be executed in case +this option points to a dedicated alias file.

The default for this option is the currently used muttrc file, or -``˜/.muttrc'' if no user muttrc was found. +“˜/.muttrc” if no user muttrc was found.

3.4. alias_format

Type: string
-Default: "%4n %2f %t %-10a   %r"

-Specifies the format of the data displayed for the `alias' menu. The -following printf(3)-style sequences are available: -

+Default: “%4n %2f %t %-10a   %r”

+Specifies the format of the data displayed for the “alias” menu. The +following printf(3)-style sequences are available: -

%a

alias name -

%f

flags - currently, a "d" for an alias marked for deletion -

%n

index number -

%r

address which alias expands to -

%t

character which indicates if the alias is tagged for inclusion -

-

3.5. allow_8bit

Type: boolean
+

%a alias name +
%f flags - currently, a “d” for an alias marked for deletion +
%n index number +
%r address which alias expands to +
%t character which indicates if the alias is tagged for inclusion +

3.5. allow_8bit

Type: boolean
Default: yes

Controls whether 8-bit data is converted to 7-bit using either Quoted- Printable or Base64 encoding when sending mail.

3.6. allow_ansi

Type: boolean
Default: no

-Controls whether ANSI color codes in messages (and color tags in +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, +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. +message could include a line like + +

+[-- PGP output follows ...
+

+and give it the same color as your attachment color (see also +$crypt_timestamp).

3.7. arrow_cursor

Type: boolean
Default: no

-When set, an arrow (``->'') will be used to indicate the current entry +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.

3.8. ascii_chars

Type: boolean
Default: no

-If set, Mutt will use plain ASCII characters when displaying thread +If set, Mutt will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters.

3.9. askbcc

Type: boolean
Default: no

-If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients +If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message.

3.10. askcc

Type: boolean
Default: no

-If set, Mutt will prompt you for carbon-copy (Cc) recipients before +If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message.

3.11. assumed_charset

Type: string
-Default: ""

+Default: (empty)

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". +indication are assumed to be in “us-ascii”.

For example, Japanese users might prefer this: -

+ +

 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
-

+

However, only the first content is valid for the message body.

3.12. attach_charset

Type: string
-Default: ""

+Default: (empty)

This variable is a colon-separated list of character encoding -schemes for text file attachments. -If unset, $charset value will be used instead. +schemes for text file attachments. Mutt uses this setting to guess +which encoding files being attached are encoded in to convert them to +a proper character set given in $send_charset. +

+If unset, the value of $charset will be used instead. For example, the following configuration would work for Japanese text handling: -

+ +

 set attach_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. +

+Note: for Japanese users, “iso-2022-*” must be put at the head +of the value as shown above if included.

3.13. attach_format

Type: string
-Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "

-This variable describes the format of the `attachment' menu. The -following printf-style sequences are understood: -

- -

%C

charset -

%c

requires charset conversion (n or c) -

%D

deleted flag -

%d

description -

%e

MIME content-transfer-encoding -

%f

filename -

%I

disposition (I=inline, A=attachment) -

%m

major MIME type -

%M

MIME subtype -

%n

attachment number -

%Q

"Q", if MIME part qualifies for attachment counting -

%s

size -

%t

tagged flag -

%T

graphic tree characters -

%u

unlink (=to delete) flag -

%X

number of qualifying MIME parts in this part and its children -(please see the ``attachments'' section for possible speed effects) -

%>X

right justify the rest of the string and pad with character "X" -

%|X

pad to the end of the line with character "X" -

%*X

soft-fill with character "X" as pad -

- -

-For an explanation of `soft-fill', see the ``$index_format'' documentation. +Default: “%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] ”

+This variable describes the format of the “attachment” menu. The +following printf(3)-style sequences are understood: + +

%C charset +
%c requires charset conversion (“n” or “c”) +
%D deleted flag +
%d description +
%e MIME content-transfer-encoding +
%f filename +
%I disposition (“I” for inline, “A” for attachment) +
%m major MIME type +
%M MIME subtype +
%n attachment number +
%Q “Q”, if MIME part qualifies for attachment counting +
%s size +
%t tagged flag +
%T graphic tree characters +
%u unlink (=to delete) flag +
%X number of qualifying MIME parts in this part and its children +(please see the “attachments” section for possible speed effects) +
%>X right justify the rest of the string and pad with character “X” +
%|X pad to the end of the line with character “X” +
%*X soft-fill with character “X” as pad +

+For an explanation of “soft-fill”, see the $index_format documentation.

3.14. attach_sep

Type: string
-Default: "\n"

+Default: “\n”

The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments.

3.15. attach_split

Type: boolean
Default: yes

-If this variable is unset, when operating (saving, printing, piping, +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, +$attach_sep separator is added after each attachment. When set, Mutt will operate on the attachments one by one.

3.16. attribution

Type: string
-Default: "On %d, %n wrote:"

+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()-like sequences see -the section on ``$index_format''. -

3.17. autoedit

Type: boolean
+in a reply. For a full listing of defined printf(3)-like sequences see +the section on $index_format. +

3.17. 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 (bound to “;” +by default) to make the next function apply to all tagged messages. +

3.18. autoedit

Type: boolean
Default: no

-When set along with ``$edit_headers'', Mutt will skip the initial -send-menu and allow you to immediately begin editing the body of your +When set along with $edit_headers, Mutt will skip the initial +send-menu (prompting for subject and recipients) 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''. -

3.18. 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. +Note: when this option is set, you cannot use send-hooks that depend +on the recipients when composing a new (non-reply) message, as the initial +list of recipients is empty. +

+Also see $fast_reply.

3.19. beep

Type: boolean
Default: yes

-When this variable is set, mutt will beep when an error occurs. +When this variable is set, mutt will beep when an error occurs.

3.20. beep_new

Type: boolean
Default: no

-When this variable is set, mutt will beep whenever it prints a message +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. +$beep variable.

3.21. bounce

Type: quadoption
Default: ask-yes

Controls whether you will be asked to confirm bouncing messages. @@ -309,24 +567,55 @@ message. Setting this variable to no is n and thus not recommended, because you are unable to bounce messages.

3.22. bounce_delivered

Type: boolean
Default: yes

-When this variable is set, mutt will include Delivered-To headers when -bouncing messages. Postfix users may wish to unset this variable. +When this variable is set, mutt will include Delivered-To headers when +bouncing messages. Postfix users may wish to unset this variable.

3.23. 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 +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 unset by default because many visual terminals don't permit making the cursor invisible. -

3.24. check_mbox_size

Type: boolean
-Default: no

-When this variable is set, mutt will use file size attribute instead of -access time when checking for new mail. -

3.25. charset

Type: string
-Default: ""

+

3.24. certificate_file

Type: path
+Default: “˜/.mutt_certificates”

+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 is +also automatically accepted. +

+Example: + +

+set certificate_file=~/.mutt/certificates
+

3.25. charset

Type: string
+Default: (empty)

Character set your terminal uses to display and enter textual data. -It is also the fallback for $send_charset. -

3.26. check_new

Type: boolean
+It is also the fallback for $send_charset. +

+Upon startup Mutt tries to derive this value from environment variables +such as $LC_CTYPE or $LANG. +

+Note: It should only be set in case Mutt isn't abled to determine the +character set used correctly. +

3.26. check_mbox_size

Type: boolean
+Default: no

+When this variable is set, mutt will use file size attribute instead of +access time when checking for new mail in mbox and mmdf folders. +

+This variable is unset by default and should only be enabled when +new mail detection for these folder types is unreliable or doesn't work. +

+Note that enabling this variable should happen before any “mailboxes” +directives occur in configuration files regarding mbox or mmdf folders +because mutt needs to determine the initial new mail status of such a +mailbox by performing a fast mailbox scan when it is defined. +Afterwards the new mail status is tracked by file size changes. +

3.27. check_new

Type: boolean
Default: yes

Note: this option only affects maildir and MH style mailboxes. @@ -335,131 +624,188 @@ When set, Mutt will check for new mail de 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 -check_new is unset, no check for new mail is performed +this variable is unset, no check for new mail is performed while the mailbox is open. -

3.27. collapse_unread

Type: boolean
+

3.28. collapse_unread

Type: boolean
Default: yes

When unset, Mutt will not collapse a thread if it contains any unread messages. -

3.28. uncollapse_jump

Type: boolean
-Default: no

-When set, Mutt will jump to the next unread message, if any, -when the current thread is uncollapsed.

3.29. compose_format

Type: string
-Default: "-- Mutt: 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()-like sequences: -

- -

%a

total number of attachments -

%h

local hostname -

%l

approximate size (in bytes) of the current message -

%v

Mutt version string -

- -

-See the text describing the ``$status_format'' option for more -information on how to set ``$compose_format''. +Default: “-- Mutt: 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 version string +

+See the text describing the $status_format option for more +information on how to set $compose_format.

3.30. config_charset

Type: string
-Default: ""

+Default: (empty)

When defined, Mutt will recode commands in rc files from this -encoding. +encoding to the current character set as specified by $charset +and aliases written to $alias_file from the current character set. +

+Please note that if setting $charset it must be done before +setting $config_charset. +

+Recoding should be avoided as it may render unconvertable +characters as question marks which can lead to undesired +side effects (for example in regular expressions).

3.31. confirmappend

Type: boolean
Default: yes

-When set, Mutt will prompt for confirmation when appending messages to +When set, Mutt will prompt for confirmation when appending messages to an existing mailbox.

3.32. confirmcreate

Type: boolean
Default: yes

-When set, Mutt will prompt for confirmation when saving messages to a +When set, Mutt will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it.

3.33. connect_timeout

Type: number
Default: 30

-Causes Mutt to timeout a network connection (for IMAP or POP) after this +Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) 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. +value causes Mutt to wait indefinitely for the connection attempt to succeed.

3.34. content_type

Type: string
-Default: "text/plain"

+Default: “text/plain”

Sets the default Content-Type for the body of newly composed messages.

3.35. 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''. -

3.36. crypt_use_gpgme

Type: boolean
+will be saved for later references. Also see $record, +$save_name, $force_name and “fcc-hook”. +

3.36. crypt_autoencrypt

Type: boolean
+Default: no

+Setting this variable will cause Mutt 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 instead. +(Crypto only) +

3.37. crypt_autopgp

Type: boolean
+Default: yes

+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. +

3.38. crypt_autosign

Type: boolean
+Default: no

+Setting this variable will cause Mutt 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 instead of the pgp menu. +(Crypto only) +

3.39. crypt_autosmime

Type: boolean
+Default: yes

+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. +

3.40. crypt_replyencrypt

Type: boolean
+Default: yes

+If set, automatically PGP or OpenSSL encrypt replies to messages which are +encrypted. +(Crypto only) +

3.41. 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) +

3.42. 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 is not able +to find out whether an encrypted message is also signed. +(Crypto only) +

3.43. crypt_timestamp

Type: boolean
+Default: yes

+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) +

3.44. crypt_use_gpgme

Type: boolean
Default: no

This variable controls the use of the GPGME-enabled crypto backends. -If it is set and Mutt was built with gpgme support, the gpgme code for +If it is set and Mutt was built with gpgme support, the gpgme code for S/MIME and PGP will be used instead of the classic code. Note that -you need to set this option in .muttrc; it won't have any effect when +you need to set this option in .muttrc; it won't have any effect when used interactively. -

3.37. crypt_use_pka

Type: boolean
+

3.45. crypt_use_pka

Type: boolean
Default: no

-(http://www.g10code.de/docs/pka-intro.de.pdf) during signature +Controls whether mutt uses PKA +(see http://www.g10code.de/docs/pka-intro.de.pdf) during signature verification (only supported by the GPGME backend). -

3.38. crypt_autopgp

Type: boolean
-Default: yes

-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''. -

3.39. crypt_autosmime

Type: boolean
+

3.46. crypt_verify_sig

Type: quadoption
Default: yes

-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''. -

3.40. 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 the strftime -call to process the date. See the man page for strftime(3) for -the proper syntax. -

-Unless the first character in the string is a bang (``!''), the month +If “yes”, always attempt to verify PGP or S/MIME signatures. +If “ask-*”, ask whether or not to verify the signature. +If \Fi“no”, never attempt to verify cryptographic signatures. +(Crypto only) +

3.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 the strftime(3) +function to process the date, see the man page for the proper syntax. +

+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 +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). -

3.41. default_hook

Type: string
-Default: "˜f %s !˜P | (˜P ˜C %s)"

-This variable controls how message-hooks, reply-hooks, send-hooks, -send2-hooks, save-hooks, and fcc-hooks will +

3.48. default_hook

Type: string
+Default: “˜f %s !˜P | (˜P ˜C %s)”

+This variable controls how “message-hook”, “reply-hook”, “send-hook”, +“send2-hook”, “save-hook”, and “fcc-hook” 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 +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 +“alternates”) and is to or cc'ed to a user matching the given regular expression. -

3.42. delete

Type: quadoption
+

3.49. 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. -

3.43. delete_untag

Type: boolean
+

3.50. delete_untag

Type: boolean
Default: yes

If this option is set, 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. -

3.44. digest_collapse

Type: boolean
+

3.51. digest_collapse

Type: boolean
Default: yes

If this option is set, mutt'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. -

3.45. display_filter

Type: path
-Default: ""

+individual messages in a multipart/digest. To see these subparts, press “v” on that menu. +

3.52. display_filter

Type: path
+Default: (empty)

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 +is viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output. -

3.46. dotlock_program

Type: path
-Default: "/usr/local/bin/mutt_dotlock"

-Contains the path of the mutt_dotlock (8) binary to be used by +

3.53. dotlock_program

Type: path
+Default: “/usr/local/bin/mutt_dotlock”

+Contains the path of the mutt_dotlock(8) binary to be used by mutt. -

3.47. dsn_notify

Type: string
-Default: ""

+

3.54. dsn_notify

Type: string
+Default: (empty)

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, @@ -467,186 +813,228 @@ of the following: never, to never request delay, to be notified of message delays, success, to be notified of successful transmission.

-Example: set dsn_notify="failure,delay" -

-Note: when using $sendmail for delivery, you should not enable +Example: + +

+set dsn_notify="failure,delay"
+

+Note: when using $sendmail for delivery, you should not enable this unless you are either using Sendmail 8.8.x or greater or a MTA -providing a sendmail(1)-compatible interface supporting the -N option -for DSN. For SMTP delivery, it depends on the server whether DSN is -supported or not. -

3.48. dsn_return

Type: string
-Default: ""

+providing a sendmail(1)-compatible interface supporting the -N option +for DSN. For SMTP delivery, DSN support is autodetected so that it +depends on the server whether DSN will be used or not. +

3.55. dsn_return

Type: string
+Default: (empty)

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 -

-Note: when using $sendmail for delivery, you should not enable +Example: + +

+set dsn_return=hdrs
+

+Note: when using $sendmail for delivery, you should not enable this unless you are either using Sendmail 8.8.x or greater or a MTA -providing a sendmail(1)-compatible interface supporting the -R option -for DSN. For SMTP delivery, it depends on the server whether DSN is -supported or not. -

3.49. duplicate_threads

Type: boolean
+providing a sendmail(1)-compatible interface supporting the -R option +for DSN. For SMTP delivery, DSN support is autodetected so that it +depends on the server whether DSN will be used or not. +

3.56. duplicate_threads

Type: boolean
Default: yes

-This variable controls whether mutt, when sorting by threads, threads -messages with the same message-id together. If it is set, it will indicate +This variable controls whether mutt, when $sort is set to 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. -

3.50. edit_headers

Type: boolean
+in the thread tree. +

3.57. 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.

Note that changes made to the References: and Date: headers are ignored for interoperability reasons. -

3.51. editor

Type: path
-Default: ""

+

3.58. editor

Type: path
+Default: (empty)

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. -

3.52. encode_from

Type: boolean
+It defaults to the value of the $VISUAL, or $EDITOR, environment +variable, or to the string “vi” if neither of those are set. +

3.59. encode_from

Type: boolean
Default: no

When set, 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. -

3.53. envelope_from_address

Type: e-mail address
-Default: ""

+they contain the string “From ” (note the trailing space) in the beginning of a line. +This is useful to avoid the tampering certain mail delivery and transport +agents tend to do with messages (in order to prevent tools from +misinterpreting the line as a mbox message separator). +

3.60. entropy_file

Type: path
+Default: (empty)

+The file which includes random data that is used to initialize SSL +library functions. +

3.61. envelope_from_address

Type: e-mail address
+Default: (empty)

Manually sets the envelope sender for outgoing messages. -This value is ignored if ``$use_envelope_from'' is unset. -

3.54. escape

Type: string
-Default: "˜"

+This value is ignored if $use_envelope_from is unset. +

3.62. escape

Type: string
+Default: “˜”

Escape character to use for functions in the builtin editor. -

3.55. fast_reply

Type: boolean
+

3.63. fast_reply

Type: boolean
Default: no

-When set, the initial prompt for recipients and subject are skipped +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. -

3.56. fcc_attach

Type: boolean
+Note: this variable has no effect when the $autoedit +variable is set. +

3.64. fcc_attach

Type: quadoption
Default: yes

This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message. -

3.57. fcc_clear

Type: boolean
+

3.65. fcc_clear

Type: boolean
Default: no

-When this variable is set, FCCs will be stored unencrypted and +When this variable is set, FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed. (PGP only) -

3.58. folder

Type: path
-Default: "˜/Mail"

-Specifies the default location of your mailboxes. A `+' or `=' at the +

3.66. 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 +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. -

3.59. folder_format

Type: string
-Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"

+you use “+” or “=” for any other variables since expansion takes place +when handling the “mailboxes” command. +

3.67. 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()-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" -

%*X

soft-fill with character "X" as pad -

- -

-For an explanation of `soft-fill', see the ``$index_format'' documentation. -

3.60. followup_to

Type: boolean
-Default: yes

-Controls whether or not the Mail-Followup-To header field is +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 (“/” is appended to directory names, +“@” to symbolic links and “*” to executable +files) +
%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” +
%*X soft-fill with character “X” as pad +

+For an explanation of “soft-fill”, see the $index_format documentation. +

3.68. followup_to

Type: boolean
+Default: yes

+Controls whether or not the “Mail-Followup-To:” header field is generated when sending mail. When set, Mutt will generate this field when you are replying to a known mailing list, specified with -the ``subscribe'' or ``lists'' commands. +the “subscribe” or “lists” commands.

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 +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. -

3.61. force_name

Type: boolean
+

3.69. force_name

Type: boolean
Default: no

-This variable is similar to ``$save_name'', except that Mutt will +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.

-Also see the ``$record'' variable. -

3.62. forward_decode

Type: boolean
+Also see the $record variable. +

3.70. forward_decode

Type: boolean
Default: yes

-Controls the decoding of complex MIME messages into text/plain when +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. -

3.63. forward_edit

Type: quadoption
+This variable is only used, if $mime_forward is unset, +otherwise $mime_forward_decode is used instead. +

3.71. 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) +

3.72. 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''. -

3.64. forward_format

Type: string
-Default: "[%a: %s]"

+to forward with no modification, use a setting of “no”. +

3.73. 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. -

3.65. 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''. -

3.66. from

Type: e-mail address
-Default: ""

-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. -

-Defaults to the contents of the environment variable EMAIL. -

3.67. gecos_mask

Type: regular expression
-Default: "^[^,]*"

+It uses the same format sequences as the $index_format variable. +

3.74. 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. +

3.75. from

Type: e-mail address
+Default: (empty)

+When set, this variable contains a default from address. It +can be overridden using “my_hdr” (including from a “send-hook”) and +$reverse_name. This variable is ignored if $use_from is unset. +

+This setting defaults to the contents of the environment variable $EMAIL. +

3.76. gecos_mask

Type: regular expression
+Default: “^[^,]*”

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=".*". -

-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 +entry when expanding the alias. The default value +will return the string up to the first “,” encountered. +If the GECOS field contains a string like “lastname, firstname” then you +should set it to “.*”. +

+This can be useful if you see the following behavior: you address an 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". -

3.68. hdrs

Type: boolean
+“Franklin” to “Franklin, Steve”. +

3.77. hdrs

Type: boolean
Default: yes

-When unset, the header fields normally added by the ``my_hdr'' +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, +composing a new message or replying in order to take effect. If set, the user defined header fields are added to every new message. -

3.69. header

Type: boolean
+

3.78. header

Type: boolean
Default: no

-When set, this variable causes Mutt to include the header +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. -

3.70. help

Type: boolean
+The $weed setting applies. +

3.79. header_cache

Type: path
+Default: (empty)

+This variable points to the header cache database. +If pointing to a directory Mutt will contain a header cache +database file per folder, if pointing to a file that file will +be a single global header cache. By default it is unset so no header +caching will be used. +

+Header caching can greatly improve speed when opening POP, IMAP +MH or Maildir folders, see “caching” for details. +

3.80. header_cache_compress

Type: boolean
+Default: yes

+When mutt is compiled with qdbm or tokyocabinet as header cache backend, +this option determines whether the database will be compressed. +Compression results in database files roughly being one fifth +of the usual diskspace, but the uncompression can result in a +slower opening of cached folder(s) which in general is still +much faster than opening non header cached folders. +

3.81. header_cache_pagesize

Type: string
+Default: “16384”

+When mutt is compiled with either gdbm or bdb4 as the header cache backend, +this option changes the database page size. Too large or too small +values can waste space, memory, or CPU time. The default should be more +or less optimal for most use cases. +

3.82. help

Type: boolean
Default: yes

-When set, help lines describing the bindings for the major functions +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 @@ -654,119 +1042,137 @@ 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. -

3.71. hidden_host

Type: boolean
+

3.83. hidden_host

Type: boolean
Default: no

-When set, mutt will skip the host name part of ``$hostname'' variable +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 +affect the generation of Message-IDs, and it will not lead to the cut-off of first-level domains. -

3.72. hide_limited

Type: boolean
+

3.84. hide_limited

Type: boolean
Default: no

-When set, mutt will not show the presence of messages that are hidden +When set, mutt will not show the presence of messages that are hidden by limiting, in the thread tree. -

3.73. hide_missing

Type: boolean
+

3.85. hide_missing

Type: boolean
Default: yes

-When set, mutt will not show the presence of missing messages in the +When set, mutt will not show the presence of missing messages in the thread tree. -

3.74. hide_thread_subject

Type: boolean
+

3.86. hide_thread_subject

Type: boolean
Default: yes

-When set, mutt will not show the subject of messages in the thread +When set, mutt will not show the subject of messages in the thread tree that have the same subject as their parent or closest previously displayed sibling. -

3.75. hide_top_limited

Type: boolean
+

3.87. hide_top_limited

Type: boolean
Default: no

-When set, mutt will not show the presence of messages that are hidden +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_limited is set, this option will have no effect. -

3.76. hide_top_missing

Type: boolean
+$hide_limited is set, this option will have no effect. +

3.88. hide_top_missing

Type: boolean
Default: yes

-When set, mutt will not show the presence of missing messages at the -top of threads in the thread tree. Note that when $hide_missing is -set, this option will have no effect. -

3.77. history

Type: number
+When set, mutt will not show the presence of missing messages at the +top of threads in the thread tree. Note that when $hide_missing is +set, this option will have no effect. +

3.89. 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 +the string history buffer per category. The buffer is cleared each time the variable is set. -

3.78. history_file

Type: path
-Default: "˜/.mutthistory"

+

3.90. history_file

Type: path
+Default: “˜/.mutthistory”

The file in which Mutt will save its history. -

3.79. honor_followup_to

Type: quadoption
+

3.91. honor_disposition

Type: boolean
+Default: no

+When set, Mutt will not display attachments with a +disposition of “attachment” inline even if it could +render the part to plain text. These MIME parts can only +be viewed from the attachment menu. +

+If unset, Mutt will render all MIME parts it can +properly transform to plain text. +

3.92. honor_followup_to

Type: quadoption
Default: yes

This variable controls whether or not a Mail-Followup-To header is honored when group-replying to a message. -

3.80. hostname

Type: string
-Default: ""

+

3.93. hostname

Type: string
+Default: (empty)

Specifies the fully-qualified hostname of the system mutt is running on containing the host's name and the DNS domain it belongs to. It is used -as the domain part (after ``@'') for local email addresses as well as +as the domain part (after “@”) for local email addresses as well as Message-Id headers.

Its value is determined at startup as follows: If the node's name -as returned by the uname(3) function contains the hostname and the -domain, these are used to construct $hostname. If there is no -domain part returned, Mutt will look for a ``domain'' or ``search'' -line in /etc/resolv.conf to determine the domain. Optionally, Mutt +as returned by the uname(3) function contains the hostname and the +domain, these are used to construct $hostname. If there is no +domain part returned, Mutt will look for a “domain” or “search” +line in /etc/resolv.conf to determine the domain. Optionally, Mutt can be compiled with a fixed domain name in which case a detected one is not used.

-Also see ``$use_domain'' and ``$hidden_host''. -

3.81. ignore_linear_white_space

Type: boolean
+Also see $use_domain and $hidden_host. +

3.94. ignore_linear_white_space

Type: boolean
Default: no

This option replaces linear-white-space between encoded-word -and *text to a single space to prevent the display of MIME-encoded -``Subject'' field from being divided into multiple lines. -

3.82. ignore_list_reply_to

Type: boolean
-Default: no

-Affects the behaviour of the reply function when replying to -messages from mailing lists (as defined by the ``subscribe'' or -``lists'' commands). 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 +and text to a single space to prevent the display of MIME-encoded +“Subject:” field from being divided into multiple lines. +

3.95. ignore_list_reply_to

Type: boolean
+Default: no

+Affects the behaviour of the <reply> function when replying to +messages from mailing lists (as defined by the “subscribe” or +“lists” commands). 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 list-reply -function; group-reply will reply to both the sender and the +mailing list when this option is set, use the <list-reply> +function; <group-reply> will reply to both the sender and the list. -

3.83. imap_authenticators

Type: string
-Default: ""

+

3.96. imap_authenticators

Type: string
+Default: (empty)

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', 'gssapi' -or 'cram-md5'. This parameter is case-insensitive. If this -parameter is unset (the default) mutt will try all available methods, +try them. Authentication methods are either “login” or the right +side of an IMAP “AUTH=xxx” capability string, eg “digest-md5”, “gssapi” +or “cram-md5”. This option is case-insensitive. If it's +unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

-Example: set imap_authenticators="gssapi:cram-md5:login" -

+Example: + +

+set imap_authenticators="gssapi:cram-md5:login"
+

Note: 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. -

3.84. imap_check_subscribed

Type: boolean
+

3.97. 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. -

3.85. imap_delim_chars

Type: string
-Default: "/."

+it polls for new mail just as if you had issued individual “mailboxes” +commands. +

3.98. imap_delim_chars

Type: string
+Default: “/.”

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. -

3.86. imap_headers

Type: string
-Default: ""

+helps in using the “=” shortcut for your folder variable. +

3.99. imap_headers

Type: string
+Default: (empty)

Mutt 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 +(“Date:”, “From:”, “Subject:”, “To:”, “Cc:”, “Message-Id:”, +“References:”, “Content-Type:”, “Content-Description:”, “In-Reply-To:”, +“Reply-To:”, “Lines:”, “List-Post:”, “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. -

3.87. imap_idle

Type: boolean
+headers for spam detection. +

+Note: This is a space separated list, items should be uppercase +and not contain the colon, e.g. “X-BOGOSITY X-SPAM-STATUS” for the +“X-Bogosity:” and “X-Spam-Status:” header fields. +

3.100. imap_idle

Type: boolean
Default: no

When set, mutt will attempt to use the IMAP IDLE extension to check for new mail in the current mailbox. Some servers (dovecot was the inspiration for this option) react badly to mutt's implementation. If your connection seems to freeze up periodically, try unsetting this. -

3.88. imap_keepalive

Type: number
+

3.101. imap_keepalive

Type: number
Default: 900

This variable specifies the maximum amount of time in seconds that mutt will wait before polling open IMAP connections, to prevent the server @@ -775,353 +1181,355 @@ 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. -

3.89. imap_list_subscribed

Type: boolean
+

3.102. imap_list_subscribed

Type: boolean
Default: no

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. -

3.90. imap_login

Type: string
-Default: ""

+IMAP browser with the <toggle-subscribed> function. +

3.103. imap_login

Type: string
+Default: (empty)

Your login name on the IMAP server.

-This variable defaults to the value of imap_user. -

3.91. imap_pass

Type: string
-Default: ""

+This variable defaults to the value of $imap_user. +

3.104. imap_pass

Type: string
+Default: (empty)

Specifies the password for your IMAP account. If unset, Mutt will -prompt you for your password when you invoke the fetch-mail function. +prompt you for your password when you invoke the <imap-fetch-mail> function +or try to open an IMAP folder. +

Warning: 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. -

3.92. imap_passive

Type: boolean
+

3.105. imap_passive

Type: boolean
Default: yes

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. -

3.93. imap_peek

Type: boolean
+

3.106. imap_peek

Type: boolean
Default: yes

When 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. -

3.94. imap_servernoise

Type: boolean
+

3.107. imap_pipeline_depth

Type: number
+Default: 15

+Controls the number of IMAP commands that may be queued up before they +are sent to the server. A deeper pipeline reduces the amount of time +mutt must wait for the server, and can make IMAP servers feel much +more responsive. But not all servers correctly handle pipelined commands, +so if you have problems you might want to try setting this variable to 0. +

+Note: Changes to this variable have no effect on open connections. +

3.108. imap_servernoise

Type: boolean
Default: yes

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. -

3.95. imap_user

Type: string
-Default: ""

+

3.109. imap_user

Type: string
+Default: (empty)

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. -

3.96. implicit_autoview

Type: boolean
+

3.110. implicit_autoview

Type: boolean
Default: no

-If set to ``yes'', mutt will look for a mailcap entry with the -copiousoutput flag set for every MIME attachment it doesn't have +If set to “yes”, mutt 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 will use the viewer defined in that entry to convert the body part to text form. -

3.97. include

Type: quadoption
+

3.111. 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. -

3.98. include_onlyfirst

Type: boolean
+

3.112. include_onlyfirst

Type: boolean
Default: no

Controls whether or not Mutt includes only the first attachment of the message you are replying. -

3.99. indent_string

Type: string
-Default: "> "

+

3.113. 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.

+The value of this option is ignored if $text_flowed is set, too because +the quoting mechanism is strictly defined for format=flowed. +

This option is a format string, please see the description of -``$index_format'' for supported printf()-style sequences. -

3.100. index_format

Type: string
-Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"

+$index_format for supported printf(3)-style sequences. +

3.114. 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 to format output (see the man page for more detail). +“Format strings” are similar to the strings used in the C +function printf(3) to format output (see the man page for more details). The following sequences are defined in Mutt: -

-

%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

sender (address + real name), either From: or Return-Path: -

%F

author name, or recipient name if the message is from you -

%H

spam attribute(s) of this message -

%i

message-id of the current message -

%l

number of lines in the message (does not work with maildir, +

%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 sender (address + real name), either From: or Return-Path: +
%F author name, or recipient name if the message is from you +
%H spam attribute(s) of this message +
%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 +

%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 would formerly have -stashed the message: list name or recipient name if no list -

%P

progress indicator for the builtin pager (how much of the file has been displayed) -

%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 -

%X

number of attachments -(please see the ``attachments'' section for possible speed effects) -

%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''; +

%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 original save folder where mutt would formerly have +stashed the message: list name or recipient name +if not sent to a list +
%P progress indicator for the builtin pager (how much of the file has been displayed) +
%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 +
%X number of attachments +(please see the “attachments” section for possible speed effects) +
%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(3); 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(3); a leading bang disables locales +
%(fmt) the local date and time when the message was received. +“fmt” is expanded by the library function strftime(3); 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" -

%*X

soft-fill with character "X" as pad -

- -

-`Soft-fill' deserves some explanation. Normal right-justification -will print everything to the left of the %>, displaying padding and -the whatever lies to the right only if there's room. By contrast, +

%<fmt> the current local time. “fmt” is expanded by the library +function strftime(3); 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” +
%*X soft-fill with character “X” as pad +

+“Soft-fill” deserves some explanation: Normal right-justification +will print everything to the left of the “%>”, displaying padding and +whatever lies to the right only if there's room. By contrast, soft-fill gives priority to the right-hand side, guaranteeing space to display it and showing padding only if there's still room. If necessary, soft-fill will eat text leftwards to make room for rightward text.

-Note that these expandos are supported in -``save-hook'', ``fcc-hook'' and ``fcc-save-hook'', too. -

-See also: ``$to_chars''. -

3.101. ispell

Type: path
-Default: "ispell"

+Note that these expandos are supported in +“save-hook”, “fcc-hook” and “fcc-save-hook”, too. +

3.115. ispell

Type: path
+Default: “ispell”

How to invoke ispell (GNU's spell-checking software). -

3.102. 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. -

3.103. 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. -

3.104. mail_check

Type: number
+

3.116. 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. +

3.117. 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 environment variable $LC_TIME. +

3.118. mail_check

Type: number
Default: 5

This variable configures how often (in seconds) mutt should look for -new mail. Also see the ``$timeout'' variable. -

3.105. mailcap_path

Type: string
-Default: ""

+new mail. Also see the $timeout variable. +

3.119. mailcap_path

Type: string
+Default: (empty)

This variable specifies which files to consult when attempting to display MIME bodies not directly supported by Mutt. -

3.106. mailcap_sanitize

Type: boolean
+

3.120. mailcap_sanitize

Type: boolean
Default: yes

-If set, mutt will restrict possible characters in mailcap % expandos +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.

DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING! -

3.107. header_cache

Type: path
-Default: ""

-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. -

3.108. maildir_header_cache_verify

Type: boolean
+

3.121. maildir_header_cache_verify

Type: boolean
Default: yes

Check for Maildir unaware programs other than mutt having modified maildir -files when the header cache is in use. This incurs one stat(2) per -message every time the folder is opened. -

3.109. header_cache_pagesize

Type: string
-Default: "16384"

-When mutt is compiled with either gdbm or bdb4 as the header cache backend, -this option changes the database page size. Too large or too small -values can waste space, memory, or CPU time. The default should be more -or less optimal for most use cases. -

3.110. header_cache_compress

Type: boolean
-Default: yes

-When mutt is compiled with qdbm as header cache backend, -this option determines whether the database will be compressed. -Compression results in database files roughly being one fifth -of the usual diskspace, but the uncompression can result in a -slower opening of cached folder(s). -

3.111. maildir_trash

Type: boolean
+files when the header cache is in use. This incurs one stat(2) per +message every time the folder is opened (which can be very slow for NFS +folders). +

3.122. maildir_trash

Type: boolean
Default: no

-If set, messages marked as deleted will be saved with the maildir -(T)rashed flag instead of unlinked. NOTE: this only applies +If set, messages marked as deleted will be saved with the maildir +trashed flag instead of unlinked. Note: this only applies to maildir-style mailboxes. Setting it will have no effect on other mailbox types. -

3.112. mark_old

Type: boolean
+

3.123. mark_old

Type: boolean
Default: yes

Controls whether or not mutt marks new unread messages as old 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, +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. -

3.113. markers

Type: boolean
+

3.124. 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. -

3.114. mask

Type: regular expression
-Default: "!^\.[^.]"

+“+” marker is displayed at the beginning of wrapped lines. +

+Also see the $smart_wrap variable. +

3.125. 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 +the not operator “!”. Only files whose names match this mask will be shown. The match is always case-sensitive. -

3.115. mbox

Type: path
-Default: "˜/mbox"

-This specifies the folder into which read mail in your ``$spoolfile'' +

3.126. mbox

Type: path
+Default: “˜/mbox”

+This specifies the folder into which read mail in your $spoolfile folder will be appended. -

3.116. mbox_type

Type: folder magic
+

+Also see the $move variable. +

3.127. 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. -

3.117. metoo

Type: boolean
-Default: no

-If unset, Mutt will remove your address (see the ``alternates'' -command) from the list of recipients when replying to a message. -

3.118. menu_context

Type: number
+“mbox”, “MMDF”, “MH” and “Maildir”. This is overriden by the +-m command-line option. +

3.128. 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''.) -

3.119. menu_move_off

Type: boolean
+when scrolling through menus. (Similar to $pager_context.) +

3.129. 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. -

3.120. menu_scroll

Type: boolean
+

3.130. 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). -

3.121. meta_key

Type: boolean
+

3.131. message_cache_clean

Type: boolean
Default: no

-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 +If set, mutt will clean out obsolete entries from the message cache when +the mailbox is synchronized. You probably only want to set it +every once in a while, since it can be a little slow +(especially for large folders). +

3.132. message_cachedir

Type: path
+Default: (empty)

+Set this to a directory and mutt will cache copies of messages from +your IMAP and POP servers here. You are free to remove entries at any +time. +

+When setting this variable to a directory, mutt needs to fetch every +remote message only once and can perform regular expression searches +as fast as for local folders. +

+Also see the $message_cache_clean variable. +

3.133. 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. +

3.134. meta_key

Type: boolean
+Default: no

+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 0xf8, then this is treated as if the user had -pressed ESC then ``x''. This is because the result of removing the -high bit from ``0xf8'' is ``0x78'', which is the ASCII character -``x''. -

3.122. mh_purge

Type: boolean
+has an ASCII value of 0xf8, then this is treated as if the user had +pressed Esc then “x”. This is because the result of removing the +high bit from 0xf8 is 0x78, which is the ASCII character +“x”. +

3.135. metoo

Type: boolean
+Default: no

+If unset, Mutt will remove your address (see the “alternates” +command) from the list of recipients when replying to a message. +

3.136. mh_purge

Type: boolean
Default: no

-When unset, mutt will mimic mh's behaviour and rename deleted messages +When unset, mutt 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 +them. This leaves the message on disk but makes programs reading the folder +ignore it. If the variable is set, the message files will simply be deleted. -

3.123. mh_seq_flagged

Type: string
-Default: "flagged"

+

+This option is similar to $maildir_trash for Maildir folders. +

3.137. mh_seq_flagged

Type: string
+Default: “flagged”

The name of the MH sequence used for flagged messages. -

3.124. mh_seq_replied

Type: string
-Default: "replied"

+

3.138. mh_seq_replied

Type: string
+Default: “replied”

The name of the MH sequence used to tag replied messages. -

3.125. mh_seq_unseen

Type: string
-Default: "unseen"

+

3.139. mh_seq_unseen

Type: string
+Default: “unseen”

The name of the MH sequence used for unseen messages. -

3.126. mime_forward

Type: quadoption
+

3.140. 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 +When set, the message you are forwarding will be attached as a +separate message/rfc822 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. +variable to “ask-no” or “ask-yes”.

-Also see ``$forward_decode'' and ``$mime_forward_decode''. -

3.127. mime_forward_decode

Type: boolean
+Also see $forward_decode and $mime_forward_decode. +

3.141. 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. -

3.128. mime_forward_rest

Type: quadoption
+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. +

3.142. mime_forward_rest

Type: quadoption
Default: yes

-When forwarding multiple attachments of a MIME message from the recvattach +When forwarding multiple attachments of a MIME message from the attachment menu, attachments which cannot be decoded in a reasonable manner will -be attached to the newly composed message if this option is set. -

3.129. mix_entry_format

Type: string
-Default: "%4n %c %-16s %a"

+be attached to the newly composed message if this option is set. +

3.143. mix_entry_format

Type: string
+Default: “%4n %c %-16s %a”

This variable describes the format of a remailer line on the mixmaster -chain selection screen. The following printf-like sequences are +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. -

-

3.130. mixmaster

Type: path
-Default: "mixmaster"

+

%n The running number on the menu. +
%c Remailer capabilities. +
%s The remailer's short name. +
%a The remailer's e-mail address. +

3.144. mixmaster

Type: path
+Default: “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. -

3.131. move

Type: quadoption
-Default: ask-no

+

3.145. move

Type: quadoption
+Default: no

Controls whether or not Mutt will move read messages -from your spool mailbox to your ``$mbox'' mailbox, or as a result of -a ``mbox-hook'' command. -

3.132. message_cachedir

Type: path
-Default: ""

-Set this to a directory and mutt will cache copies of messages from -your IMAP and POP servers here. You are free to remove entries at any -time, for instance if stale entries accumulate because you have -deleted messages with another mail client. -

3.133. message_cache_clean

Type: boolean
+from your spool mailbox to your $mbox mailbox, or as a result of +a “mbox-hook” command. +

3.146. narrow_tree

Type: boolean
Default: no

-If set, mutt will clean out obsolete entries from the cache when -the mailbox is synchronized. You probably only want to set it -every once in a while, since it can be a little slow. -

3.134. 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()-like sequences see the section on ``$index_format''. -

3.135. narrow_tree

Type: boolean
-Default: no

-This variable, when set, makes the thread tree narrower, allowing +This variable, when set, makes the thread tree narrower, allowing deeper threads to fit on the screen. -

3.136. net_inc

Type: number
+

3.147. net_inc

Type: number
Default: 10

Operations that expect to transfer a large amount of data over the -network will update their progress every net_inc kilobytes. +network will update their progress every $net_inc kilobytes. If set to 0, no progress messages will be displayed.

-See also ``$read_inc'' and ``$write_inc''. -

3.137. pager

Type: path
-Default: "builtin"

+See also $read_inc, $write_inc and $net_inc. +

3.148. 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 +messages. The value “builtin” means to use the builtin pager, otherwise this variable should specify the pathname of the external pager you would like to use.

@@ -1129,19 +1537,23 @@ 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. -

3.138. pager_context

Type: number
+

3.149. 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 will display the line after the last one on the screen at the top of the next page (0 lines of context). -

3.139. pager_format

Type: string
-Default: "-%Z- %C/%m: %-20.20n   %s%*  -- (%P)"

-This variable controls the format of the one-line message ``status'' +

+This variable also specifies the amount of context given for search +results. If positive, this many lines will be given before a match, +if 0, the match will be top-aligned. +

3.150. pager_format

Type: string
+Default: “-%Z- %C/%m: %-20.20n   %s%*  -- (%P)”

+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'' +pager. The valid sequences are listed in the $index_format section. -

3.140. pager_index_lines

Type: number
+

3.151. 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 @@ -1149,222 +1561,182 @@ 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 +for the status bar from the index, so a setting 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 +is less than $pager_index_lines, then the index will only use as many lines as it needs. -

3.141. pager_stop

Type: boolean
+

3.152. 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 +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. -

3.142. crypt_autosign

Type: boolean
-Default: no

-Setting this variable will cause Mutt 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) -

3.143. crypt_autoencrypt

Type: boolean
-Default: no

-Setting this variable will cause Mutt 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) -

3.144. pgp_ignore_subkeys

Type: boolean
-Default: yes

-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) -

3.145. crypt_replyencrypt

Type: boolean
-Default: yes

-If set, automatically PGP or OpenSSL encrypt replies to messages which are -encrypted. -(Crypto only) -

3.146. 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) -

3.147. 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 is not able -to find out whether an encrypted message is also signed. -(Crypto only) -

3.148. crypt_timestamp

Type: boolean
-Default: yes

-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) -

3.149. pgp_use_gpg_agent

Type: boolean
-Default: no

-If set, mutt will use a possibly-running gpg-agent process. -(PGP only) -

3.150. 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) -

3.151. smime_is_default

Type: boolean
-Default: no

-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) -

3.152. smime_ask_cert_label

Type: boolean
-Default: yes

-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) -

3.153. smime_decrypt_use_default_key

Type: boolean
-Default: yes

-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) -

3.154. 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()-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) -

3.155. 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) -

3.156. pgp_check_exit

Type: boolean
-Default: yes

-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) -

3.157. 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) -

3.158. pgp_retainable_sigs

Type: boolean
+

3.153. pgp_auto_decode

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) -

3.159. pgp_autoinline

Type: boolean
+If set, mutt 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 will automatically +check the message for traditional pgp. +

3.154. pgp_autoinline

Type: boolean
Default: no

This option controls whether Mutt generates old-style inline (traditional) PGP encrypted or signed messages under certain -circumstances. This can be overridden by use of the pgp-menu, +circumstances. This can be overridden by use of the pgp menu, when inline is not required.

Note that Mutt might automatically use PGP/MIME for messages which consist of more than a single MIME part. Mutt can be configured to ask before sending PGP/MIME messages when inline (traditional) would not work. -See also: ``$pgp_mime_auto''. +

+Also see the $pgp_mime_auto variable.

Also note that using the old-style PGP message format is strongly deprecated. (PGP only) -

3.160. pgp_replyinline

Type: boolean
-Default: no

-Setting this variable will cause Mutt 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 -internals for previously checked/flagged messages. -

-Note that Mutt might automatically use PGP/MIME for messages -which consist of more than a single MIME part. Mutt 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 +

3.155. pgp_check_exit

Type: boolean
+Default: yes

+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) +

3.156. pgp_clearsign_command

Type: string
+Default: (empty)

+This format is used to create an old-style “clearsigned” PGP +message. Note that the use of this format is strongly deprecated. +

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. (PGP only) -

3.161. pgp_show_unusable

Type: boolean
-Default: yes

-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. +

3.157. pgp_decode_command

Type: string
+Default: (empty)

+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 and gpg sample configuration files in +the samples/ subdirectory which has been installed on your system +alongside the documentation. (PGP only) -

3.162. 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''). +

3.158. pgp_decrypt_command

Type: string
+Default: (empty)

+This command is used to decrypt a PGP encrypted message. +

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. (PGP only) -

3.163. pgp_strict_enc

Type: boolean
-Default: yes

-If set, Mutt 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. +

3.159. pgp_encrypt_only_command

Type: string
+Default: (empty)

+This command is used to encrypt a body part without signing it. +

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. (PGP only) -

3.164. pgp_timeout

Type: number
-Default: 300

-The number of seconds after which a cached passphrase will expire if -not used. +

3.160. pgp_encrypt_sign_command

Type: string
+Default: (empty)

+This command is used to both sign and encrypt a body part. +

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. (PGP only) -

3.165. pgp_sort_keys

Type: sort order
-Default: address

-Specifies how the entries in the `pgp keys' menu are sorted. The -following are legal values: +

3.161. 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) +

3.162. pgp_export_command

Type: string
+Default: (empty)

+This command is used to export a public key from the user's +key ring. +

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. +(PGP only) +

3.163. pgp_getkeys_command

Type: string
+Default: (empty)

+This command is invoked whenever mutt will need public key information. +Of the sequences supported by $pgp_decode_command, %r is the only +printf(3)-like sequence used with this format. +(PGP only) +

3.164. pgp_good_sign

Type: regular expression
+Default: (empty)

+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) +

3.165. pgp_ignore_subkeys

Type: boolean
+Default: yes

+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) +

3.166. pgp_import_command

Type: string
+Default: (empty)

+This command is used to import a key from a message into +the user's public key ring.

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. +(PGP only) +

3.167. pgp_list_pubring_command

Type: string
+Default: (empty)

+This command is used to list the public key ring's contents. The +output format must be analogous to the one used by -

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 -

+

+gpg --list-keys --with-colons.
+

+This format is also generated by the pgpring utility which comes +with mutt. +

+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. +(PGP only) +

3.168. pgp_list_secring_command

Type: string
+Default: (empty)

+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.

-If you prefer reverse order of the above values, prefix it with -`reverse-'. +This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. (PGP only) -

3.166. pgp_mime_auto

Type: quadoption
+

3.169. pgp_long_ids

Type: boolean
+Default: no

+If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. +(PGP only) +

3.170. pgp_mime_auto

Type: quadoption
Default: ask-yes

This option controls whether Mutt will prompt you for automatically sending a (signed/encrypted) message using @@ -1373,874 +1745,927 @@ PGP/MIME when inline (traditional) fails (for any reason). Also note that using the old-style PGP message format is strongly deprecated. (PGP only) -

3.167. pgp_auto_decode

Type: boolean
+

3.171. pgp_replyinline

Type: boolean
Default: no

-If set, mutt 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 will automatically -check the message for traditional pgp. -

3.168. pgp_decode_command

Type: string
-Default: ""

-This format strings specifies a command which is used to decode -application/pgp attachments. +Setting this variable will cause Mutt 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 +internals for previously checked/flagged messages.

-The PGP command formats have their own set of printf-like sequences: +Note that Mutt might automatically use PGP/MIME for messages +which consist of more than a single MIME part. Mutt can be +configured to ask before sending PGP/MIME messages when inline +(traditional) would not work.

- -

%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. -

- +Also see the $pgp_mime_auto variable.

-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) -

3.169. pgp_getkeys_command

Type: string
-Default: ""

-This command is invoked whenever mutt will need public key information. -%r is the only printf-like sequence used with this format. -(PGP only) -

3.170. pgp_verify_command

Type: string
-Default: ""

-This command is used to verify PGP signatures. -(PGP only) -

3.171. pgp_decrypt_command

Type: string
-Default: ""

-This command is used to decrypt a PGP encrypted message. -(PGP only) -

3.172. 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 +Also note that using the old-style PGP message format is strongly deprecated. (PGP only) -

3.173. 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) -

3.174. pgp_encrypt_sign_command

Type: string
-Default: ""

-This command is used to both sign and encrypt a body part. -(PGP only) -

3.175. pgp_encrypt_only_command

Type: string
-Default: ""

-This command is used to encrypt a body part without signing it. -(PGP only) -

3.176. pgp_import_command

Type: string
-Default: ""

-This command is used to import a key from a message into -the user's public key ring. +

3.172. 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) -

3.177. pgp_export_command

Type: string
-Default: ""

-This command is used to export a public key from the user's -key ring. +

3.173. pgp_show_unusable

Type: boolean
+Default: yes

+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) -

3.178. pgp_verify_key_command

Type: string
-Default: ""

-This command is used to verify key information from the key selection -menu. +

3.174. pgp_sign_as

Type: string
+Default: (empty)

+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) -

3.179. 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. +

3.175. pgp_sign_command

Type: string
+Default: (empty)

+This command is used to create the detached PGP signature for a +multipart/signed PGP/MIME body part.

-This format is also generated by the pgpring utility which comes -with mutt. +This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. (PGP only) -

3.180. 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. +

3.176. pgp_sort_keys

Type: sort order
+Default: address

+Specifies how the entries in the pgp 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) -

3.181. forward_decrypt

Type: boolean
+

3.177. pgp_strict_enc

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. +If set, Mutt 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) -

3.182. smime_timeout

Type: number
+

3.178. pgp_timeout

Type: number
Default: 300

The number of seconds after which a cached passphrase will expire if not used. -(S/MIME only) -

3.183. 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", "rc2-128". -If unset "3des" (TripleDES) is used. -(S/MIME only) -

3.184. smime_keys

Type: path
-Default: ""

-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) -

3.185. smime_ca_location

Type: path
-Default: ""

-This variable contains the name of either a directory, or a file which -contains trusted certificates for use with OpenSSL. -(S/MIME only) -

3.186. smime_certificates

Type: path
-Default: ""

-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) -

3.187. smime_decrypt_command

Type: string
-Default: ""

-This format string specifies a command which is used to decrypt -application/x-pkcs7-mime attachments. -

-The OpenSSL command formats have their own set of printf-like sequences -similar to PGP's: -

- -

%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. -

%k

The key-pair specified with $smime_default_key -

%c

One or more certificate IDs. -

%a

The algorithm used for encryption. -

%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". -

- -

-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) -

3.188. smime_verify_command

Type: string
-Default: ""

-This command is used to verify S/MIME signatures of type multipart/signed. -(S/MIME only) -

3.189. 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) -

3.190. 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) -

3.191. 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) -

3.192. smime_encrypt_command

Type: string
-Default: ""

-This command is used to create encrypted S/MIME messages. -(S/MIME only) -

3.193. 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) -

3.194. smime_get_cert_command

Type: string
-Default: ""

-This command is used to extract X509 certificates from a PKCS7 structure. -(S/MIME only) -

3.195. 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'-field. -(S/MIME only) -

3.196. smime_import_cert_command

Type: string
-Default: ""

-This command is used to import a certificate via smime_keys. -(S/MIME only) -

3.197. 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) -

3.198. smime_default_key

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) -

3.199. ssl_client_cert

Type: path
-Default: ""

-The file containing a client certificate and its associated private -key. -

3.200. ssl_force_tls

Type: boolean
+(PGP only) +

3.179. pgp_use_gpg_agent

Type: boolean
Default: no

-If this variable is set, Mutt 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''. -

3.201. ssl_starttls

Type: quadoption
-Default: yes

-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. -

3.202. certificate_file

Type: path
-Default: "˜/.mutt_certificates"

-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. +If set, mutt will use a possibly-running gpg-agent(1) process. +(PGP only) +

3.180. pgp_verify_command

Type: string
+Default: (empty)

+This command is used to verify PGP signatures.

-Example: set certificate_file=˜/.mutt/certificates -

3.203. ssl_usesystemcerts

Type: boolean
-Default: yes

-If set to yes, mutt will use CA certificates in the -system-wide certificate store when checking if server certificate -is signed by a trusted CA. -

3.204. entropy_file

Type: path
-Default: ""

-The file which includes random data that is used to initialize SSL -library functions. -

3.205. ssl_use_sslv2

Type: boolean
-Default: yes

-This variables specifies whether to attempt to use SSLv2 in the -SSL authentication process. -

3.206. ssl_use_sslv3

Type: boolean
-Default: yes

-This variables specifies whether to attempt to use SSLv3 in the -SSL authentication process. -

3.207. ssl_use_tlsv1

Type: boolean
-Default: yes

-This variables specifies whether to attempt to use TLSv1 in the -SSL authentication process. -

3.208. ssl_min_dh_prime_bits

Type: number
-Default: 0

-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. -

3.209. 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. +This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. +(PGP only) +

3.181. pgp_verify_key_command

Type: string
+Default: (empty)

+This command is used to verify key information from the key selection +menu.

-Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt -

3.210. pipe_split

Type: boolean
-Default: no

-Used in connection with the pipe-message 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. -

3.211. pipe_decode

Type: boolean
+This is a format string, see the $pgp_decode_command command for +possible printf(3)-like sequences. +(PGP only) +

3.182. pipe_decode

Type: boolean
Default: no

-Used in connection with the pipe-message 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 +Used in connection with the <pipe-message> command. When unset, +Mutt will pipe the messages without any preprocessing. When set, Mutt +will weed headers and will attempt to decode the messages first. -

3.212. pipe_sep

Type: string
-Default: "\n"

+

3.183. pipe_sep

Type: string
+Default: “\n”

The separator to add between messages when piping a list of tagged messages to an external Unix command. -

3.213. pop_authenticators

Type: string
-Default: ""

+

3.184. pipe_split

Type: boolean
+Default: no

+Used in connection with the <pipe-message> function following +<tag-prefix>. If this variable is unset, when piping a list of +tagged messages Mutt will concatenate the messages and will pipe them +all concatenated. 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. +

3.185. pop_auth_try_all

Type: boolean
+Default: yes

+If set, Mutt will try all available authentication 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. +

3.186. pop_authenticators

Type: string
+Default: (empty)

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 +try them. Authentication methods are either “user”, “apop” or any +SASL mechanism, eg “digest-md5”, “gssapi” or “cram-md5”. +This option is case-insensitive. If this option is unset (the default) mutt will try all available methods, in order from most-secure to least-secure.

-Example: set pop_authenticators="digest-md5:apop:user" -

3.214. pop_auth_try_all

Type: boolean
-Default: yes

-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. -

3.215. pop_checkinterval

Type: number
+Example: + +

+set pop_authenticators="digest-md5:apop:user"
+

3.187. pop_checkinterval

Type: number
Default: 60

This variable configures how often (in seconds) mutt should look for new mail in the currently selected mailbox if it is a POP mailbox. -

3.216. pop_delete

Type: quadoption
+

3.188. pop_delete

Type: quadoption
Default: ask-no

-If set, Mutt will delete successfully downloaded messages from the POP -server when using the fetch-mail function. When unset, Mutt will +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. -

3.217. pop_host

Type: string
-Default: ""

-The name of your POP server for the fetch-mail function. You +

3.189. pop_host

Type: string
+Default: (empty)

+The name of your POP server for the <fetch-mail> function. You can also specify an alternative port, username and password, ie: -

+ +

 [pop[s]://][username[:password]@]popserver[:port]
-

3.218. pop_last

Type: boolean
+

+where “[...]” denotes an optional part. +

3.190. pop_last

Type: boolean
Default: no

-If this variable is set, mutt will try to use the "LAST" POP command +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. -

3.219. pop_reconnect

Type: quadoption
+the <fetch-mail> function. +

3.191. pop_pass

Type: string
+Default: (empty)

+Specifies the password for your POP account. If unset, Mutt will +prompt you for your password when you open a POP mailbox. +

+Warning: 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. +

3.192. pop_reconnect

Type: quadoption
Default: ask-yes

-Controls whether or not Mutt will try to reconnect to POP server if +Controls whether or not Mutt will try to reconnect to the POP server if the connection is lost. -

3.220. pop_user

Type: string
-Default: ""

+

3.193. pop_user

Type: string
+Default: (empty)

Your login name on the POP server.

This variable defaults to your user name on the local machine. -

3.221. pop_pass

Type: string
-Default: ""

-Specifies the password for your POP account. If unset, Mutt will -prompt you for your password when you open POP mailbox. -Warning: 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. -

3.222. post_indent_string

Type: string
-Default: ""

-Similar to the ``$attribution'' variable, Mutt will append this +

3.194. post_indent_string

Type: string
+Default: (empty)

+Similar to the $attribution variable, Mutt will append this string after the inclusion of a message which is being replied to. -

3.223. postpone

Type: quadoption
+

3.195. postpone

Type: quadoption
Default: ask-yes

-Controls whether or not messages are saved in the ``$postponed'' -mailbox when you elect not to send immediately. Also see the -``$recall'' variable. -

3.224. postponed

Type: path
-Default: "˜/postponed"

-Mutt allows you to indefinitely ``postpone sending a message'' which +Controls whether or not messages are saved in the $postponed +mailbox when you elect not to send immediately. +

+Also see the $recall variable. +

3.196. postponed

Type: path
+Default: “˜/postponed”

+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. -

3.225. preconnect

Type: string
-Default: ""

-If set, a shell command to be executed if mutt fails to establish +in the mailbox specified by this variable. +

+Also see the $postpone variable. +

3.197. preconnect

Type: string
+Default: (empty)

+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 +connections, e.g. with ssh(1). If the command returns a nonzero status, mutt gives up opening the server. Example: -

-preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net + +

+set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
 sleep 20 < /dev/null > /dev/null"
+

+Mailbox “foo” on “mailhost.net” can now be reached +as “{localhost:1234}foo”.

-Mailbox 'foo' on mailhost.net can now be reached -as '{localhost:1234}foo'. -

-NOTE: For this example to work, you must be able to log in to the +Note: For this example to work, you must be able to log in to the remote machine without having to enter a password. -

3.226. print

Type: quadoption
+

3.198. print

Type: quadoption
Default: ask-no

Controls whether or not Mutt really prints messages. -This is set to ask-no by default, because some people -accidentally hit ``p'' often (like me). -

3.227. print_command

Type: path
-Default: "lpr"

+This is set to “ask-no” by default, because some people +accidentally hit “p” often. +

3.199. print_command

Type: path
+Default: “lpr”

This specifies the command pipe that should be used to print messages. -

3.228. print_decode

Type: boolean
+

3.200. print_decode

Type: boolean
Default: yes

-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 +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. -

3.229. print_split

Type: boolean
+

3.201. print_split

Type: boolean
Default: no

-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 +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.

-Those who use the enscript(1) program's mail-printing mode will -most likely want to set this option. -

3.230. prompt_after

Type: boolean
+Those who use the enscript(1) program's mail-printing mode will +most likely want to set this option. +

3.202. prompt_after

Type: boolean
Default: yes

-If you use an external ``$pager'', setting this variable will +If you use an external $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 +than returning to the index menu. If unset, Mutt will return to the index menu when the external pager exits. -

3.231. query_command

Type: path
-Default: ""

+

3.203. query_command

Type: path
+Default: (empty)

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 +queries. The string should contain a “%s”, which will be substituted +with the query string the user types. See “query” for more information. -

3.232. query_format

Type: string
-Default: "%4c %t %-25.25a %-25.25n %?e?(%e)?"

-This variable describes the format of the `query' menu. The -following printf-style sequences are understood: -

- -

%a

destination address -

%c

current entry number -

%e

extra information * -

%n

destination name -

%t

``*'' if current entry is tagged, a space otherwise -

%>X

right justify the rest of the string and pad with "X" -

%|X

pad to the end of the line with "X" -

%*X

soft-fill with character "X" as pad -

- -

-For an explanation of `soft-fill', see the ``$index_format'' documentation. -

-* = can be optionally printed if nonzero, see the ``$status_format'' documentation. -

3.233. quit

Type: quadoption
-Default: yes

-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 +

3.204. query_format

Type: string
+Default: “%4c %t %-25.25a %-25.25n %?e?(%e)?”

+This variable describes the format of the “query” menu. The +following printf(3)-style sequences are understood: + +

%a destination address +
%c current entry number +
%e extra information * +
%n destination name +
%t “*” if current entry is tagged, a space otherwise +
%>X right justify the rest of the string and pad with “X” +
%|X pad to the end of the line with “X” +
%*X soft-fill with character “X” as pad +

+For an explanation of “soft-fill”, see the $index_format documentation. +

+* = can be optionally printed if nonzero, see the $status_format documentation. +

3.205. quit

Type: quadoption
+Default: yes

+This variable controls whether “quit” and “exit” actually quit +from mutt. If this option is set, they do quit, if it is unset, 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. -

3.234. quote_regexp

Type: regular expression
-Default: "^([ \t]*[|>:}#])+"

-A regular expression used in the internal-pager to determine quoted -sections of text in the body of a message. -

-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. -

3.235. read_inc

Type: number
+

3.206. quote_regexp

Type: regular expression
+Default: “^([ \t]*[|>:}#])+”

+A regular expression used in the internal pager to determine quoted +sections of text in the body of a message. Quoted text may be filtered +out using the <toggle-quoted> command, or colored according to the +“color quoted” family of directives. +

+Higher levels of quoting may be colored differently (“color quoted1”, +“color quoted2”, etc.). The quoting level is determined by removing +the last character from the matched text and recursively reapplying +the regular expression until it fails to produce a match. +

+Match detection may be overridden by the $smileys regular expression. +

3.207. read_inc

Type: number
Default: 10

If set to a value greater than 0, Mutt will display which message it is currently on when reading a mailbox or when performing search actions such as search and limit. The message is printed after -read_inc messages have been read or searched (e.g., if set to 25, Mutt will +this many messages have been read or searched (e.g., if set to 25, Mutt will print a message when it is at message 25, and then again when it gets to message 50). This variable is meant to indicate progress when reading or searching large mailboxes which may take some time. When set to 0, only a single message will appear before the reading the mailbox.

-Also see the ``$write_inc'' variable and the ``Tuning'' section of the -manual for performance considerations. -

3.236. read_only

Type: boolean
+Also see the $write_inc, $net_inc and $time_inc variables and the +“tuning” section of the manual for performance considerations. +

3.208. read_only

Type: boolean
Default: no

-If set, all folders are opened in read-only mode. -

3.237. realname

Type: string
-Default: ""

-This variable specifies what "real" or "personal" name should be used +If set, all folders are opened in read-only mode. +

3.209. realname

Type: string
+Default: (empty)

+This variable specifies what “real” or “personal” name should be used when sending messages.

-By default, this is the GECOS field from /etc/passwd. Note that this +By default, this is the GECOS field from /etc/passwd. Note that this variable will not be used when the user has set a real name -in the $from variable. -

3.238. recall

Type: quadoption
+in the $from variable. +

3.210. recall

Type: quadoption
Default: ask-yes

Controls whether or not Mutt recalls postponed messages -when composing a new message. Also see ``$postponed''. +when composing a new message.

-Setting this variable to ``yes'' is not generally useful, and thus not +Setting this variable to is not generally useful, and thus not recommended. -

3.239. record

Type: path
-Default: "˜/sent"

+

+Also see $postponed variable. +

3.211. record

Type: path
+Default: “˜/sent”

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: field with your email address in it.) +your messages, but another way to do this is using the “my_hdr” +command to create a “Bcc:” field with your email address in it.)

-The value of $record is overridden by the ``$force_name'' and -``$save_name'' variables, and the ``fcc-hook'' command. -

3.240. reply_regexp

Type: regular expression
-Default: "^(re([\[0-9\]+])*|aw):[ \t]*"

+The value of $record is overridden by the $force_name and +$save_name variables, and the “fcc-hook” command. +

3.212. reply_regexp

Type: regular expression
+Default: “^(re([\[0-9\]+])*|aw):[ \t]*”

A regular expression used to recognize reply messages when threading and replying. The default value corresponds to the English "Re:" and the German "Aw:". -

3.241. reply_self

Type: boolean
+

3.213. reply_self

Type: boolean
Default: no

-If unset and you are replying to a message sent by you, Mutt will +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. -

3.242. reply_to

Type: quadoption
+

+Also see the “alternates” command. +

3.214. reply_to

Type: quadoption
Default: ask-yes

-If set, when replying to a message, Mutt will use the address listed -in the Reply-to: header as the recipient of the reply. If unset, +If set, when replying to a message, Mutt will use the address listed +in the Reply-to: header as the recipient of the reply. If unset, 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. -

3.243. resolve

Type: boolean
+

3.215. resolve

Type: boolean
Default: yes

-When set, the cursor will be automatically advanced to the next +When set, the cursor will be automatically advanced to the next (possibly undeleted) message whenever a command that modifies the current message is executed. -

3.244. reverse_alias

Type: boolean
+

3.216. reverse_alias

Type: boolean
Default: no

-This variable controls whether or not Mutt will display the "personal" +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: -

 alias juser abd30425@somewhere.net (Joe User)
-
 

and then you receive mail which contains the following header: -

 From: abd30425@somewhere.net
-
 

-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). -

3.245. reverse_name

Type: boolean
+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. +

3.217. reverse_name

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 From: line of +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 +“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. -

3.246. reverse_realname

Type: boolean
+

+Also see the “alternates” command. +

3.218. reverse_realname

Type: boolean
Default: yes

-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. -

3.247. rfc2047_parameters

Type: boolean
+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. +

3.219. rfc2047_parameters

Type: boolean
Default: no

-When this variable is set, Mutt will decode RFC-2047-encoded MIME +When this variable is set, Mutt will decode RFC2047-encoded MIME parameters. You want to set this variable when mutt suggests you -to save attachments to files named like this: +to save attachments to files named like: + +

 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
+

+When this variable is set interactively, the change won't be +active until you change folders.

-When this variable is set interactively, the change doesn't have -the desired effect before you have changed folders. -

-Note that this use of RFC 2047's encoding is explicitly, +Note that this use of RFC2047's encoding is explicitly prohibited by the standard, but nevertheless encountered in the wild. -Also note that setting this parameter will not have the effect +

+Also note that setting this parameter will not have the effect that mutt generates this kind of encoding. Instead, mutt will -unconditionally use the encoding specified in RFC 2231. -

3.248. save_address

Type: boolean
+unconditionally use the encoding specified in RFC2231. +

3.220. save_address

Type: boolean
Default: no

-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. -

3.249. save_empty

Type: boolean
+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. +

3.221. save_empty

Type: boolean
Default: yes

-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. +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.

Note: This only applies to mbox and MMDF folders, Mutt does not delete MH and Maildir directories. -

3.250. save_history

Type: number
+

3.222. save_history

Type: number
Default: 0

-This variable controls the size of the history saved in the -``$history_file'' file. -

3.251. save_name

Type: boolean
+This variable controls the size of the history (per category) saved in the +$history_file file. +

3.223. save_name

Type: boolean
Default: no

This variable controls how copies of outgoing messages are saved. -When set, a check is made to see if a mailbox specified by the +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 +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. +$record mailbox.

-Also see the ``$force_name'' variable. -

3.252. score

Type: boolean
+Also see the $force_name variable. +

3.224. score

Type: boolean
Default: yes

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. -

3.253. score_threshold_delete

Type: number
+$score_threshold_delete variable and related are used. +

3.225. score_threshold_delete

Type: number
Default: -1

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. -

3.254. score_threshold_flag

Type: number
+

3.226. score_threshold_flag

Type: number
Default: 9999

-Messages which have been assigned a score greater than or equal to this +Messages which have been assigned a score greater than or equal to this variable's value are automatically marked "flagged". -

3.255. score_threshold_read

Type: number
+

3.227. score_threshold_read

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. -

3.256. send_charset

Type: string
-Default: "us-ascii:iso-8859-1:utf-8"

+

3.228. search_context

Type: number
+Default: 0

+For the pager, this variable specifies the number of lines shown +before search results. By default, search results will be top-aligned. +

3.229. send_charset

Type: string
+Default: “us-ascii:iso-8859-1:utf-8”

A colon-delimited 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 +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". +“iso-8859-2”, “koi8-r” or “iso-2022-jp”) either instead of or after +“iso-8859-1”.

In case the text cannot be converted into one of these exactly, -mutt uses ``$charset'' as a fallback. -

3.257. sendmail

Type: path
-Default: "/usr/sbin/sendmail -oem -oi"

+mutt uses $charset as a fallback. +

3.230. sendmail

Type: path
+Default: “/usr/sbin/sendmail -oem -oi”

Specifies the program and arguments used to deliver mail sent by Mutt. Mutt expects that the specified program interprets additional arguments as recipient addresses. -

3.258. sendmail_wait

Type: number
+

3.231. sendmail_wait

Type: number
Default: 0

-Specifies the number of seconds to wait for the ``$sendmail'' process +Specifies the number of seconds to wait for the $sendmail process to finish before giving up and putting delivery in the background.

Mutt interprets the value of this variable as follows: -

>0

number of seconds to wait for sendmail to finish before continuing -

0

wait forever for sendmail to finish -

<0

always put sendmail in the background without waiting -

- -

+

>0 number of seconds to wait for sendmail to finish before continuing +
0 wait forever for sendmail to finish +
<0 always put sendmail in the background without waiting +

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. -

3.259. shell

Type: path
-Default: ""

+

3.232. shell

Type: path
+Default: (empty)

Command to use when spawning a subshell. By default, the user's login -shell from /etc/passwd is used. -

3.260. sig_dashes

Type: boolean
+shell from /etc/passwd is used. +

3.233. sig_dashes

Type: boolean
Default: yes

-If set, a line containing ``-- '' 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 +If set, a line containing “-- ” (note the trailing 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. For example, Mutt has the ability to highlight the signature in a different color in the builtin pager. -

3.261. sig_on_top

Type: boolean
+

3.234. sig_on_top

Type: boolean
Default: no

-If set, the signature will be included before any quoted or forwarded +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. -

3.262. signature

Type: path
-Default: "˜/.signature"

+

3.235. signature

Type: path
+Default: “˜/.signature”

Specifies the filename of your signature, which is appended to all -outgoing messages. If the filename ends with a pipe (``|''), it is +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. -

3.263. simple_search

Type: string
-Default: "˜f %s | ˜s %s"

+its standard output. +

3.236. simple_search

Type: string
+Default: “˜f %s | ˜s %s”

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. -

-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: -

-˜f joe | ˜s joe -

3.264. smart_wrap

Type: boolean
-Default: yes

-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. -

3.265. smileys

Type: regular expression
-Default: "(>From )|(:[-^]?[][)(><}{|/DP])"

-The pager uses this variable to catch some common false -positives of ``$quote_regexp'', most notably smileys in the beginning -of a line -

3.266. sleep_time

Type: number
+pattern. A simple search is one that does not contain any of the “˜” pattern +operators. See “patterns” for more information on search patterns. +

+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 by +replacing “%s” with the supplied string. +For the default value, “joe” would be expanded to: “˜f joe | ˜s joe”. +

3.237. sleep_time

Type: number
Default: 1

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 +messages from the current folder. The default is to pause one second, so a value of zero for this option suppresses the pause. -

3.267. smtp_authenticators

Type: string
-Default: ""

+

3.238. smart_wrap

Type: boolean
+Default: yes

+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. +

3.239. smileys

Type: regular expression
+Default: “(>From )|(:[-^]?[][)(><}{|/DP])”

+The pager uses this variable to catch some common false +positives of $quote_regexp, most notably smileys and not consider +a line quoted text if it also matches $smileys. This mostly +happens at the beginning of a line. +

3.240. smime_ask_cert_label

Type: boolean
+Default: yes

+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) +

3.241. smime_ca_location

Type: path
+Default: (empty)

+This variable contains the name of either a directory, or a file which +contains trusted certificates for use with OpenSSL. +(S/MIME only) +

3.242. smime_certificates

Type: path
+Default: (empty)

+Since for S/MIME 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 option points to +the location of the certificates. +(S/MIME only) +

3.243. smime_decrypt_command

Type: string
+Default: (empty)

+This format string specifies a command which is used to decrypt +application/x-pkcs7-mime attachments. +

+The OpenSSL command formats have their own set of printf(3)-like sequences +similar to PGP's: + +

%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. +
%k The key-pair specified with $smime_default_key +
%c One or more certificate IDs. +
%a The algorithm used for encryption. +
%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”. +

+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) +

3.244. smime_decrypt_use_default_key

Type: boolean
+Default: yes

+If set (default) this tells mutt to use the default key for decryption. Otherwise, +if managing 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) +

3.245. smime_default_key

Type: string
+Default: (empty)

+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) +

3.246. smime_encrypt_command

Type: string
+Default: (empty)

+This command is used to create encrypted S/MIME messages. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.247. smime_encrypt_with

Type: string
+Default: (empty)

+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) +

3.248. smime_get_cert_command

Type: string
+Default: (empty)

+This command is used to extract X509 certificates from a PKCS7 structure. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.249. smime_get_cert_email_command

Type: string
+Default: (empty)

+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). +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.250. smime_get_signer_cert_command

Type: string
+Default: (empty)

+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:” field. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.251. smime_import_cert_command

Type: string
+Default: (empty)

+This command is used to import a certificate via smime_keys. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.252. smime_is_default

Type: boolean
+Default: no

+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) +

3.253. smime_keys

Type: path
+Default: (empty)

+Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle +storage and 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 option points to the location of the private keys. +(S/MIME only) +

3.254. smime_pk7out_command

Type: string
+Default: (empty)

+This command is used to extract PKCS7 structures of S/MIME signatures, +in order to extract the public X509 certificate(s). +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.255. smime_sign_command

Type: string
+Default: (empty)

+This command is used to created S/MIME signatures of type +multipart/signed, which can be read by all mail clients. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.256. smime_sign_opaque_command

Type: string
+Default: (empty)

+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. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.257. smime_timeout

Type: number
+Default: 300

+The number of seconds after which a cached passphrase will expire if +not used. +(S/MIME only) +

3.258. smime_verify_command

Type: string
+Default: (empty)

+This command is used to verify S/MIME signatures of type multipart/signed. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.259. smime_verify_opaque_command

Type: string
+Default: (empty)

+This command is used to verify S/MIME signatures of type +application/x-pkcs7-mime. +

+This is a format string, see the $smime_decrypt_command command for +possible printf(3)-like sequences. +(S/MIME only) +

3.260. smtp_authenticators

Type: string
+Default: (empty)

This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an SMTP server, in the order mutt should try them. Authentication methods are any SASL mechanism, eg -``digest-md5'', ``gssapi'' or ``cram-md5''. -This parameter is case-insensitive. If this parameter is unset +“digest-md5”, “gssapi” or “cram-md5”. +This option is case-insensitive. If it is “unset” (the default) mutt will try all available methods, in order from most-secure to least-secure.

-Example: set smtp_authenticators="digest-md5:cram-md5" -

3.268. smtp_pass

Type: string
-Default: ""

+Example: + +

+set smtp_authenticators="digest-md5:cram-md5"
+

3.261. smtp_pass

Type: string
+Default: (empty)

Specifies the password for your SMTP account. If unset, Mutt will prompt you for your password when you first send mail via SMTP. -See ``smtp_url'' to configure mutt to send mail via SMTP. +See $smtp_url to configure mutt to send mail via SMTP. +

Warning: 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. -

3.269. smtp_url

Type: string
-Default: ""

-Defines the SMTP ``smart'' host where sent messages should relayed for +

3.262. smtp_url

Type: string
+Default: (empty)

+Defines the SMTP smarthost where sent messages should relayed for delivery. This should take the form of an SMTP URL, eg: -

+ +

 smtp[s]://[user[:pass]@]host[:port]/
-

-Setting this variable overrides the value of the ``$sendmail'' +

+where “[...]” denotes an optional part. +Setting this variable overrides the value of the $sendmail variable. -

3.270. sort

Type: sort order
+

3.263. sort

Type: sort order
Default: date

-Specifies how to sort messages in the index menu. Valid values +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). -

3.271. sort_alias

Type: sort order
+

  • 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”). +

3.264. sort_alias

Type: sort order
Default: alias

-Specifies how the entries in the `alias' menu are sorted. The +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)
 
-

3.272. sort_aux

Type: sort order
+

  • address (sort alphabetically by email address) +

  • alias (sort alphabetically by alias name) +

  • unsorted (leave in order specified in .muttrc) +

3.265. 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 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 +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 +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, +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). -

3.273. sort_browser

Type: sort order
+

3.266. 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). -

3.274. sort_re

Type: boolean
+

  • alpha (alphabetically) +

  • date +

  • size +

  • unsorted +

+You may optionally use the “reverse-” prefix to specify reverse sorting +order (example: “set sort_browser=reverse-date”). +

3.267. 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 uses to thread messages by subject. With sort_re set, mutt will +$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 +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. -

3.275. 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 +non-$reply_regexp parts of both messages are identical. +

3.268. spam_separator

Type: string
+Default: “,”

+This variable 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 this variable's value as a separator. -

3.276. spoolfile

Type: path
-Default: ""

+

3.269. spoolfile

Type: path
+Default: (empty)

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. -

3.277. 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 +initially set this variable to the value of the environment +variable $MAIL or $MAILDIR if either is defined. +

3.270. ssl_ca_certificates_file

Type: path
+Default: (empty)

+This variable specifies a file containing trusted CA certificates. +Any server certificate that is signed with one of these CA +certificates is also automatically accepted. +

+Example: + +

+set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
+

3.271. ssl_client_cert

Type: path
+Default: (empty)

+The file containing a client certificate and its associated private +key. +

3.272. ssl_force_tls

Type: boolean
+Default: no

+If this variable is set, Mutt 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. +

3.273. ssl_min_dh_prime_bits

Type: number
+Default: 0

+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. +

3.274. ssl_starttls

Type: quadoption
+Default: yes

+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. +

3.275. ssl_use_sslv2

Type: boolean
+Default: no

+This variable specifies whether to attempt to use SSLv2 in the +SSL authentication process. +

3.276. ssl_use_sslv3

Type: boolean
+Default: yes

+This variable specifies whether to attempt to use SSLv3 in the +SSL authentication process. +

3.277. ssl_use_tlsv1

Type: boolean
+Default: yes

+This variable specifies whether to attempt to use TLSv1 in the +SSL authentication process. +

3.278. ssl_usesystemcerts

Type: boolean
+Default: yes

+If set to yes, mutt will use CA certificates in the +system-wide certificate store when checking if a server certificate +is signed by a trusted CA. +

3.279. ssl_verify_dates

Type: boolean
+Default: yes

+If set (the default), mutt will not automatically accept a server +certificate that is either not yet valid or already expired. You should +only unset this for particular known hosts, using the +<account-hook> function. +

3.280. ssl_verify_host

Type: boolean
+Default: yes

+If set (the default), mutt will not automatically accept a server +certificate whose host name does not match the host used in your folder +URL. You should only unset this for particular known hosts, using +the <account-hook> function. +

3.281. 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 +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). -

3.278. status_format

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)---"

-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()-like sequences: -

- -

%b

number of mailboxes with new mail * -

%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 +

3.282. status_format

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)---”

+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 * +
%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 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" -

%*X

soft-fill with character "X" as pad -

- -

-For an explanation of `soft-fill', see the ``$index_format'' documentation. +

%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 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” +
%*X soft-fill with character “X” as pad +

+For an explanation of “soft-fill”, see the $index_format documentation.

* = can be optionally printed if nonzero

@@ -2250,7 +2675,7 @@ 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>? +%?<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 @@ -2260,73 +2685,83 @@ optional strings.

Here is an example illustrating how to optionally print the number of new messages in a mailbox: -%?n?%n new messages.? +

+%?n?%n new messages.?

You can also switch between two strings using the following construct:

-%?<sequence_char>?<if_string>&<else_string>? +%?<sequence_char>?<if_string>&<else_string>?

If the value of sequence_char is non-zero, if_string will be expanded, otherwise else_string will be expanded.

-You can force the result of any printf-like sequence to be lowercase -by prefixing the sequence character with an underscore (_) sign. +You can 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 +you would use: “%_h”.

-If you prefix the sequence character with a colon (:) character, mutt -will replace any dots in the expansion by underscores. This might be helpful +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. -

3.279. status_on_top

Type: boolean
+

3.283. 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. -

3.280. strict_threads

Type: boolean
+Setting this variable causes the “status bar” to be displayed on +the first line of the screen rather than near the bottom. If $help +is set, too it'll be placed at the bottom. +

3.284. strict_threads

Type: boolean
Default: no

-If set, threading will only make use of the ``In-Reply-To'' and -``References'' fields when you ``$sort'' by message threads. By +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 +“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. See also -``$sort_re'' for a less drastic way of controlling this +the subjects like “hi” which will get grouped together. See also +$sort_re for a less drastic way of controlling this behaviour. -

3.281. suspend

Type: boolean
+

3.285. suspend

Type: boolean
Default: yes

When unset, mutt won't stop when the user presses the terminal's -susp key, usually ``control-Z''. This is useful if you run mutt -inside an xterm using a command like xterm -e mutt. -

3.282. text_flowed

Type: boolean
+susp key, usually “^Z”. This is useful if you run mutt +inside an xterm using a command like “xterm -e mutt”. +

3.286. text_flowed

Type: boolean
Default: no

-When set, mutt will generate text/plain; format=flowed attachments. +When set, mutt will generate “format=flowed” bodies with a content type +of “text/plain; format=flowed”. 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 +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. -

3.283. thread_received

Type: boolean
-Default: no

-When set, mutt uses the date received rather than the date sent -to thread messages by subject. -

3.284. thorough_search

Type: boolean
+Note that $indent_string is ignored when this option is set. +

3.287. thorough_search

Type: boolean
Default: no

-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, +Affects the ˜b and ˜h search operations described in +section “patterns”. If set, the headers and body/attachments of +messages to be searched are decoded before searching. If unset, messages are searched as they appear in the folder. -

3.285. tilde

Type: boolean
+

+Users searching attachments or for non-ASCII characters should set +this value because decoding also includes MIME parsing/decoding and possible +character set conversions. Otherwise mutt will attempt to match against the +raw message received (for example quoted-printable encoded or with encoded +headers) which may lead to incorrect search results. +

3.288. thread_received

Type: boolean
Default: no

-When set, the internal-pager will pad blank lines to the bottom of the -screen with a tilde (˜). -

3.286. time_inc

Type: number
+When set, mutt uses the date received rather than the date sent +to thread messages by subject. +

3.289. tilde

Type: boolean
+Default: no

+When set, the internal-pager will pad blank lines to the bottom of the +screen with a tilde (“˜”). +

3.290. time_inc

Type: number
Default: 0

-Along with ``read_inc'', ``write_inc'', and ``net_inc'', this +Along with $read_inc, $write_inc, and $net_inc, this variable controls the frequency with which progress updates are -displayed. It suppresses updates less than ``time_inc'' milliseconds +displayed. It suppresses updates less than $time_inc milliseconds apart. This can improve throughput on systems with slow terminals, or when running mutt on a remote system. -

3.287. timeout

Type: number
+

+Also see the “tuning” section of the manual for performance considerations. +

3.291. timeout

Type: number
Default: 600

When Mutt is waiting for user input either idleing in menus or in an interactive prompt, Mutt would block until input is @@ -2339,188 +2774,147 @@ until it aborts waiting for input, performs these operations and continues to wait for input.

A value of zero or less will cause Mutt to never time out. -

3.288. tmpdir

Type: path
-Default: ""

+

3.292. tmpdir

Type: path
+Default: (empty)

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. -

3.289. to_chars

Type: string
-Default: " +TCFL"

+this variable is not set, the environment variable $TMPDIR is +used. If $TMPDIR is not set then “/tmp” is used. +

3.293. to_chars

Type: string
+Default: “ +TCFL”

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 +first character is the one used when the mail is not addressed to your +address. The second is used when you are the only +recipient of the message. The third is when your address +appears in the “To:” header field, but you are not the only recipient of +the message. 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 subscribe to (default: L). -

3.290. tunnel

Type: string
-Default: ""

+was sent to a mailing-list you subscribe to. +

3.294. tunnel

Type: string
+Default: (empty)

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: -

-tunnel="ssh -q mailhost.net /usr/local/libexec/imapd" -

-NOTE: For this example to work you must be able to log in to the remote +preauthenticated connections to your IMAP/POP3/SMTP server. Example: + +

+set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
+

+Note: For this example to work you must be able to log in to the remote machine without having to enter a password. -

3.291. use_8bitmime

Type: boolean
+

+When set, Mutt uses the tunnel for all remote connections. +Please see “account-hook” in the manual for how to use different +tunnel commands per connection. +

3.295. uncollapse_jump

Type: boolean
+Default: no

+When set, Mutt will jump to the next unread message, if any, +when the current thread is uncollapsed. +

3.296. use_8bitmime

Type: boolean
Default: no

Warning: do not set this variable unless you are using a version -of sendmail which supports the -B8BITMIME flag (such as sendmail +of sendmail which supports the -B8BITMIME flag (such as sendmail 8.8.x) or you may not be able to send mail.

-When set, Mutt will invoke ``$sendmail'' with the -B8BITMIME +When set, Mutt will invoke $sendmail with the -B8BITMIME flag when sending 8-bit messages to enable ESMTP negotiation. -

3.292. use_domain

Type: boolean
+

3.297. use_domain

Type: boolean
Default: yes

-When set, Mutt will qualify all local addresses (ones without the -@host portion) with the value of ``$hostname''. If unset, no +When set, Mutt will qualify all local addresses (ones without the +“@host” portion) with the value of $hostname. If unset, no addresses will be qualified. -

3.293. use_envelope_from

Type: boolean
+

3.298. use_envelope_from

Type: boolean
Default: no

When set, mutt will set the envelope sender of the message. -If ``$envelope_from_address'' is set, it will be used as the sender -address. If not, mutt will attempt to derive the sender from the -"From:" header. +If $envelope_from_address is set, it will be used as the sender +address. If unset, mutt will attempt to derive the sender from the +“From:” header.

Note that this information is passed to sendmail command using the -"-f" command line switch. Therefore setting this option is not useful -if the ``$sendmail'' variable already contains "-f" or if the -executable pointed to by $sendmail doesn't support the "-f" switch. -

3.294. use_from

Type: boolean
-Default: yes

-When set, Mutt 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'' +-f command line switch. Therefore setting this option is not useful +if the $sendmail variable already contains -f or if the +executable pointed to by $sendmail doesn't support the -f switch. +

3.299. use_from

Type: boolean
+Default: yes

+When set, Mutt 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. -

3.295. use_idn

Type: boolean
+

3.300. use_idn

Type: boolean
Default: yes

When set, Mutt will show you international domain names decoded. Note: You can use IDNs for addresses even if this is unset. This variable only affects decoding. -

3.296. use_ipv6

Type: boolean
+

3.301. use_ipv6

Type: boolean
Default: yes

When set, Mutt will look for IPv6 addresses of hosts it tries to -contact. If this option is unset, Mutt will restrict itself to IPv4 addresses. +contact. If this option is unset, Mutt will restrict itself to IPv4 addresses. Normally, the default should work. -

3.297. user_agent

Type: boolean
+

3.302. user_agent

Type: boolean
Default: yes

-When set, mutt will add a "User-Agent" header to outgoing +When set, mutt will add a “User-Agent:” header to outgoing messages, indicating which version of mutt was used for composing them. -

3.298. visual

Type: path
-Default: ""

-Specifies the visual editor to invoke when the ˜v command is +

3.303. visual

Type: path
+Default: (empty)

+Specifies the visual editor to invoke when the “˜v” command is given in the builtin editor. -

3.299. wait_key

Type: boolean
+

3.304. wait_key

Type: boolean
Default: yes

-Controls whether Mutt will ask you to press a key after shell- -escape, pipe-message, pipe-entry, print-message, -and print-entry commands. +Controls whether Mutt will ask you to press a key after an external command +has been invoked by these functions: <shell-escape>, +<pipe-message>, <pipe-entry>, <print-message>, +and <print-entry> commands.

-It is also used when viewing attachments with ``auto_view'', provided +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.

-When set, Mutt will always ask for a key. When unset, Mutt will wait +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. -

3.300. weed

Type: boolean
+

3.305. weed

Type: boolean
Default: yes

-When set, mutt will weed headers when displaying, forwarding, +When set, mutt will weed headers when displaying, forwarding, printing, or replying to messages. -

3.301. wrap

Type: number
+

3.306. wrap

Type: number
Default: 0

-When set to a positive value, mutt will wrap text at $wrap characters. -When set to a negative value, mutt will wrap text so that there are $wrap +When set to a positive value, mutt will wrap text at $wrap characters. +When set to a negative value, mutt will wrap text so that there are $wrap characters of empty space on the right side of the terminal. -

3.302. wrap_search

Type: boolean
+

3.307. wrap_search

Type: boolean
Default: yes

-Controls whether searches wrap around the end of the mailbox. +Controls whether searches wrap around the end.

-When set, searches will wrap around the first (or last) message. When -unset, searches will not wrap. -

3.303. wrapmargin

Type: number
+When set, searches will wrap around the first (or last) item. When +unset, incremental searches will not wrap. +

3.308. wrapmargin

Type: number
Default: 0

-(DEPRECATED) Equivalent to setting wrap with a negative value. -

3.304. write_inc

Type: number
+(DEPRECATED) Equivalent to setting $wrap with a negative value. +

3.309. write_bcc

Type: boolean
+Default: yes

+Controls whether mutt writes out the “Bcc:” header when preparing +messages to be sent. Exim users may wish to unset this. If mutt +is set to deliver directly via SMTP (see $smtp_url), this +option does nothing: mutt will never write out the “Bcc:” header +in this case. +

3.310. write_inc

Type: number
Default: 10

When writing a mailbox, a message will be printed every -write_inc messages to indicate progress. If set to 0, only a +$write_inc 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. -

3.305. write_bcc

Type: boolean
-Default: yes

-Controls whether mutt writes out the Bcc header when preparing -messages to be sent. Exim users may wish to unset this. If mutt -is set to deliver directly via SMTP (see ``$smtp_url''), this -option does nothing: mutt will never write out the BCC header -in this case. +Also see the $read_inc, $net_inc and $time_inc variables and the +“tuning” section of the manual for performance considerations.

4. Functions

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 +functions can be changed with the bind command. -

4.1. generic

+

4.1. Generic Menu

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). -

- -

Table 8.2. Default generic function bindings

FunctionDefault keyDescription
top-pageHmove to the top of the page
next-entryjmove to the next entry
previous-entrykmove to the previous entry
bottom-pageLmove to the bottom of the page
refresh^Lclear and redraw the screen
middle-pageMmove to the middle of the page
search-nextnsearch for next match
exitqexit this menu
tag-entryttag the current entry
next-pagezmove to the next page
previous-pageZmove to the previous page
last-entry*move to the last entry
first-entry=move to the first entry
enter-command:enter a muttrc command
next-line>scroll down one line
previous-line<scroll up one line
half-up[scroll up 1/2 page
half-down]scroll down 1/2 page
help?this screen
tag-prefix;apply next function to tagged messages
tag-prefix-condnot boundapply next function ONLY to tagged messages
end-condnot boundend of conditional execution (noop)
shell-escape!invoke a command in a subshell
select-entryRETselect the current entry
search/search for a regular expression
search-reverseESC /search backwards for a regular expression
search-oppositenot boundsearch for next match in opposite direction
jumpnot boundjump to an index number
current-topnot boundmove entry to top of screen
current-middlenot boundmove entry to middle of screen
current-bottomnot boundmove entry to bottom of screen
what-keynot bounddisplay the keycode for a key press


- -

4.2. index

- -

Table 8.3. Default index function bindings

FunctionDefault keyDescription
create-aliasacreate an alias from a message sender
bounce-messagebremail a message to another user
break-thread#break the thread in two
change-foldercopen a different folder
change-folder-readonlyESC copen a different folder in read only mode
next-unread-mailboxnot boundopen next mailbox with new mail
collapse-threadESC vcollapse/uncollapse current thread
collapse-allESC Vcollapse/uncollapse all threads
copy-messageCcopy a message to a file/mailbox
decode-copyESC Cmake decoded (text/plain) copy
decode-saveESC smake decoded copy (text/plain) and delete
delete-messageddelete the current entry
delete-patternDdelete messages matching a pattern
delete-thread^Ddelete all messages in thread
delete-subthreadESC ddelete all messages in subthread
editeedit the raw message
edit-type^Eedit attachment content type
forward-messagefforward a message with comments
flag-messageFtoggle a message's 'important' flag
group-replygreply to all recipients
fetch-mailGretrieve mail from POP server
imap-fetch-mailnot boundforce retrieval of mail from IMAP server
display-toggle-weedhdisplay message and toggle header weeding
next-undeletedjmove to the next undeleted message
previous-undeletedkmove to the previous undeleted message
limitlshow only messages matching a pattern
link-threads&link tagged message to the current one
list-replyLreply to specified mailing list
mailmcompose a new mail message
toggle-newNtoggle a message's 'new' flag
toggle-write%toggle whether the mailbox will be rewritten
next-thread^Njump to the next thread
next-subthreadESC njump to the next subthread
queryQquery external program for addresses
quitqsave changes to mailbox and quit
replyrreply to a message
show-limitESC lshow currently active limit pattern
sort-mailboxosort messages
sort-reverseOsort messages in reverse order
print-messagepprint the current entry
previous-thread^Pjump to previous thread
previous-subthreadESC pjump to previous subthread
recall-messageRrecall a postponed message
read-thread^Rmark the current thread as read
read-subthreadESC rmark the current subthread as read
resend-messageESC euse the current message as a template for a new one
save-messagessave message/attachment to a file
tag-patternTtag messages matching a pattern
tag-subthreadnot boundtag the current subthread
tag-threadESC ttag the current thread
untag-pattern^Tuntag messages matching a pattern
undelete-messageuundelete the current entry
undelete-patternUundelete messages matching a pattern
undelete-subthreadESC uundelete all messages in subthread
undelete-thread^Uundelete all messages in thread
view-attachmentsvshow MIME attachments
show-versionVshow the Mutt version number and date
set-flagwset a status flag on a message
clear-flagWclear a status flag from a message
display-messageRETdisplay a message
buffy-list.list mailboxes with new mail
sync-mailbox$save changes to mailbox
display-address@display full address of sender
pipe-message|pipe message/attachment to a shell command
next-newnot boundjump to the next new message
next-new-then-unreadTABjump to the next new or unread message
previous-newnot boundjump to the previous new message
previous-new-then-unreadESC TABjump to the previous new or unread message
next-unreadnot boundjump to the next unread message
previous-unreadnot boundjump to the previous unread message
parent-messagePjump to parent message in thread
extract-keys^Kextract supported public keys
forget-passphrase^Fwipe passphrase(s) from memory
check-traditional-pgpESC Pcheck for classic PGP
mail-keyESC kmail a PGP public key
decrypt-copynot boundmake decrypted copy
decrypt-savenot boundmake decrypted copy and delete


- -

4.3. pager

- -

Table 8.4. Default pager function bindings

FunctionDefault keyDescription
break-thread#break the thread in two
create-aliasacreate an alias from a message sender
bounce-messagebremail a message to another user
change-foldercopen a different folder
change-folder-readonlyESC copen a different folder in read only mode
next-unread-mailboxnot boundopen next mailbox with new mail
copy-messageCcopy a message to a file/mailbox
decode-copyESC Cmake decoded (text/plain) copy
delete-messageddelete the current entry
delete-thread^Ddelete all messages in thread
delete-subthreadESC ddelete all messages in subthread
editeedit the raw message
edit-type^Eedit attachment content type
forward-messagefforward a message with comments
flag-messageFtoggle a message's 'important' flag
group-replygreply to all recipients
imap-fetch-mailnot boundforce retrieval of mail from IMAP server
display-toggle-weedhdisplay message and toggle header weeding
next-undeletedjmove to the next undeleted message
next-entryJmove to the next entry
previous-undeletedkmove to the previous undeleted message
previous-entryKmove to the previous entry
link-threads&link tagged message to the current one
list-replyLreply to specified mailing list
redraw-screen^Lclear and redraw the screen
mailmcompose a new mail message
mark-as-newNtoggle a message's 'new' flag
search-nextnsearch for next match
next-thread^Njump to the next thread
next-subthreadESC njump to the next subthread
print-messagepprint the current entry
previous-thread^Pjump to previous thread
previous-subthreadESC pjump to previous subthread
quitQsave changes to mailbox and quit
exitqexit this menu
replyrreply to a message
recall-messageRrecall a postponed message
read-thread^Rmark the current thread as read
read-subthreadESC rmark the current subthread as read
resend-messageESC euse the current message as a template for a new one
save-messagessave message/attachment to a file
skip-quotedSskip beyond quoted text
decode-saveESC smake decoded copy (text/plain) and delete
tag-messagettag the current entry
toggle-quotedTtoggle display of quoted text
undelete-messageuundelete the current entry
undelete-subthreadESC uundelete all messages in subthread
undelete-thread^Uundelete all messages in thread
view-attachmentsvshow MIME attachments
show-versionVshow the Mutt version number and date
search-toggle\\toggle search pattern coloring
display-address@display full address of sender
next-newnot boundjump to the next new message
pipe-message|pipe message/attachment to a shell command
help?this screen
next-pageSpacemove to the next page
previous-page-move to the previous page
top^jump to the top of the message
sync-mailbox$save changes to mailbox
shell-escape!invoke a command in a subshell
enter-command:enter a muttrc command
buffy-list.list mailboxes with new mail
search/search for a regular expression
search-reverseESC /search backwards for a regular expression
search-oppositenot boundsearch for next match in opposite direction
next-lineRETscroll down one line
jumpnot boundjump to an index number
next-unreadnot boundjump to the next unread message
previous-newnot boundjump to the previous new message
previous-unreadnot boundjump to the previous unread message
half-upnot boundscroll up 1/2 page
half-downnot boundscroll down 1/2 page
previous-linenot boundscroll up one line
bottomnot boundjump to the bottom of the message
parent-messagePjump to parent message in thread
check-traditional-pgpESC Pcheck for classic PGP
mail-keyESC kmail a PGP public key
extract-keys^Kextract supported public keys
forget-passphrase^Fwipe passphrase(s) from memory
decrypt-copynot boundmake decrypted copy
decrypt-savenot boundmake decrypted copy and delete


- -

4.4. alias

- -

Table 8.5. Default alias function bindings

FunctionDefault keyDescription
delete-entryddelete the current entry
undelete-entryuundelete the current entry


- -

4.5. query

- -

Table 8.6. Default query function bindings

FunctionDefault keyDescription
create-aliasacreate an alias from a message sender
mailmcompose a new mail message
queryQquery external program for addresses
query-appendAappend new query results to current results


- -

4.6. attach

- -

Table 8.7. Default attach function bindings

FunctionDefault keyDescription
bounce-messagebremail a message to another user
display-toggle-weedhdisplay message and toggle header weeding
edit-type^Eedit attachment content type
print-entrypprint the current entry
save-entryssave message/attachment to a file
pipe-entry|pipe message/attachment to a shell command
view-mailcapmforce viewing of attachment using mailcap
replyrreply to a message
resend-messageESC euse the current message as a template for a new one
group-replygreply to all recipients
list-replyLreply to specified mailing list
forward-messagefforward a message with comments
view-textTview attachment as text
view-attachRETview attachment using mailcap entry if necessary
delete-entryddelete the current entry
undelete-entryuundelete the current entry
collapse-partsvToggle display of subparts
check-traditional-pgpESC Pcheck for classic PGP
extract-keys^Kextract supported public keys
forget-passphrase^Fwipe passphrase(s) from memory


- -

4.7. compose

- -

Table 8.8. Default compose function bindings

FunctionDefault keyDescription
attach-fileaattach file(s) to this message
attach-messageAattach message(s) to this message
edit-bccbedit the BCC list
edit-cccedit the CC list
copy-fileCsave message/attachment to a file
detach-fileDdelete the current entry
toggle-disposition^Dtoggle disposition between inline/attachment
edit-descriptiondedit attachment description
edit-messageeedit the message
edit-headersEedit the message with headers
edit-file^X eedit the file to be attached
edit-encoding^Eedit attachment transfer-encoding
edit-fromESC fedit the from field
edit-fccfenter a file to save a copy of this message in
filter-entryFfilter attachment through a shell command
get-attachmentGget a temporary copy of an attachment
display-toggle-weedhdisplay message and toggle header weeding
ispellirun ispell on the message
print-entrylprint the current entry
edit-mimemedit attachment using mailcap entry
new-mimencompose new attachment using mailcap entry
postpone-messagePsave this message to send later
edit-reply-toredit the Reply-To field
rename-fileRrename/move an attached file
edit-subjectsedit the subject of this message
edit-totedit the TO list
edit-type^Tedit attachment content type
write-fccwwrite the message to a folder
toggle-unlinkutoggle whether to delete file after sending it
toggle-recodenot boundtoggle recoding of this attachment
update-encodingUupdate an attachment's encoding info
view-attachRETview attachment using mailcap entry if necessary
send-messageysend the message
pipe-entry|pipe message/attachment to a shell command
attach-keyESC kattach a PGP public key
pgp-menupshow PGP options
forget-passphrase^Fwipe passphrase(s) from memory
smime-menuSshow S/MIME options
mixMsend the message through a mixmaster remailer chain


- -

4.8. postpone

- -

Table 8.9. Default postpone function bindings

FunctionDefault keyDescription
delete-entryddelete the current entry
undelete-entryuundelete the current entry


- -

4.9. browser

- -

Table 8.10. Default browser function bindings

FunctionDefault keyDescription
change-dircchange directories
display-filename@display the currently selected file's name
enter-maskmenter a file mask
sortosort messages
sort-reverseOsort messages in reverse order
select-newNselect a new file in this directory
check-newnot boundcheck mailboxes for new mail
toggle-mailboxesTABtoggle whether to browse mailboxes or all files
view-fileSpaceview file
buffy-list.list mailboxes with new mail
create-mailboxCcreate a new mailbox (IMAP only)
delete-mailboxddelete the current mailbox (IMAP only)
rename-mailboxrrename the current mailbox (IMAP only)
subscribessubscribe to current mailbox (IMAP only)
unsubscribeuunsubscribe from current mailbox (IMAP only)
toggle-subscribedTtoggle view all/subscribed mailboxes (IMAP only)


- -

4.10. pgp

- -

Table 8.11. Default pgp function bindings

FunctionDefault keyDescription
verify-keycverify a PGP public key
view-name%view the key's user id


- -

4.11. smime

- -

Table 8.12. Default smime function bindings

FunctionDefault keyDescription
verify-keycverify a PGP public key
view-name%view the key's user id


- -

4.12. mix

- -

Table 8.13. Default mix function bindings

FunctionDefault keyDescription
acceptRETAccept the chain constructed
appendaAppend a remailer to the chain
insertiInsert a remailer into the chain
deletedDelete a remailer from the chain
chain-prevleftSelect the previous element of the chain
chain-nextrightSelect the next element of the chain


- -

4.13. editor

- -

Table 8.14. Default editor function bindings

FunctionDefault keyDescription
bol^Ajump to the beginning of the line
backward-char^Bmove the cursor one character to the left
backward-wordESC bmove the cursor to the beginning of the word
capitalize-wordESC ccapitalize the word
downcase-wordESC lconvert the word to lower case
upcase-wordESC uconvert the word to upper case
delete-char^Ddelete the char under the cursor
eol^Ejump to the end of the line
forward-char^Fmove the cursor one character to the right
forward-wordESC fmove the cursor to the end of the word
backspaceBackspacedelete the char in front of the cursor
kill-eol^Kdelete chars from cursor to end of line
kill-eowESC ddelete chars from the cursor to the end of the word
kill-line^Udelete all chars on the line
quote-char^Vquote the next typed key
kill-word^Wdelete the word in front of the cursor
completeTABcomplete filename or alias
complete-query^Tcomplete address with query
buffy-cycleSpacecycle among incoming mailboxes
history-upnot boundscroll up through the history list
history-downnot boundscroll down through the history list
transpose-charsnot boundtranspose character under cursor with previous


- -

+

Table 9.2. Default generic Function Bindings

FunctionDefault keyDescription
<top-page>Hmove to the top of the page
<next-entry>jmove to the next entry
<previous-entry>kmove to the previous entry
<bottom-page>Lmove to the bottom of the page
<refresh>^Lclear and redraw the screen
<middle-page>Mmove to the middle of the page
<search-next>nsearch for next match
<exit>qexit this menu
<tag-entry>ttag the current entry
<next-page>zmove to the next page
<previous-page>Zmove to the previous page
<last-entry>*move to the last entry
<first-entry>=move to the first entry
<enter-command>:enter a muttrc command
<next-line>>scroll down one line
<previous-line><scroll up one line
<half-up>[scroll up 1/2 page
<half-down>]scroll down 1/2 page
<help>?this screen
<tag-prefix>;apply next function to tagged messages
<tag-prefix-cond> apply next function ONLY to tagged messages
<end-cond> end of conditional execution (noop)
<shell-escape>!invoke a command in a subshell
<select-entry><Return>select the current entry
<search>/search for a regular expression
<search-reverse>Esc /search backwards for a regular expression
<search-opposite> search for next match in opposite direction
<jump> jump to an index number
<current-top> move entry to top of screen
<current-middle> move entry to middle of screen
<current-bottom> move entry to bottom of screen
<what-key> display the keycode for a key press

4.2. Index Menu

Table 9.3. Default index Function Bindings

FunctionDefault keyDescription
<create-alias>acreate an alias from a message sender
<bounce-message>bremail a message to another user
<break-thread>#break the thread in two
<change-folder>copen a different folder
<change-folder-readonly>Esc copen a different folder in read only mode
<next-unread-mailbox> open next mailbox with new mail
<collapse-thread>Esc vcollapse/uncollapse current thread
<collapse-all>Esc Vcollapse/uncollapse all threads
<copy-message>Ccopy a message to a file/mailbox
<decode-copy>Esc Cmake decoded (text/plain) copy
<decode-save>Esc smake decoded copy (text/plain) and delete
<delete-message>ddelete the current entry
<delete-pattern>Ddelete messages matching a pattern
<delete-thread>^Ddelete all messages in thread
<delete-subthread>Esc ddelete all messages in subthread
<edit>eedit the raw message
<edit-type>^Eedit attachment content type
<forward-message>fforward a message with comments
<flag-message>Ftoggle a message's 'important' flag
<group-reply>greply to all recipients
<fetch-mail>Gretrieve mail from POP server
<imap-fetch-mail> force retrieval of mail from IMAP server
<display-toggle-weed>hdisplay message and toggle header weeding
<next-undeleted>jmove to the next undeleted message
<previous-undeleted>kmove to the previous undeleted message
<limit>lshow only messages matching a pattern
<link-threads>&link tagged message to the current one
<list-reply>Lreply to specified mailing list
<mail>mcompose a new mail message
<toggle-new>Ntoggle a message's 'new' flag
<toggle-write>%toggle whether the mailbox will be rewritten
<next-thread>^Njump to the next thread
<next-subthread>Esc njump to the next subthread
<query>Qquery external program for addresses
<quit>qsave changes to mailbox and quit
<reply>rreply to a message
<show-limit>Esc lshow currently active limit pattern
<sort-mailbox>osort messages
<sort-reverse>Osort messages in reverse order
<print-message>pprint the current entry
<previous-thread>^Pjump to previous thread
<previous-subthread>Esc pjump to previous subthread
<recall-message>Rrecall a postponed message
<read-thread>^Rmark the current thread as read
<read-subthread>Esc rmark the current subthread as read
<resend-message>Esc euse the current message as a template for a new one
<save-message>ssave message/attachment to a mailbox/file
<tag-pattern>Ttag messages matching a pattern
<tag-subthread> tag the current subthread
<tag-thread>Esc ttag the current thread
<untag-pattern>^Tuntag messages matching a pattern
<undelete-message>uundelete the current entry
<undelete-pattern>Uundelete messages matching a pattern
<undelete-subthread>Esc uundelete all messages in subthread
<undelete-thread>^Uundelete all messages in thread
<view-attachments>vshow MIME attachments
<show-version>Vshow the Mutt version number and date
<set-flag>wset a status flag on a message
<clear-flag>Wclear a status flag from a message
<display-message><Return>display a message
<buffy-list>.list mailboxes with new mail
<sync-mailbox>$save changes to mailbox
<display-address>@display full address of sender
<pipe-message>|pipe message/attachment to a shell command
<next-new> jump to the next new message
<next-new-then-unread><Tab>jump to the next new or unread message
<previous-new> jump to the previous new message
<previous-new-then-unread>Esc <Tab>jump to the previous new or unread message
<next-unread> jump to the next unread message
<previous-unread> jump to the previous unread message
<parent-message>Pjump to parent message in thread
<extract-keys>^Kextract supported public keys
<forget-passphrase>^Fwipe passphrase(s) from memory
<check-traditional-pgp>Esc Pcheck for classic PGP
<mail-key>Esc kmail a PGP public key
<decrypt-copy> make decrypted copy
<decrypt-save> make decrypted copy and delete

4.3. Pager Menu

Table 9.4. Default pager Function Bindings

FunctionDefault keyDescription
<break-thread>#break the thread in two
<create-alias>acreate an alias from a message sender
<bounce-message>bremail a message to another user
<change-folder>copen a different folder
<change-folder-readonly>Esc copen a different folder in read only mode
<next-unread-mailbox> open next mailbox with new mail
<copy-message>Ccopy a message to a file/mailbox
<decode-copy>Esc Cmake decoded (text/plain) copy
<delete-message>ddelete the current entry
<delete-thread>^Ddelete all messages in thread
<delete-subthread>Esc ddelete all messages in subthread
<set-flag>wset a status flag on a message
<clear-flag>Wclear a status flag from a message
<edit>eedit the raw message
<edit-type>^Eedit attachment content type
<forward-message>fforward a message with comments
<flag-message>Ftoggle a message's 'important' flag
<group-reply>greply to all recipients
<imap-fetch-mail> force retrieval of mail from IMAP server
<display-toggle-weed>hdisplay message and toggle header weeding
<next-undeleted>jmove to the next undeleted message
<next-entry>Jmove to the next entry
<previous-undeleted>kmove to the previous undeleted message
<previous-entry>Kmove to the previous entry
<link-threads>&link tagged message to the current one
<list-reply>Lreply to specified mailing list
<redraw-screen>^Lclear and redraw the screen
<mail>mcompose a new mail message
<mark-as-new>Ntoggle a message's 'new' flag
<search-next>nsearch for next match
<next-thread>^Njump to the next thread
<next-subthread>Esc njump to the next subthread
<print-message>pprint the current entry
<previous-thread>^Pjump to previous thread
<previous-subthread>Esc pjump to previous subthread
<quit>Qsave changes to mailbox and quit
<exit>qexit this menu
<reply>rreply to a message
<recall-message>Rrecall a postponed message
<read-thread>^Rmark the current thread as read
<read-subthread>Esc rmark the current subthread as read
<resend-message>Esc euse the current message as a template for a new one
<save-message>ssave message/attachment to a mailbox/file
<skip-quoted>Sskip beyond quoted text
<decode-save>Esc smake decoded copy (text/plain) and delete
<tag-message>ttag the current entry
<toggle-quoted>Ttoggle display of quoted text
<undelete-message>uundelete the current entry
<undelete-subthread>Esc uundelete all messages in subthread
<undelete-thread>^Uundelete all messages in thread
<view-attachments>vshow MIME attachments
<show-version>Vshow the Mutt version number and date
<search-toggle>\\toggle search pattern coloring
<display-address>@display full address of sender
<next-new> jump to the next new message
<pipe-message>|pipe message/attachment to a shell command
<help>?this screen
<next-page><Space>move to the next page
<previous-page>-move to the previous page
<top>^jump to the top of the message
<sync-mailbox>$save changes to mailbox
<shell-escape>!invoke a command in a subshell
<enter-command>:enter a muttrc command
<buffy-list>.list mailboxes with new mail
<search>/search for a regular expression
<search-reverse>Esc /search backwards for a regular expression
<search-opposite> search for next match in opposite direction
<next-line><Return>scroll down one line
<jump> jump to an index number
<next-unread> jump to the next unread message
<previous-new> jump to the previous new message
<previous-unread> jump to the previous unread message
<half-up> scroll up 1/2 page
<half-down> scroll down 1/2 page
<previous-line> scroll up one line
<bottom> jump to the bottom of the message
<parent-message>Pjump to parent message in thread
<check-traditional-pgp>Esc Pcheck for classic PGP
<mail-key>Esc kmail a PGP public key
<extract-keys>^Kextract supported public keys
<forget-passphrase>^Fwipe passphrase(s) from memory
<decrypt-copy> make decrypted copy
<decrypt-save> make decrypted copy and delete
<what-key> display the keycode for a key press

4.4. Alias Menu

Table 9.5. Default alias Function Bindings

FunctionDefault keyDescription
<delete-entry>ddelete the current entry
<undelete-entry>uundelete the current entry

4.5. Query Menu

Table 9.6. Default query Function Bindings

FunctionDefault keyDescription
<create-alias>acreate an alias from a message sender
<mail>mcompose a new mail message
<query>Qquery external program for addresses
<query-append>Aappend new query results to current results

4.6. Attach Menu

Table 9.7. Default attach Function Bindings

FunctionDefault keyDescription
<bounce-message>bremail a message to another user
<display-toggle-weed>hdisplay message and toggle header weeding
<edit-type>^Eedit attachment content type
<print-entry>pprint the current entry
<save-entry>ssave message/attachment to a mailbox/file
<pipe-entry>|pipe message/attachment to a shell command
<view-mailcap>mforce viewing of attachment using mailcap
<reply>rreply to a message
<resend-message>Esc euse the current message as a template for a new one
<group-reply>greply to all recipients
<list-reply>Lreply to specified mailing list
<forward-message>fforward a message with comments
<view-text>Tview attachment as text
<view-attach><Return>view attachment using mailcap entry if necessary
<delete-entry>ddelete the current entry
<undelete-entry>uundelete the current entry
<collapse-parts>vToggle display of subparts
<check-traditional-pgp>Esc Pcheck for classic PGP
<extract-keys>^Kextract supported public keys
<forget-passphrase>^Fwipe passphrase(s) from memory

4.7. Compose Menu

Table 9.8. Default compose Function Bindings

FunctionDefault keyDescription
<attach-file>aattach file(s) to this message
<attach-message>Aattach message(s) to this message
<edit-bcc>bedit the BCC list
<edit-cc>cedit the CC list
<copy-file>Csave message/attachment to a mailbox/file
<detach-file>Ddelete the current entry
<toggle-disposition>^Dtoggle disposition between inline/attachment
<edit-description>dedit attachment description
<edit-message>eedit the message
<edit-headers>Eedit the message with headers
<edit-file>^X eedit the file to be attached
<edit-encoding>^Eedit attachment transfer-encoding
<edit-from>Esc fedit the from field
<edit-fcc>fenter a file to save a copy of this message in
<filter-entry>Ffilter attachment through a shell command
<get-attachment>Gget a temporary copy of an attachment
<display-toggle-weed>hdisplay message and toggle header weeding
<ispell>irun ispell on the message
<print-entry>lprint the current entry
<edit-mime>medit attachment using mailcap entry
<new-mime>ncompose new attachment using mailcap entry
<postpone-message>Psave this message to send later
<edit-reply-to>redit the Reply-To field
<rename-file>Rrename/move an attached file
<edit-subject>sedit the subject of this message
<edit-to>tedit the TO list
<edit-type>^Tedit attachment content type
<write-fcc>wwrite the message to a folder
<toggle-unlink>utoggle whether to delete file after sending it
<toggle-recode> toggle recoding of this attachment
<update-encoding>Uupdate an attachment's encoding info
<view-attach><Return>view attachment using mailcap entry if necessary
<send-message>ysend the message
<pipe-entry>|pipe message/attachment to a shell command
<attach-key>Esc kattach a PGP public key
<pgp-menu>pshow PGP options
<forget-passphrase>^Fwipe passphrase(s) from memory
<smime-menu>Sshow S/MIME options
<mix>Msend the message through a mixmaster remailer chain

4.8. Postpone Menu

Table 9.9. Default postpone Function Bindings

FunctionDefault keyDescription
<delete-entry>ddelete the current entry
<undelete-entry>uundelete the current entry

4.9. Browser Menu

Table 9.10. Default browser Function Bindings

FunctionDefault keyDescription
<change-dir>cchange directories
<display-filename>@display the currently selected file's name
<enter-mask>menter a file mask
<sort>osort messages
<sort-reverse>Osort messages in reverse order
<select-new>Nselect a new file in this directory
<check-new> check mailboxes for new mail
<toggle-mailboxes><Tab>toggle whether to browse mailboxes or all files
<view-file><Space>view file
<buffy-list>.list mailboxes with new mail
<create-mailbox>Ccreate a new mailbox (IMAP only)
<delete-mailbox>ddelete the current mailbox (IMAP only)
<rename-mailbox>rrename the current mailbox (IMAP only)
<subscribe>ssubscribe to current mailbox (IMAP only)
<unsubscribe>uunsubscribe from current mailbox (IMAP only)
<toggle-subscribed>Ttoggle view all/subscribed mailboxes (IMAP only)

4.10. Pgp Menu

Table 9.11. Default pgp Function Bindings

FunctionDefault keyDescription
<verify-key>cverify a PGP public key
<view-name>%view the key's user id

4.11. Smime Menu

Table 9.12. Default smime Function Bindings

FunctionDefault keyDescription
<verify-key>cverify a PGP public key
<view-name>%view the key's user id

4.12. Mix Menu

Table 9.13. Default mix Function Bindings

FunctionDefault keyDescription
<accept><Return>Accept the chain constructed
<append>aAppend a remailer to the chain
<insert>iInsert a remailer into the chain
<delete>dDelete a remailer from the chain
<chain-prev><Left>Select the previous element of the chain
<chain-next><Right>Select the next element of the chain

4.13. Editor Menu

Table 9.14. Default editor Function Bindings

FunctionDefault keyDescription
<bol>^Ajump to the beginning of the line
<backward-char>^Bmove the cursor one character to the left
<backward-word>Esc bmove the cursor to the beginning of the word
<capitalize-word>Esc ccapitalize the word
<downcase-word>Esc lconvert the word to lower case
<upcase-word>Esc uconvert the word to upper case
<delete-char>^Ddelete the char under the cursor
<eol>^Ejump to the end of the line
<forward-char>^Fmove the cursor one character to the right
<forward-word>Esc fmove the cursor to the end of the word
<backspace><Backspace>delete the char in front of the cursor
<kill-eol>^Kdelete chars from cursor to end of line
<kill-eow>Esc ddelete chars from the cursor to the end of the word
<kill-line>^Udelete all chars on the line
<quote-char>^Vquote the next typed key
<kill-word>^Wdelete the word in front of the cursor
<complete><Tab>complete filename or alias
<complete-query>^Tcomplete address with query
<buffy-cycle><Space>cycle among incoming mailboxes
<history-up> scroll up through the history list
<history-down> scroll down through the history list
<transpose-chars> transpose character under cursor with previous