The NeoMutt E-Mail Client

Michael Elkins

   <me@cs.hmc.edu>

   version 20180223

   Abstract

   "All mail clients suck. This one just sucks less."-- me, circa 1995
     __________________________________________________________________

   Table of Contents

   1. Introduction

        1. NeoMutt Home Page
        2. Mailing Lists
        3. NeoMutt Online Resources
        4. Contributing to NeoMutt
        5. Typographical Conventions
        6. Copyright

   2. Getting Started

        1. Core Concepts
        2. Screens and Menus

              2.1. Index
              2.2. Pager
              2.3. File Browser
              2.4. Sidebar
              2.5. Help
              2.6. Compose Menu
              2.7. Alias Menu
              2.8. Attachment Menu

        3. Moving Around in Menus
        4. Editing Input Fields

              4.1. Introduction
              4.2. History

        5. Reading Mail

              5.1. The Message Index
              5.2. The Pager
              5.3. Threaded Mode
              5.4. Miscellaneous Functions

        6. Sending Mail

              6.1. Introduction
              6.2. Editing the Message Header
              6.3. Sending Cryptographically Signed/Encrypted Messages
              6.4. Sending Format=Flowed Messages

        7. Forwarding and Bouncing Mail
        8. Postponing Mail

   3. Configuration

        1. Location of Initialization Files

              1.1. Location of system config files
              1.2. Location of user config files

        2. Syntax of Initialization Files
        3. Address Groups
        4. Defining/Using Aliases
        5. Changing the Default Key Bindings

              5.1. Warnings about Duplicated Bindings

        6. Defining Aliases for Character Sets
        7. Setting Variables Based Upon Mailbox
        8. Keyboard Macros
        9. Using Color and Mono Video Attributes
        10. Message Header Display

              10.1. Header Display
              10.2. Selecting Headers
              10.3. Ordering Displayed Headers

        11. Alternative Addresses
        12. Mailing Lists
        13. Using Multiple Spool Mailboxes
        14. Monitoring Incoming Mail
        15. User-Defined Headers
        16. Specify Default Save Mailbox
        17. Specify Default Fcc: Mailbox When Composing
        18. Specify Default Save Filename and Default Fcc: Mailbox at Once
        19. Change Settings Based Upon Message Recipients
        20. Change Settings Before Formatting a Message
        21. Choosing the Cryptographic Key of the Recipient
        22. Adding Key Sequences to the Keyboard Buffer
        23. Executing Functions
        24. Message Scoring
        25. Spam Detection
        26. Setting and Querying Variables

              26.1. Variable Types
              26.2. Commands
              26.3. User-Defined Variables
              26.4. Type Conversions

        27. Reading Initialization Commands From Another File
        28. Removing Hooks
        29. Format Strings

              29.1. Basic usage
              29.2. Conditionals
              29.3. Filters
              29.4. Padding
              29.5. Conditional Dates

        30. Control allowed header fields in a mailto: URL

   4. Advanced Usage

        1. Character Set Handling
        2. Regular Expressions
        3. Patterns: Searching, Limiting and Tagging

              3.1. Pattern Modifier
              3.2. Simple Searches
              3.3. Nesting and Boolean Operators
              3.4. Searching by Date
              3.5. GMail Patterns

        4. Marking Messages
        5. Using Tags
        6. Using Hooks

              6.1. Message Matching in Hooks
              6.2. Mailbox Matching in Hooks

        7. Managing the Environment
        8. External Address Queries
        9. Mailbox Formats
        10. Mailbox Shortcuts
        11. Handling Mailing Lists
        12. Display Munging
        13. New Mail Detection

              13.1. How New Mail Detection Works
              13.2. Polling For New Mail
              13.3. Calculating Mailbox Message Counts

        14. Editing Threads

              14.1. Linking Threads
              14.2. Breaking Threads

        15. Delivery Status Notification (DSN) Support
        16. Start a WWW Browser on URLs
        17. Miscellany

   5. NeoMutt's MIME Support

        1. Using MIME in NeoMutt

              1.1. MIME Overview
              1.2. Viewing MIME Messages in the Pager
              1.3. The Attachment Menu
              1.4. The Compose Menu

        2. MIME Type Configuration with mime.types
        3. MIME Viewer Configuration with Mailcap

              3.1. The Basics of the Mailcap File
              3.2. Secure Use of Mailcap
              3.3. Advanced Mailcap Usage
              3.4. Example Mailcap Files

        4. MIME Autoview
        5. MIME Multipart/Alternative
        6. Attachment Searching and Counting
        7. MIME Lookup

   6. Optional Features

        1. General Notes

              1.1. Enabling/Disabling Features
              1.2. URL Syntax

        2. SSL/TLS Support
        3. POP3 Support
        4. IMAP Support

              4.1. The IMAP Folder Browser
              4.2. Authentication

        5. SMTP Support
        6. Managing Multiple Accounts
        7. Local Caching

              7.1. Header Caching
              7.2. Body Caching
              7.3. Cache Directories
              7.4. Maintenance

        8. Sending Anonymous Messages via Mixmaster
        9. Attach Headers Color Feature

              9.1. Support
              9.2. Introduction
              9.3. Usage
              9.4. neomuttrc
              9.5. See Also
              9.6. Known Bugs
              9.7. Credits

        10. Compose to Sender Feature

              10.1. Support
              10.2. Introduction
              10.3. Functions
              10.4. neomuttrc
              10.5. Known Bugs
              10.6. Credits

        11. Compressed Folders Feature

              11.1. Support
              11.2. Introduction
              11.3. Commands
              11.4. neomuttrc
              11.5. See Also
              11.6. Credits

        12. Conditional Dates Feature

              12.1. Support
              12.2. Introduction
              12.3. Variables
              12.4. neomuttrc
              12.5. See Also
              12.6. Known Bugs
              12.7. Credits

        13. Encrypt-to-Self Feature

              13.1. Support
              13.2. Introduction
              13.3. Variables
              13.4. neomuttrc
              13.5. Known Bugs
              13.6. Credits

        14. Fmemopen Feature

              14.1. Support
              14.2. Introduction
              14.3. See Also
              14.4. Known Bugs
              14.5. Credits

        15. Forgotten Attachment Feature

              15.1. Support
              15.2. Introduction
              15.3. Variables
              15.4. neomuttrc
              15.5. See Also
              15.6. Known Bugs
              15.7. Credits

        16. Global Hooks

              16.1. Introduction
              16.2. Commands
              16.3. neomuttrc
              16.4. See Also
              16.5. Known Bugs
              16.6. Credits

        17. Ifdef Feature

              17.1. Support
              17.2. Introduction
              17.3. Commands
              17.4. neomuttrc
              17.5. Known Bugs
              17.6. Credits

        18. Index Color Feature

              18.1. Support
              18.2. Introduction
              18.3. Colors
              18.4. neomuttrc
              18.5. See Also
              18.6. Known Bugs
              18.7. Credits

        19. Initials Expando Feature

              19.1. Support
              19.2. Introduction
              19.3. Variables
              19.4. neomuttrc
              19.5. See Also
              19.6. Known Bugs
              19.7. Credits

        20. Kyoto Cabinet Feature

              20.1. Support
              20.2. Introduction
              20.3. See Also
              20.4. Known Bugs
              20.5. Credits

        21. Limit Current Thread Feature

              21.1. Support
              21.2. Introduction
              21.3. Functions
              21.4. neomuttrc
              21.5. Known Bugs
              21.6. Credits

        22. LMDB Feature

              22.1. Support
              22.2. Introduction
              22.3. See Also
              22.4. Known Bugs
              22.5. Credits

        23. Multiple FCC Feature

              23.1. Support
              23.2. Introduction
              23.3. See Also
              23.4. Known Bugs
              23.5. Credits

        24. Nested If Feature

              24.1. Support
              24.2. Introduction
              24.3. Variables
              24.4. neomuttrc
              24.5. See Also
              24.6. Known Bugs
              24.7. Credits

        25. New Mail Feature

              25.1. Support
              25.2. Introduction
              25.3. Variables
              25.4. neomuttrc
              25.5. See Also
              25.6. Known Bugs
              25.7. Credits

        26. NNTP Feature

              26.1. Support
              26.2. Introduction
              26.3. Variables
              26.4. Functions
              26.5. neomuttrc
              26.6. Known Bugs
              26.7. Credits

        27. Custom backend based Tags Feature

              27.1. Support
              27.2. Introduction
              27.3. Variables
              27.4. Functions
              27.5. Commands
              27.6. Colors
              27.7. neomuttrc
              27.8. Credits

        28. Notmuch Feature

              28.1. Support
              28.2. Introduction
              28.3. Using Notmuch
              28.4. Variables
              28.5. Functions
              28.6. Commands
              28.7. Colors
              28.8. neomuttrc
              28.9. See Also
              28.10. Known Bugs
              28.11. Credits

        29. Progress Bar Feature

              29.1. Support
              29.2. Introduction
              29.3. Colors
              29.4. neomuttrc
              29.5. See Also
              29.6. Known Bugs
              29.7. Credits

        30. Quasi-Delete Feature

              30.1. Support
              30.2. Introduction
              30.3. Functions
              30.4. neomuttrc
              30.5. See Also
              30.6. Known Bugs
              30.7. Credits

        31. Reply With X-Original-To Feature

              31.1. Support
              31.2. Introduction
              31.3. Variables
              31.4. neomuttrc
              31.5. Credits

        32. Sensible Browser Feature

              32.1. Support
              32.2. Introduction
              32.3. See Also
              32.4. Known Bugs
              32.5. Credits

        33. Sidebar Feature

              33.1. Support
              33.2. Introduction
              33.3. Variables
              33.4. Functions
              33.5. Commands
              33.6. Colors
              33.7. Sort
              33.8. neomuttrc
              33.9. See Also
              33.10. Known Bugs
              33.11. Credits

        34. Skip Quoted Feature

              34.1. Support
              34.2. Introduction
              34.3. Variables
              34.4. neomuttrc
              34.5. Known Bugs
              34.6. Credits

        35. Status Color Feature

              35.1. Support
              35.2. Introduction
              35.3. Commands
              35.4. Colors
              35.5. neomuttrc
              35.6. See Also
              35.7. Known Bugs
              35.8. Credits

        36. TLS-SNI Feature

              36.1. Support
              36.2. Introduction
              36.3. Known Bugs
              36.4. Credits

        37. Trash Folder Feature

              37.1. Support
              37.2. Introduction
              37.3. Variables
              37.4. Functions
              37.5. neomuttrc
              37.6. See Also
              37.7. Known Bugs
              37.8. Credits

   7. Security Considerations

        1. Passwords
        2. Temporary Files
        3. Information Leaks

              3.1. Message-Id: headers
              3.2. mailto:-style Links

        4. External Applications

   8. Performance Tuning

        1. Reading and Writing Mailboxes
        2. Reading Messages from Remote Folders
        3. Searching and Limiting

   9. Reference

        1. Command-Line Options
        2. Configuration Commands
        3. Configuration Variables

              3.1. abort_noattach
              3.2. abort_nosubject
              3.3. abort_unmodified
              3.4. alias_file
              3.5. alias_format
              3.6. allow_8bit
              3.7. allow_ansi
              3.8. arrow_cursor
              3.9. ascii_chars
              3.10. askbcc
              3.11. askcc
              3.12. ask_follow_up
              3.13. ask_x_comment_to
              3.14. assumed_charset
              3.15. attach_charset
              3.16. attach_format
              3.17. attach_keyword
              3.18. attach_sep
              3.19. attach_split
              3.20. attribution
              3.21. attribution_locale
              3.22. auto_tag
              3.23. autoedit
              3.24. beep
              3.25. beep_new
              3.26. bounce
              3.27. bounce_delivered
              3.28. braille_friendly
              3.29. catchup_newsgroup
              3.30. certificate_file
              3.31. change_folder_next
              3.32. charset
              3.33. check_mbox_size
              3.34. check_new
              3.35. collapse_unread
              3.36. collapse_flagged
              3.37. compose_format
              3.38. config_charset
              3.39. confirmappend
              3.40. confirmcreate
              3.41. connect_timeout
              3.42. content_type
              3.43. copy
              3.44. crypt_autoencrypt
              3.45. crypt_autopgp
              3.46. crypt_autosign
              3.47. crypt_autosmime
              3.48. crypt_confirmhook
              3.49. crypt_opportunistic_encrypt
              3.50. crypt_replyencrypt
              3.51. crypt_replysign
              3.52. crypt_replysignencrypted
              3.53. crypt_timestamp
              3.54. crypt_use_gpgme
              3.55. crypt_use_pka
              3.56. crypt_verify_sig
              3.57. date_format
              3.58. debug_level
              3.59. debug_file
              3.60. default_hook
              3.61. delete
              3.62. delete_untag
              3.63. digest_collapse
              3.64. display_filter
              3.65. dsn_notify
              3.66. dsn_return
              3.67. duplicate_threads
              3.68. edit_headers
              3.69. editor
              3.70. empty_subject
              3.71. encode_from
              3.72. entropy_file
              3.73. envelope_from_address
              3.74. escape
              3.75. fast_reply
              3.76. fcc_attach
              3.77. fcc_clear
              3.78. flag_safe
              3.79. folder
              3.80. folder_format
              3.81. followup_to
              3.82. followup_to_poster
              3.83. force_name
              3.84. forward_attribution_intro
              3.85. forward_attribution_trailer
              3.86. forward_decode
              3.87. forward_decrypt
              3.88. forward_edit
              3.89. forward_format
              3.90. forward_quote
              3.91. forward_references
              3.92. from
              3.93. from_chars
              3.94. gecos_mask
              3.95. group_index_format
              3.96. hdrs
              3.97. header
              3.98. header_cache
              3.99. header_cache_backend
              3.100. header_cache_compress
              3.101. header_color_partial
              3.102. help
              3.103. hidden_host
              3.104. hide_limited
              3.105. hide_missing
              3.106. hide_thread_subject
              3.107. hide_top_limited
              3.108. hide_top_missing
              3.109. history
              3.110. history_file
              3.111. history_remove_dups
              3.112. honor_disposition
              3.113. honor_followup_to
              3.114. hostname
              3.115. idn_decode
              3.116. idn_encode
              3.117. ignore_list_reply_to
              3.118. show_multipart_alternative
              3.119. imap_authenticators
              3.120. imap_check_subscribed
              3.121. imap_delim_chars
              3.122. imap_headers
              3.123. imap_idle
              3.124. imap_keepalive
              3.125. imap_list_subscribed
              3.126. imap_login
              3.127. imap_pass
              3.128. imap_passive
              3.129. imap_peek
              3.130. imap_pipeline_depth
              3.131. imap_poll_timeout
              3.132. imap_servernoise
              3.133. imap_user
              3.134. implicit_autoview
              3.135. include
              3.136. include_onlyfirst
              3.137. indent_string
              3.138. index_format
              3.139. inews
              3.140. ispell
              3.141. keep_flagged
              3.142. mail_check
              3.143. mail_check_recent
              3.144. mail_check_stats
              3.145. mail_check_stats_interval
              3.146. mailcap_path
              3.147. mailcap_sanitize
              3.148. maildir_header_cache_verify
              3.149. maildir_trash
              3.150. maildir_check_cur
              3.151. mark_macro_prefix
              3.152. mark_old
              3.153. markers
              3.154. mask
              3.155. mbox
              3.156. mbox_type
              3.157. menu_context
              3.158. menu_move_off
              3.159. menu_scroll
              3.160. message_cache_clean
              3.161. message_cachedir
              3.162. message_format
              3.163. meta_key
              3.164. metoo
              3.165. mh_purge
              3.166. mh_seq_flagged
              3.167. mh_seq_replied
              3.168. mh_seq_unseen
              3.169. mime_forward
              3.170. mime_forward_decode
              3.171. mime_forward_rest
              3.172. mime_subject
              3.173. mime_type_query_command
              3.174. mime_type_query_first
              3.175. move
              3.176. narrow_tree
              3.177. net_inc
              3.178. new_mail_command
              3.179. news_cache_dir
              3.180. news_server
              3.181. newsgroups_charset
              3.182. newsrc
              3.183. nntp_authenticators
              3.184. nntp_context
              3.185. nntp_listgroup
              3.186. nntp_load_description
              3.187. nntp_user
              3.188. nntp_pass
              3.189. nntp_poll
              3.190. pager
              3.191. hidden_tags
              3.192. pager_context
              3.193. pager_format
              3.194. pager_index_lines
              3.195. pager_stop
              3.196. pgp_auto_decode
              3.197. pgp_autoinline
              3.198. pgp_check_exit
              3.199. pgp_clearsign_command
              3.200. pgp_decode_command
              3.201. pgp_decrypt_command
              3.202. pgp_decryption_okay
              3.203. pgp_default_key
              3.204. pgp_encrypt_only_command
              3.205. pgp_encrypt_sign_command
              3.206. pgp_entry_format
              3.207. pgp_export_command
              3.208. pgp_getkeys_command
              3.209. pgp_good_sign
              3.210. pgp_ignore_subkeys
              3.211. pgp_import_command
              3.212. pgp_list_pubring_command
              3.213. pgp_list_secring_command
              3.214. pgp_long_ids
              3.215. pgp_mime_auto
              3.216. pgp_replyinline
              3.217. pgp_retainable_sigs
              3.218. pgp_self_encrypt
              3.219. pgp_show_unusable
              3.220. pgp_sign_as
              3.221. pgp_sign_command
              3.222. pgp_sort_keys
              3.223. pgp_strict_enc
              3.224. pgp_timeout
              3.225. pgp_use_gpg_agent
              3.226. pgp_verify_command
              3.227. pgp_verify_key_command
              3.228. pipe_decode
              3.229. pipe_sep
              3.230. pipe_split
              3.231. pop_auth_try_all
              3.232. pop_authenticators
              3.233. pop_checkinterval
              3.234. pop_delete
              3.235. pop_host
              3.236. pop_last
              3.237. pop_pass
              3.238. pop_reconnect
              3.239. pop_user
              3.240. post_indent_string
              3.241. post_moderated
              3.242. postpone
              3.243. postponed
              3.244. postpone_encrypt
              3.245. postpone_encrypt_as
              3.246. preconnect
              3.247. print
              3.248. print_command
              3.249. print_decode
              3.250. print_split
              3.251. prompt_after
              3.252. query_command
              3.253. query_format
              3.254. quit
              3.255. quote_regex
              3.256. read_inc
              3.257. read_only
              3.258. realname
              3.259. recall
              3.260. record
              3.261. reflow_space_quotes
              3.262. reflow_text
              3.263. reflow_wrap
              3.264. reply_regex
              3.265. reply_self
              3.266. reply_to
              3.267. reply_with_xorig
              3.268. resolve
              3.269. resume_draft_files
              3.270. resume_edited_draft_files
              3.271. reverse_alias
              3.272. reverse_name
              3.273. reverse_realname
              3.274. rfc2047_parameters
              3.275. save_address
              3.276. save_empty
              3.277. save_history
              3.278. save_name
              3.279. score
              3.280. score_threshold_delete
              3.281. score_threshold_flag
              3.282. score_threshold_read
              3.283. search_context
              3.284. send_charset
              3.285. sendmail
              3.286. sendmail_wait
              3.287. shell
              3.288. save_unsubscribed
              3.289. show_new_news
              3.290. show_only_unread
              3.291. sidebar_delim_chars
              3.292. sidebar_divider_char
              3.293. sidebar_folder_indent
              3.294. sidebar_format
              3.295. sidebar_indent_string
              3.296. sidebar_new_mail_only
              3.297. sidebar_next_new_wrap
              3.298. sidebar_on_right
              3.299. sidebar_short_path
              3.300. sidebar_sort_method
              3.301. sidebar_component_depth
              3.302. sidebar_visible
              3.303. sidebar_width
              3.304. sig_dashes
              3.305. sig_on_top
              3.306. signature
              3.307. simple_search
              3.308. skip_quoted_offset
              3.309. sleep_time
              3.310. smart_wrap
              3.311. smileys
              3.312. smime_ask_cert_label
              3.313. smime_ca_location
              3.314. smime_certificates
              3.315. smime_decrypt_command
              3.316. smime_decrypt_use_default_key
              3.317. smime_default_key
              3.318. smime_encrypt_command
              3.319. smime_encrypt_with
              3.320. smime_get_cert_command
              3.321. smime_get_cert_email_command
              3.322. smime_get_signer_cert_command
              3.323. smime_import_cert_command
              3.324. smime_is_default
              3.325. smime_keys
              3.326. smime_pk7out_command
              3.327. smime_self_encrypt
              3.328. smime_sign_as
              3.329. smime_sign_command
              3.330. smime_sign_digest_alg
              3.331. smime_timeout
              3.332. smime_verify_command
              3.333. smime_verify_opaque_command
              3.334. smtp_authenticators
              3.335. smtp_pass
              3.336. smtp_url
              3.337. sort
              3.338. sort_alias
              3.339. sort_aux
              3.340. sort_browser
              3.341. sort_re
              3.342. spam_separator
              3.343. spoolfile
              3.344. ssl_client_cert
              3.345. ssl_force_tls
              3.346. ssl_starttls
              3.347. ssl_use_sslv2
              3.348. ssl_use_sslv3
              3.349. ssl_use_tlsv1
              3.350. ssl_use_tlsv1_1
              3.351. ssl_use_tlsv1_2
              3.352. ssl_usesystemcerts
              3.353. ssl_verify_dates
              3.354. ssl_verify_host
              3.355. ssl_verify_partial_chains
              3.356. ssl_ciphers
              3.357. status_chars
              3.358. status_format
              3.359. status_on_top
              3.360. strict_threads
              3.361. suspend
              3.362. text_flowed
              3.363. thorough_search
              3.364. thread_received
              3.365. tilde
              3.366. time_inc
              3.367. timeout
              3.368. tmpdir
              3.369. to_chars
              3.370. flag_chars
              3.371. trash
              3.372. ts_icon_format
              3.373. ts_enabled
              3.374. ts_status_format
              3.375. tunnel
              3.376. uncollapse_jump
              3.377. uncollapse_new
              3.378. use_8bitmime
              3.379. use_domain
              3.380. use_envelope_from
              3.381. use_from
              3.382. use_ipv6
              3.383. user_agent
              3.384. visual
              3.385. wait_key
              3.386. weed
              3.387. wrap
              3.388. wrap_headers
              3.389. wrap_search
              3.390. write_bcc
              3.391. write_inc
              3.392. x_comment_to
              3.393. collapse_all

        4. Functions

              4.1. Generic Menu
              4.2. Index Menu
              4.3. Pager Menu
              4.4. Alias Menu
              4.5. Query Menu
              4.6. Attachment Menu
              4.7. Compose Menu
              4.8. Postpone Menu
              4.9. Browser Menu
              4.10. Pgp Menu
              4.11. Editor Menu

   10. Miscellany

        1. Acknowledgements
        2. About This Document

   List of Tables

   1.1. Typographical conventions for special terms
   2.1. sidebar_format
   2.2. sidebar_format
   2.3. Sidebar Color Priority
   2.4. Config Changes
   2.5. Most common navigation keys in entry-based menus
   2.6. Most common navigation keys in page-based menus
   2.7. Most common line editor keys
   2.8. Most common message index keys
   2.9. Message status flags
   2.10. Message recipient flags
   2.11. Most common pager keys
   2.12. ANSI escape sequences
   2.13. Color sequences
   2.14. Most common thread mode keys
   2.15. Most common mail sending keys
   2.16. Most common compose menu keys
   2.17. PGP key menu flags
   3.1. NeoMutt config file search order
   3.2. NeoMutt system config file locations
   3.3. NeoMutt user config file locations
   3.4. Symbolic key names
   4.1. POSIX regular expression character classes
   4.2. Regular expression repetition operators
   4.3. GNU regular expression extensions
   4.4. Pattern modifiers
   4.5. Relative Message Number Ranges
   4.6. Message Number Shortcuts
   4.7. Absolute Message Number Ranges
   4.8. Simple search keywords
   4.9. Date units
   4.10. GMail Example Patterns
   4.11. Mailbox shortcuts
   5.1. Supported MIME types
   6.1. compose-to-sender Functions
   6.2. Not all Hooks are Required
   6.3. Potential Formatting Scheme
   6.4. Date Formatting Codes
   6.5. Example Date Tests
   6.6. Example 1
   6.7. Example 2
   6.8. encrypt-self Variables
   6.9. forgotten-attachment Variables
   6.10. Index Colors
   6.11. Limit-Current-Thread Functions
   6.12. New Mail Command Variables
   6.13. NNTP Variables
   6.14. NNTP Functions
   6.15. Custom tags Variables
   6.16. Notmuch/IMAP Functions
   6.17. Index Colors
   6.18. Notmuch Variables
   6.19. Notmuch Functions
   6.20. Progress Colors
   6.21. Quasi-Delete Functions
   6.22. Reply With X-Original-To Variables
   6.23. Sidebar Variables
   6.24. Sidebar Functions
   6.25. Sidebar Colors
   6.26. Sidebar Sort
   6.27. Skip-Quoted Variables
   6.28. Status Colors
   6.29. Trash Variables
   6.30. Trash Functions
   9.1. Command line options
   9.2. Default Generic Menu Bindings
   9.3. Default Index Menu Bindings
   9.4. Default Pager Menu Bindings
   9.5. Default Alias Menu Bindings
   9.6. Default Query Menu Bindings
   9.7. Default Attachment Menu Bindings
   9.8. Default Compose Menu Bindings
   9.9. Default Postpone Menu Bindings
   9.10. Default Browser Menu Bindings
   9.11. Default Pgp Menu Bindings
   9.12. Default Editor Menu Bindings

   List of Examples

   3.1. Multiple configuration commands per line
   3.2. Commenting configuration files
   3.3. Escaping quotes in configuration files
   3.4. Splitting long configuration commands over several lines
   3.5. Using external command's output in configuration files
   3.6. Using environment variables in configuration files
   3.7. Configuring external alias files
   3.8. Setting sort method based on mailbox name
   3.9. Header weeding
   3.10. Configuring header display order
   3.11. Defining custom headers
   3.12. Using %-expandos in save-hook
   3.13. Embedding push in folder-hook
   3.14. Configuring spam detection
   3.15. Using user-defined variables for config file readability
   3.16. Using user-defined variables for backing up other config option
          values

   3.17. Deferring user-defined variable expansion to runtime
   3.18. Type conversions using variables
   3.19. Using external filters in format strings
   4.1. Matching all addresses in address lists
   4.2. Matching restricted to aliases
   4.3. Matching any defined alias
   4.4. Using boolean operators in patterns
   4.5. Specifying a "default" hook
   4.6. Subject Munging
   5.1. mime.types
   5.2. Attachment counting
   6.1. URLs
   6.2. Managing multiple accounts

Chapter 1. Introduction

   Table of Contents

   1. NeoMutt Home Page
   2. Mailing Lists
   3. NeoMutt Online Resources
   4. Contributing to NeoMutt
   5. Typographical Conventions
   6. Copyright

   NeoMutt is a small but very powerful text-based MIME mail client.
   NeoMutt is highly configurable, and is well suited to the mail power
   user with advanced features like key bindings, keyboard macros, mail
   threading, regular expression searches and a powerful pattern matching
   language for selecting groups of messages.

1. NeoMutt Home Page

   The homepage can be found at https://www.neomutt.org/.

2. Mailing Lists

     * <neomutt-users@neomutt.org> -- help, bug reports and feature
       requests. To subscribe to this list, please send a mail to
       <neomutt-users-request@neomutt.org> with the subject "subscribe".
     * <neomutt-devel@neomutt.org> -- development mailing list. To
       subscribe to this list, please send a mail to
       <neomutt-devel-request@neomutt.org> with the subject "subscribe".

3. NeoMutt Online Resources

   Issue Tracking System
          Bugs may be reported on the devel mailing list, or on GitHub:
          https://github.com/neomutt/neomutt/issues

   IRC
          For the IRC user community, visit channel #neomutt on
          irc.freenode.net.

4. Contributing to NeoMutt

   There are various ways to contribute to the NeoMutt project.

   Especially for new users it may be helpful to meet other new and
   experienced users to chat about NeoMutt, talk about problems and share
   tricks.

   Since translations of NeoMutt into other languages are highly
   appreciated, the NeoMutt developers always look for skilled translators
   that help improve and continue to maintain stale translations.

   For contributing code patches for new features and bug fixes, please
   refer to the developer pages at https://www.neomutt.org/dev.html for
   more details.

5. Typographical Conventions

   This section lists typographical conventions followed throughout this
   manual. See table Table 1.1, "Typographical conventions for special
   terms"for typographical conventions for special terms.

   Table 1.1. Typographical conventions for special terms
        Item                   Refers to...
   printf(3)      UNIX manual pages, execute man 3 printf
   <PageUp>       named keys
   <create-alias> named NeoMutt function
   ^G             Control+G key combination
   $mail_check    NeoMutt configuration option
   $HOME          environment variable

   Examples are presented as:
neomutt -v

   Within command synopsis, curly brackets ( "{}") denote a set of options
   of which one is mandatory, square brackets ( "[]") denote optional
   arguments, three dots denote that the argument may be repeated
   arbitrary times.

6. Copyright

   NeoMutt is Copyright (c) 1996-2016 Michael R. Elkins <me@neomutt.org>
   and others.

   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2 of the License, or (at your
   option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   General Public License for more details.

   You should have received a copy of the GNU General Public License along
   with this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Chapter 2. Getting Started

   Table of Contents

   1. Core Concepts
   2. Screens and Menus

        2.1. Index
        2.2. Pager
        2.3. File Browser
        2.4. Sidebar
        2.5. Help
        2.6. Compose Menu
        2.7. Alias Menu
        2.8. Attachment Menu

   3. Moving Around in Menus
   4. Editing Input Fields

        4.1. Introduction
        4.2. History

   5. Reading Mail

        5.1. The Message Index
        5.2. The Pager
        5.3. Threaded Mode
        5.4. Miscellaneous Functions

   6. Sending Mail

        6.1. Introduction
        6.2. Editing the Message Header
        6.3. Sending Cryptographically Signed/Encrypted Messages
        6.4. Sending Format=Flowed Messages

   7. Forwarding and Bouncing Mail
   8. Postponing Mail

   This section is intended as a brief overview of how to use NeoMutt.
   There are many other features which are described elsewhere in the
   manual. There is even more information available in the NeoMutt FAQ and
   various web pages. See the NeoMutt homepage for more details.

   The keybindings described in this section are the defaults as
   distributed. Your local system administrator may have altered the
   defaults for your site. You can always type "?"in any menu to display
   the current bindings.

   The first thing you need to do is invoke NeoMutt, simply by typing
   neomutt at the command line. There are various command-line options,
   see either the NeoMutt man page or the reference.

1. Core Concepts

   NeoMutt is a text-based application which interacts with users through
   different menus which are mostly line-/entry-based or page-based. A
   line-based menu is the so-called "index" menu (listing all messages of
   the currently opened folder) or the "alias" menu (allowing you to
   select recipients from a list). Examples for page-based menus are the
   "pager"(showing one message at a time) or the "help" menu listing all
   available key bindings.

   The user interface consists of a context sensitive help line at the
   top, the menu's contents followed by a context sensitive status line
   and finally the command line. The command line is used to display
   informational and error messages as well as for prompts and for
   entering interactive commands.

   NeoMutt is configured through variables which, if the user wants to
   permanently use a non-default value, are written to configuration
   files. NeoMutt supports a rich config file syntax to make even complex
   configuration files readable and commentable.

   Because NeoMutt allows for customizing almost all key bindings, there
   are so-called "functions" which can be executed manually (using the
   command line) or in macros. Macros allow the user to bind a sequence of
   commands to a single key or a short key sequence instead of repeating a
   sequence of actions over and over.

   Many commands (such as saving or copying a message to another folder)
   can be applied to a single message or a set of messages (so-called
   "tagged" messages). To help selecting messages, NeoMutt provides a rich
   set of message patterns (such as recipients, sender, body contents,
   date sent/received, etc.) which can be combined into complex
   expressions using the boolean and and or operations as well as
   negating. These patterns can also be used to (for example) search for
   messages or to limit the index to show only matching messages.

   NeoMutt supports a "hook" concept which allows the user to execute
   arbitrary configuration commands and functions in certain situations
   such as entering a folder, starting a new message or replying to an
   existing one. These hooks can be used to highly customize NeoMutt's
   behavior including managing multiple identities, customizing the
   display for a folder or even implementing auto-archiving based on a
   per-folder basis and much more.

   Besides an interactive mode, NeoMutt can also be used as a command-line
   tool only send messages. It also supports a mailx(1)-compatible
   interface, see Table 9.1, "Command line options"for a complete list of
   command-line options.

2. Screens and Menus

2.1. Index

   The index is the screen that you usually see first when you start
   NeoMutt. It gives an overview over your emails in the currently opened
   mailbox. By default, this is your system mailbox. The information you
   see in the index is a list of emails, each with its number on the left,
   its flags (new email, important email, email that has been forwarded or
   replied to, tagged email, ...), the date when email was sent, its
   sender, the email size, and the subject. Additionally, the index also
   shows thread hierarchies: when you reply to an email, and the other
   person replies back, you can see the other person's email in a
   "sub-tree" below. This is especially useful for personal email between
   a group of people or when you've subscribed to mailing lists.

2.2. Pager

   The pager is responsible for showing the email content. On the top of
   the pager you have an overview over the most important email headers
   like the sender, the recipient, the subject, and much more information.
   How much information you actually see depends on your configuration,
   which we'll describe below.

   Below the headers, you see the email body which usually contains the
   message. If the email contains any attachments, you will see more
   information about them below the email body, or, if the attachments are
   text files, you can view them directly in the pager.

   To give the user a good overview, it is possible to configure NeoMutt
   to show different things in the pager with different colors. Virtually
   everything that can be described with a regular expression can be
   colored, e.g. URLs, email addresses or smileys.

2.3. File Browser

   The file browser is the interface to the local or remote file system.
   When selecting a mailbox to open, the browser allows custom sorting of
   items, limiting the items shown by a regular expression and a freely
   adjustable format of what to display in which way. It also allows for
   easy navigation through the file system when selecting file(s) to
   attach to a message, select multiple files to attach and many more.

2.4. Sidebar

   The Sidebar shows a list of all your mailboxes. The list can be turned
   on and off, it can be themed and the list style can be configured.

   This part of the manual is suitable for beginners. If you already know
   NeoMutt you could skip ahead to the main Sidebar guide. If you just
   want to get started, you could use the sample Sidebar neomuttrc.

   To check if NeoMutt supports "Sidebar", look for the string +sidebar in
   the neomutt version.
neomutt -v

   Let's turn on the Sidebar:
set sidebar_visible
set sidebar_format = "%B%?F? [%F]?%* %?N?%N/?%S"
set mail_check_stats

   You will see something like this. A list of mailboxes on the left. A
   list of emails, from the selected mailbox, on the right.
Fruit [1]     3/8|  1    + Jan 24  Rhys Lee         (192)  Yew
Animals [1]   2/6|  2    + Feb 11  Grace Hall       (167)  Ilama
Cars            4|  3      Feb 23  Aimee Scott      (450)  Nectarine
Seas          1/7|  4    ! Feb 28  Summer Jackson   (264)  Lemon
                 |  5      Mar 07  Callum Harrison  (464)  Raspberry
                 |  6 N  + Mar 24  Samuel Harris    (353)  Tangerine
                 |  7 N  + Sep 05  Sofia Graham     (335)  Cherry
                 |  8 N    Sep 16  Ewan Brown       (105)  Ugli
                 |
                 |

   This user has four mailboxes: "Fruit", "Cars", "Animals" and "Seas".

   The current, open, mailbox is "Fruit". We can also see information
   about the other mailboxes. For example: The "Animals" mailbox contains,
   1 flagged email, 2 new emails out of a total of 6 emails.

2.4.1. Navigation

   The Sidebar adds some new functions to NeoMutt.

   The user pressed the "c" key to <change-folder>to the "Animals"
   mailbox. The Sidebar automatically updated the indicator to match.
Fruit [1]     3/8|  1      Jan 03  Tia Gibson       (362)  Caiman
Animals [1]   2/6|  2    + Jan 22  Rhys Lee         ( 48)  Dolphin
Cars            4|  3    ! Aug 16  Ewan Brown       (333)  Hummingbird
Seas          1/7|  4      Sep 25  Grace Hall       ( 27)  Capybara
                 |  5 N  + Nov 12  Evelyn Rogers    (453)  Tapir
                 |  6 N  + Nov 16  Callum Harrison  (498)  Hedgehog
                 |
                 |
                 |
                 |

   Let's map some functions:
bind index,pager \CP sidebar-prev       # Ctrl-Shift-P - Previous Mailbox
bind index,pager \CN sidebar-next       # Ctrl-Shift-N - Next Mailbox
bind index,pager \CO sidebar-open       # Ctrl-Shift-O - Open Highlighted Mailbo
x

   Press "Ctrl-Shift-N"(Next mailbox) twice will move the Sidebar
   highlight to down to the "Seas" mailbox.
Fruit [1]     3/8|  1      Jan 03  Tia Gibson       (362)  Caiman
Animals [1]   2/6|  2    + Jan 22  Rhys Lee         ( 48)  Dolphin
Cars            4|  3    ! Aug 16  Ewan Brown       (333)  Hummingbird
Seas          1/7|  4      Sep 25  Grace Hall       ( 27)  Capybara
                 |  5 N  + Nov 12  Evelyn Rogers    (453)  Tapir
                 |  6 N  + Nov 16  Callum Harrison  (498)  Hedgehog
                 |
                 |
                 |
                 |

Note

   Functions <sidebar-next>and <sidebar-prev>move the Sidebar highlight.
   They do not change the open mailbox.

   Press "Ctrl-Shift-O"( <sidebar-open>) to open the highlighted mailbox.
Fruit [1]     3/8|  1    ! Mar 07  Finley Jones     (139)  Molucca Sea
Animals [1]   2/6|  2    + Mar 24  Summer Jackson   ( 25)  Arafura Sea
Cars            4|  3    + Feb 28  Imogen Baker     (193)  Pechora Sea
Seas          1/7|  4 N  + Feb 23  Isla Hussain     (348)  Balearic Sea
                 |
                 |
                 |
                 |
                 |
                 |

2.4.2. Features

   The Sidebar shows a list of mailboxes in a panel.

   Everything about the Sidebar can be configured.

   State of the Sidebar
     * Visibility
     * Width

   Which mailboxes are displayed
     * Display all
     * Limit to mailboxes with new mail
     * Whitelist mailboxes to display always

   The order in which mailboxes are displayed
     * Unsorted (order of mailboxes commands)
     * Sorted alphabetically
     * Sorted by number of new mails

   Color
     * Sidebar indicators and divider
     * Mailboxes depending on their type
     * Mailboxes depending on their contents

   Key bindings
     * Hide/Unhide the Sidebar
     * Select previous/next mailbox
     * Select previous/next mailbox with new mail
     * Page up/down through a list of mailboxes

   Misc
     * Formatting string for mailbox
     * Wraparound searching
     * Flexible mailbox abbreviations
     * Support for Unicode mailbox names (UTF-8)

2.4.3. Display

   Everything about the Sidebar can be configured.

   For a quick reference:
     * Sidebar variables to set
     * Sidebar colors to apply
     * Sidebar sort methods

2.4.3.1. Sidebar Basics

   The most important variable is $sidebar_visible. You can set this in
   your "neomuttrc", or bind a key to the function
   <sidebar-toggle-visible>.
set sidebar_visible                         # Make the Sidebar visible by defaul
t
bind index,pager B sidebar-toggle-visible   # Use 'B' to switch the Sidebar on a
nd off

   Next, decide how wide you want the Sidebar to be. 25 characters might
   be enough for the mailbox name and some numbers. Remember, you can
   hide/show the Sidebar at the press of button.

   Finally, you might want to change the divider character. By default,
   Sidebar draws an ASCII line between it and the Index panel If your
   terminal supports it, you can use a Unicode line-drawing character.
set sidebar_width = 25                  # Plenty of space
set sidebar_divider_char = '|'          # Pretty line-drawing character

2.4.3.2. Sidebar Format String

   $sidebar_format allows you to customize the Sidebar display. For an
   introduction, read format strings including the section about
   conditionals.

   The default value is: %B%* %n

   A more detailed value is: %B%?F? [%F]?%* %?N?%N/?%S

   Which breaks down as:
     * %B- Mailbox name
     * %?F? [%F]?- If flagged emails [%F], otherwise nothing
     * %*- Pad with spaces
     * %?N?%N/?- If new emails %N/, otherwise nothing
     * %S- Total number of emails

   Table 2.1. sidebar_format
   Format Notes Description
   %B   Name of the mailbox
   %S * /- Size of mailbox (total number of messages)
   %F * /- Number of Flagged messages in the mailbox
   %N * /- Number of New messages in the mailbox
   %n * If there's new mail, display "N", otherwise nothing
   %!   "!": one flagged message; "!!": two flagged messages; "n!": n
   flagged messages (for n > 2). Otherwise prints nothing.
   %d * /= Number of deleted messages
   %L * /= Number of messages after limiting
   %t * /= Number of tagged messages
   %>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

   * = Can be optionally printed if nonzero

   /- = To use this expandos, you must first:
set mail_check_stats

   /= = Only applicable to the current folder

   Here are some examples. They show the number of (F)lagged, (N)ew and
   (S)ize.

   Table 2.2. sidebar_format
             Format          Example
   %B%?F? [%F]?%* %?N?%N/?%S
mailbox [F]            N/S

   %B%* %F:%N:%S
mailbox              F:N:S

   %B %?N?(%N)?%* %S
mailbox (N)              S

   %B%* ?F?%F/?%N
mailbox                F/S

2.4.3.3. Abbreviating Mailbox Names

   $sidebar_delim_chars tells Sidebar how to split up mailbox paths. For
   local directories use "/"; for IMAP folders use "."

2.4.3.3.1. Example 1

   This example works well if your mailboxes have unique names after the
   last separator.

   Add some mailboxes of different depths.
set folder="~/mail"
mailboxes =fruit/apple          =fruit/banana          =fruit/cherry
mailboxes =water/sea/sicily     =water/sea/archipelago =water/sea/sibuyan
mailboxes =water/ocean/atlantic =water/ocean/pacific   =water/ocean/arctic

   Shorten the names:
set sidebar_short_path                  # Shorten mailbox names (truncate all su
bdirs)
set sidebar_component_depth=1           # Shorten mailbox names (truncate 1 subd
irs)
set sidebar_delim_chars="/"             # Delete everything up to the last or Nt
h / character

   The screenshot below shows what the Sidebar would look like before and
   after shortening using sidebar_short_path.
|fruit/apple                            |apple
|fruit/banana                           |banana
|fruit/cherry                           |cherry
|water/sea/sicily                       |sicily
|water/sea/archipelago                  |archipelago
|water/sea/sibuyan                      |sibuyan
|water/ocean/atlantic                   |atlantic
|water/ocean/pacific                    |pacific
|water/ocean/arctic                     |arctic

   The screenshot below shows what the Sidebar would look like before and
   after shortening using sidebar_component_depth=1.
|fruit/apple                            |apple
|fruit/banana                           |banana
|fruit/cherry                           |cherry
|water/sea/sicily                       |sea/sicily
|water/sea/archipelago                  |sea/archipelago
|water/sea/sibuyan                      |sea/sibuyan
|water/ocean/atlantic                   |ocean/atlantic
|water/ocean/pacific                    |ocean/pacific
|water/ocean/arctic                     |ocean/arctic

2.4.3.3.2. Example 2

   This example works well if you have lots of mailboxes which are
   arranged in a tree.

   Add some mailboxes of different depths.
set folder="~/mail"
mailboxes =fruit
mailboxes =fruit/apple =fruit/banana =fruit/cherry
mailboxes =water
mailboxes =water/sea
mailboxes =water/sea/sicily =water/sea/archipelago =water/sea/sibuyan
mailboxes =water/ocean
mailboxes =water/ocean/atlantic =water/ocean/pacific =water/ocean/arctic

   Shorten the names:
set sidebar_short_path                  # Shorten mailbox names
set sidebar_delim_chars="/"             # Delete everything up to the last / cha
racter
set sidebar_folder_indent               # Indent folders whose names we've short
ened
set sidebar_indent_string="  "          # Indent with two spaces

   The screenshot below shows what the Sidebar would look like before and
   after shortening.
|fruit                                  |fruit
|fruit/apple                            |  apple
|fruit/banana                           |  banana
|fruit/cherry                           |  cherry
|water                                  |water
|water/sea                              |  sea
|water/sea/sicily                       |    sicily
|water/sea/archipelago                  |    archipelago
|water/sea/sibuyan                      |    sibuyan
|water/ocean                            |  ocean
|water/ocean/atlantic                   |    atlantic
|water/ocean/pacific                    |    pacific
|water/ocean/arctic                     |    arctic

   Sometimes, it will be necessary to add mailboxes, that you don't use,
   to fill in part of the tree. This will trade vertical space for
   horizontal space (but it looks good).

2.4.3.4. Limiting the Number of Mailboxes

   If you have a lot of mailboxes, sometimes it can be useful to hide the
   ones you aren't using. $sidebar_new_mail_only tells Sidebar to only
   show mailboxes that contain new, or flagged, email.

   If you want some mailboxes to be always visible, then use the
   sidebar_whitelist command. It takes a list of mailboxes as parameters.
set sidebar_new_mail_only               # Only mailboxes with new/flagged email
sidebar_whitelist fruit fruit/apple     # Always display these two mailboxes

2.4.4. Colors

   Here is a sample color scheme:
color sidebar_indicator default color17         # Dark blue background
color sidebar_highlight white   color238        # Grey background
color sidebar_spoolfile yellow  default         # Yellow
color sidebar_new       green   default         # Green
color sidebar_ordinary  default default         # Default colors
color sidebar_flagged   red     default         # Red
color sidebar_divider   color8  default
          # Dark grey

   There is a priority order when coloring Sidebar mailboxes. e.g. If a
   mailbox has new mail it will have the sidebar_new color, even if it
   also contains flagged mails.

   Table 2.3. Sidebar Color Priority
   Priority       Color                          Description
   Highest  sidebar_indicator Mailbox is open
            sidebar_highlight Mailbox is highlighted
            sidebar_spoolfile Mailbox is the spoolfile (receives incoming mail)
            sidebar_new       Mailbox contains new mail
            sidebar_flagged   Mailbox contains flagged mail
   Lowest   sidebar_ordinary  Mailbox does not match above

2.4.5. Config Changes

   If you haven't used Sidebar before, you can ignore this section.

   Some of the Sidebar config has been changed to make its meaning
   clearer. These changes have been made since the previous Sidebar
   release: 2015-11-11.

   Table 2.4. Config Changes
          Old Name              New Name
   $sidebar_delim        $sidebar_divider_char
   $sidebar_folderindent $sidebar_folder_indent
   $sidebar_indentstr    $sidebar_indent_string
   $sidebar_newmail_only $sidebar_new_mail_only
   $sidebar_shortpath    $sidebar_short_path
   $sidebar_sort         $sidebar_sort_method
   <sidebar-scroll-down> <sidebar-page-down>
   <sidebar-scroll-up>   <sidebar-page-up>

2.5. Help

   The help screen is meant to offer a quick help to the user. It lists
   the current configuration of key bindings and their associated commands
   including a short description, and currently unbound functions that
   still need to be associated with a key binding (or alternatively, they
   can be called via the NeoMutt command prompt).

2.6. Compose Menu

   The compose menu features a split screen containing the information
   which really matter before actually sending a message by mail: who gets
   the message as what (recipients and who gets what kind of copy).
   Additionally, users may set security options like deciding whether to
   sign, encrypt or sign and encrypt a message with/for what keys. Also,
   it's used to attach messages, to re-edit any attachment including the
   message itself.

2.7. Alias Menu

   The alias menu is used to help users finding the recipients of
   messages. For users who need to contact many people, there's no need to
   remember addresses or names completely because it allows for searching,
   too. The alias mechanism and thus the alias menu also features grouping
   several addresses by a shorter nickname, the actual alias, so that
   users don't have to select each single recipient manually.

2.8. Attachment Menu

   As will be later discussed in detail, NeoMutt features a good and
   stable MIME implementation, that is, it supports sending and receiving
   messages of arbitrary MIME types. The attachment menu displays a
   message's structure in detail: what content parts are attached to which
   parent part (which gives a true tree structure), which type is of what
   type and what size. Single parts may saved, deleted or modified to
   offer great and easy access to message's internals.

3. Moving Around in Menus

   The most important navigation keys common to line- or entry-based menus
   are shown in Table 2.5, "Most common navigation keys in entry-based
   menus"and in Table 2.6, "Most common navigation keys in page-based
   menus"for page-based menus.

   Table 2.5. Most common navigation keys in entry-based menus
        Key          Function                    Description
   j or <Down>   <next-entry>     move to the next entry
   k or <Up>     <previous-entry> move to the previous entry
   z or <PageDn> <page-down>      go to the next page
   Z or <PageUp> <page-up>        go to the previous page
   = or <Home>   <first-entry>    jump to the first entry
   * or <End>    <last-entry>     jump to the last entry
   q             <quit>           exit the current menu
   ?             <help>           list all keybindings for the current menu

   Table 2.6. Most common navigation keys in page-based menus
            Key               Function         Description
   J or <Return>          <next-line>     scroll down one line
   <Backspace>            <previous-line> scroll up one line
   K, <Space> or <PageDn> <next-page>     move to the next page
   - or <PageUp>          <previous-page> move the previous page
   <Home>                 <top>           move to the top
   <End>                  <bottom>        move to the bottom

4. Editing Input Fields

4.1. Introduction

   NeoMutt has a built-in line editor for inputting text, e.g. email
   addresses or filenames. The keys used to manipulate text input are very
   similar to those of Emacs. See Table 2.7, "Most common line editor
   keys"for a full reference of available functions, their default key
   bindings, and short descriptions.

   Table 2.7. Most common line editor keys
        Key            Function                 Description
   ^A or <Home>   <bol>             move to the start of the line
   ^B or <Left>   <backward-char>   move back one char
   Esc B          <backward-word>   move back one word
   ^D or <Delete> <delete-char>     delete the char under the cursor
   ^E or <End>    <eol>             move to the end of the line
   ^F or <Right>  <forward-char>    move forward one char
   Esc F          <forward-word>    move forward one word
   <Tab>          <complete>        complete filename, alias, or label
   ^T             <complete-query>  complete address with query
   ^K             <kill-eol>        delete to the end of the line
   Esc d          <kill-eow>        delete to the end of the word
   ^W             <kill-word>       kill the word in front of the cursor
   ^U             <kill-line>       delete entire line
   ^V             <quote-char>      quote the next typed key
   <Up>           <history-up>      recall previous string from history
   <Down>         <history-down>    recall next string from history
   ^R             <history-search>  use current input to search history
   <BackSpace>    <backspace>       kill the char in front of the cursor
   Esc u          <upcase-word>     convert word to upper case
   Esc l          <downcase-word>   convert word to lower case
   Esc c          <capitalize-word> capitalize the word
   ^G             n/a               abort
   <Return>       n/a               finish editing

   You can remap the editor functions using the bind command. For example,
   to make the <Delete> key delete the character in front of the cursor
   rather than under, you could use:
bind editor <delete> backspace

4.2. History

   NeoMutt maintains a history for the built-in editor. The number of
   items is controlled by the $history variable and can be made persistent
   using an external file specified using $history_file and $save_history.
   You may cycle through them at an editor prompt by using the
   <history-up>and/or <history-down>commands. NeoMutt will remember the
   currently entered text as you cycle through history, and will wrap
   around to the initial entry line.

   NeoMutt maintains several distinct history lists, one for each of the
   following categories:
     * .neomuttrc commands
     * addresses and aliases
     * shell commands
     * filenames
     * patterns
     * everything else

   NeoMutt automatically filters out consecutively repeated items from the
   history. If $history_remove_dups is set, all repeated items are removed
   from the history. It also mimics the behavior of some shells by
   ignoring items starting with a space. The latter feature can be useful
   in macros to not clobber the history's valuable entries with unwanted
   entries.

5. Reading Mail

   Similar to many other mail clients, there are two modes in which mail
   is read in NeoMutt. The first is a list of messages in the mailbox,
   which is called the "index" menu in NeoMutt. The second mode is the
   display of the message contents. This is called the "pager."

   The next few sections describe the functions provided in each of these
   modes.

5.1. The Message Index

   Common keys used to navigate through and manage messages in the index
   are shown in Table 2.8, "Most common message index keys". How messages
   are presented in the index menu can be customized using the
   $index_format variable.

   Table 2.8. Most common message index keys
     Key                    Description
   c        change to a different mailbox
   Esc c    change to a folder in read-only mode
   C        copy the current message to another mailbox
   Esc C    decode a message and copy it to a folder
   Esc s    decode a message and save it to a folder
   D        delete messages matching a pattern
   d        delete the current message
   F        mark as important
   l        show messages matching a pattern
   N        mark message as new
   o        change the current sort method
   O        reverse sort the mailbox
   q        save changes and exit
   s        save-message
   T        tag messages matching a pattern
   t        toggle the tag on a message
   Esc t    toggle tag on entire message thread
   U        undelete messages matching a pattern
   u        undelete-message
   v        view-attachments
   x        abort changes and exit
   <Return> display-message
   <Tab>    jump to the next new or unread message
   @        show the author's full e-mail address
   $        save changes to mailbox
   /        search
   Esc /    search-reverse
   ^L       clear and redraw the screen
   ^T       untag messages matching a pattern

   In addition to who sent the message and the subject, a short summary of
   the disposition of each message is printed beside the message number.
   Zero or more of the "flags" in Table 2.9, "Message status flags"may
   appear, some of which can be turned on or off using these functions:
   <set-flag>and <clear-flag>bound by default to "w" and "W" respectively.

   Furthermore, the flags in Table 2.10, "Message recipient flags"reflect
   who the message is addressed to. They can be customized with the
   $to_chars variable.

   Table 2.9. Message status flags
   Flag                          Description
   D    message is deleted (is marked for deletion)
   d    message has attachments marked for deletion
   K    contains a PGP public key
   N    message is new
   O    message is old
   P    message is PGP encrypted
   r    message has been replied to
   S    message is signed, and the signature is successfully verified
   s    message is signed
   !    message is flagged
   *    message is tagged
   n    thread contains new messages (only if collapsed)
   o    thread contains old messages (only if collapsed)

   Table 2.10. Message recipient flags
   Flag                    Description
   +    message is to you and you only
   T    message is to you, but also to or CC'ed to others
   C    message is CC'ed to you
   F    message is from you
   L    message is sent to a subscribed mailing list

5.2. The Pager

   By default, NeoMutt uses its built-in pager to display the contents of
   messages (an external pager such as less(1)can be configured, see
   $pager variable). The pager is very similar to the Unix program
   less(1)though not nearly as featureful.

   Table 2.11. Most common pager keys
   Key Description
   <Return> go down one line
   <Space> display the next page (or next message if at the end of a
   message)
   - go back to the previous page
   n search for next match
   S skip beyond quoted text
   T toggle display of quoted text
   ? show keybindings
   / regular expression search
   Esc / backward regular expression search
   \ toggle highlighting of search matches
   ^ jump to the top of the message

   In addition to key bindings in Table 2.11, "Most common pager keys",
   many of the functions from the index menu are also available in the
   pager, such as <delete-message>or <copy-message>(this is one advantage
   over using an external pager to view messages).

   Also, the internal pager supports a couple other advanced features. For
   one, it will accept and translate the "standard" nroff sequences for
   bold and underline. These sequences are a series of either the letter,
   backspace ( "^H"), the letter again for bold or the letter, backspace,
   "_" for denoting underline. NeoMutt will attempt to display these in
   bold and underline respectively if your terminal supports them. If not,
   you can use the bold and underline color objects to specify a color or
   mono attribute for them.

   Additionally, the internal pager supports the ANSI escape sequences for
   character attributes. NeoMutt translates them into the correct color
   and character settings. The sequences NeoMutt supports are:
\e[
        Ps;
        Ps;..
        Ps;m

   where Ps can be one of the codes shown in Table 2.12, "ANSI escape
   sequences".

   Table 2.12. ANSI escape sequences
   Escape code Description
   0 All attributes off
   1 Bold on
   4 Underline on
   5 Blink on
   7 Reverse video on
   3 <color> Foreground color is <color>(see Table 2.13, "Color
   sequences")
   4 <color> Background color is <color>(see Table 2.13, "Color
   sequences")

   Table 2.13. Color sequences
   Color code  Color
   0          Black
   1          Red
   2          Green
   3          Yellow
   4          Blue
   5          Magenta
   6          Cyan
   7          White

   NeoMutt uses these attributes for handling text/enriched messages, and
   they can also be used by an external autoview script for highlighting
   purposes.

Note

   If you change the colors for your display, for example by changing the
   color associated with color2 for your xterm, then that color will be
   used instead of green.

Note

   Note that the search commands in the pager take regular expressions,
   which are not quite the same as the more complex patterns used by the
   search command in the index. This is because patterns are used to
   select messages by criteria whereas the pager already displays a
   selected message.

5.3. Threaded Mode

   So-called "threads" provide a hierarchy of messages where replies are
   linked to their parent message(s). This organizational form is
   extremely useful in mailing lists where different parts of the
   discussion diverge. NeoMutt displays threads as a tree structure.

   In NeoMutt, when a mailbox is sorted by threads, there are a few
   additional functions available in the index and pager modes as shown in
   Table 2.14, "Most common thread mode keys".

   Table 2.14. Most common thread mode keys
   Key Function Description
   ^D <delete-thread> delete all messages in the current thread
   ^U <undelete-thread> undelete all messages in the current thread
   ^N <next-thread> jump to the start of the next thread
   ^P <previous-thread> jump to the start of the previous thread
   ^R <read-thread> mark the current thread as read
   Esc d <delete-subthread> delete all messages in the current subthread
   Esc u <undelete-subthread> undelete all messages in the current
   subthread
   Esc n <next-subthread> jump to the start of the next subthread
   Esc p <previous-subthread> jump to the start of the previous subthread
   Esc r <read-subthread> mark the current subthread as read
   Esc t <tag-thread> toggle the tag on the current thread
   Esc v <collapse-thread> toggle collapse for the current thread
   Esc V <collapse-all> toggle collapse for all threads
   P <parent-message> jump to parent message in thread

   Collapsing a thread displays only the first message in the thread and
   hides the others. This is useful when threads contain so many messages
   that you can only see a handful of threads on the screen. See %M in
   $index_format. For example, you could use "%?M?(#%03M)&(%4l)?"in
   $index_format to optionally display the number of hidden messages if
   the thread is collapsed. The %?<char>?<if-part>&<else-part>?syntax is
   explained in detail in format string conditionals.

   Technically, every reply should contain a list of its parent messages
   in the thread tree, but not all do. In these cases, NeoMutt groups them
   by subject which can be controlled using the $strict_threads variable.

5.4. Miscellaneous Functions

   In addition, the index and pager menus have these interesting
   functions:

   <create-alias> (default: a)
          Creates a new alias based upon the current message (or prompts
          for a new one). Once editing is complete, an alias command is
          added to the file specified by the $alias_file variable for
          future use

Note

          NeoMutt does not read the $alias_file upon startup so you must
          explicitly source the file.

   <check-traditional-pgp> (default: Esc P)
          This function will search the current message for content signed
          or encrypted with PGP the "traditional" way, that is, without
          proper MIME tagging. Technically, this function will temporarily
          change the MIME content types of the body parts containing PGP
          data; this is similar to the <edit-type> function's effect.

   <edit-raw-message>
          This command (available in the index and pager) allows you to
          edit the raw current message as it's present in the mail folder.
          After you have finished editing, the changed message will be
          appended to the current folder, and the original message will be
          marked for deletion; if the message is unchanged it won't be
          replaced.

          <edit> is a synonym of this for backwards compatibility.

          See also <edit-or-view-raw-message> , <view-raw-message> .

   <edit>
          Alias of <edit-raw-message> for backwards compatibility.

   <edit-or-view-raw-message> (default: e)
          This command (available in the index and pager) is the same as
          <edit-raw-message> if the mailbox is writable, otherwise it the
          same as <view-raw-message> .

   <edit-type> (default: ^E on the attachment menu, and in the pager and
          index menus; ^T on the compose menu)
          This command is used to temporarily edit an attachment's content
          type to fix, for instance, bogus character set parameters. When
          invoked from the index or from the pager, you'll have the
          opportunity to edit the top-level attachment's content type. On
          the attachment menu, you can change any attachment's content
          type. These changes are not persistent, and get lost upon
          changing folders.

          Note that this command is also available on the compose menu.
          There, it's used to fine-tune the properties of attachments you
          are going to send.

   <enter-command> (default: ":")
          This command is used to execute any command you would normally
          put in a configuration file. A common use is to check the
          settings of variables, or in conjunction with macros to change
          settings on the fly.

   <extract-keys> (default: ^K)
          This command extracts PGP public keys from the current or tagged
          message(s) and adds them to your PGP public key ring.

   <forget-passphrase> (default: ^F)
          This command wipes the passphrase(s) from memory. It is useful,
          if you misspelled the passphrase.

   <list-reply> (default: L)
          Reply to the current or tagged message(s) by extracting any
          addresses which match the regular expressions given by the lists
          or subscribecommands, but also honor any Mail-Followup-To
          header(s) if the $honor_followup_to configuration variable is
          set. In addition, the List-Post header field is examined for
          mailto:URLs specifying a mailing list address. Using this when
          replying to messages posted to mailing lists helps avoid
          duplicate copies being sent to the author of the message you are
          replying to.

   <pipe-message> (default: |)
          Asks for an external Unix command and pipes the current or
          tagged message(s) to it. The variables $pipe_decode,
          $pipe_split, $pipe_sep and $wait_key control the exact behavior
          of this function.

   <resend-message> (default: Esc e)
          NeoMutt takes the current message as a template for a new
          message. This function is best described as "recall from
          arbitrary folders". It can conveniently be used to forward MIME
          messages while preserving the original mail structure. Note that
          the amount of headers included here depends on the value of the
          $weed variable.

          This function is also available from the attachment menu. You
          can use this to easily resend a message which was included with
          a bounce message as a message/rfc822 body part.

   <shell-escape> (default: !)
          Asks for an external Unix command and executes it. The $wait_key
          can be used to control whether NeoMutt will wait for a key to be
          pressed when the command returns (presumably to let the user
          read the output of the command), based on the return status of
          the named command. If no command is given, an interactive shell
          is executed.

   <toggle-quoted> (default: T)
          The pager uses the $quote_regex variable to detect quoted text
          when displaying the body of the message. This function toggles
          the display of the quoted material in the message. It is
          particularly useful when being interested in just the response
          and there is a large amount of quoted text in the way.

   <view-raw-message>
          This command (available in the index and pager) opens the raw
          message read-only in an editor. This command does not allow
          editing the message, use <edit-raw-message> for this.

          See also <edit-raw-message> , <edit-or-view-raw-message> .

   <skip-quoted> (default: S)
          This function will go to the next line of non-quoted text which
          comes after a line of quoted text in the internal pager.

6. Sending Mail

6.1. Introduction

   The bindings shown in Table 2.15, "Most common mail sending keys"are
   available in the index and pager to start a new message.

   Table 2.15. Most common mail sending keys
    Key     Function             Description
   m     <compose>     compose a new message
   r     <reply>       reply to sender
   g     <group-reply> reply to all recipients
   L     <list-reply>  reply to mailing list address
   f     <forward>     forward message
   b     <bounce>      bounce (remail) message
   Esc k <mail-key>    mail a PGP public key to someone

   Bouncing a message sends the message as-is to the recipient you
   specify. Forwarding a message allows you to add comments or modify the
   message you are forwarding. These items are discussed in greater detail
   in the next section " Forwarding and Bouncing Mail."

   NeoMutt will then enter the compose menu and prompt you for the
   recipients to place on the "To:"header field when you hit m to start a
   new message. Next, it will ask you for the "Subject:"field for the
   message, providing a default if you are replying to or forwarding a
   message. You again have the chance to adjust recipients, subject, and
   security settings right before actually sending the message. See also
   $askcc, $askbcc, $autoedit, $bounce, $fast_reply, and $include for
   changing how and if NeoMutt asks these questions.

   When replying, NeoMutt fills these fields with proper values depending
   on the reply type. The types of replying supported are:

   Simple reply
          Reply to the author directly.

   Group reply
          Reply to the author as well to all recipients except you; this
          consults alternates .

   List reply
          Reply to all mailing list addresses found, either specified via
          configuration or auto-detected. See Section 12, "Mailing
          Lists"for details.

   After getting recipients for new messages, forwards or replies, NeoMutt
   will then automatically start your $editor on the message body. If the
   $edit_headers variable is set, the headers will be at the top of the
   message in your editor; the message body should start on a new line
   after the existing blank line at the end of headers. Any messages you
   are replying to will be added in sort order to the message, with
   appropriate $attribution, $indent_string and $post_indent_string. When
   forwarding a message, if the $mime_forward variable is unset, a copy of
   the forwarded message will be included. If you have specified a
   $signature, it will be appended to the message.

   Once you have finished editing the body of your mail message, you are
   returned to the compose menu providing the functions shown in
   Table 2.16, "Most common compose menu keys"to modify, send or postpone
   the message.

   Table 2.16. Most common compose menu keys
    Key        Function                      Description
   a     <attach-file>       attach a file
   A     <attach-message>    attach message(s) to the message
   Esc k <attach-key>        attach a PGP public key
   d     <edit-description>  edit description on attachment
   D     <detach-file>       detach a file
   t     <edit-to>           edit the To field
   Esc f <edit-from>         edit the From field
   r     <edit-reply-to>     edit the Reply-To field
   c     <edit-cc>           edit the Cc field
   b     <edit-bcc>          edit the Bcc field
   y     <send-message>      send the message
   s     <edit-subject>      edit the Subject
   S     <smime-menu>        select S/MIME options
   f     <edit-fcc>          specify an "Fcc" mailbox
   p     <pgp-menu>          select PGP options
   P     <postpone-message>  postpone this message until later
   q     <quit>              quit (abort) sending the message
   w     <write-fcc>         write the message to a folder
   i     <ispell>            check spelling (if available on your system)
   ^F    <forget-passphrase> wipe passphrase(s) from memory

   The compose menu is also used to edit the attachments for a message
   which can be either files or other messages. The
   <attach-message>function to will prompt you for a folder to attach
   messages from. You can now tag messages in that folder and they will be
   attached to the message you are sending.

Note

   Note that certain operations like composing a new mail, replying,
   forwarding, etc. are not permitted when you are in that folder. The %r
   in $status_format will change to a "A" to indicate that you are in
   attach-message mode.

6.2. Editing the Message Header

   When editing the header because of $edit_headers being set, there are a
   several pseudo headers available which will not be included in sent
   messages but trigger special NeoMutt behavior.

6.2.1. Fcc: Pseudo Header

   If you specify

   Fcc: filename

   as a header, NeoMutt will pick up filename just as if you had used the
   <edit-fcc>function in the compose menu. It can later be changed from
   the compose menu.

6.2.2. Attach: Pseudo Header

   You can also attach files to your message by specifying

   Attach: filename[ description]

   where filename is the file to attach and description is an optional
   string to use as the description of the attached file. Spaces in
   filenames have to be escaped using backslash ( "\"). The file can be
   removed as well as more added from the compose menu.

6.2.3. Pgp: Pseudo Header

   If you want to use PGP, you can specify

   Pgp:[ E| S| S <id>]

   "E" selects encryption, "S" selects signing and "S<id>"selects signing
   with the given key, setting $pgp_sign_as permanently. The selection can
   later be changed in the compose menu.

6.2.4. In-Reply-To: Header

   When replying to messages, the In-Reply-To:header contains the
   Message-Id of the message(s) you reply to. If you remove or modify its
   value, NeoMutt will not generate a References:field, which allows you
   to create a new message thread, for example to create a new message to
   a mailing list without having to enter the mailing list's address.

   If you intend to start a new thread by replying, please make really
   sure you remove the In-Reply-To:header in your editor. Otherwise,
   though you'll produce a technically valid reply, some netiquette
   guardians will be annoyed by this so-called "thread hijacking".

6.3. Sending Cryptographically Signed/Encrypted Messages

   If you have told NeoMutt to PGP or S/MIME encrypt a message, it will
   guide you through a key selection process when you try to send the
   message. NeoMutt will not ask you any questions about keys which have a
   certified user ID matching one of the message recipients' mail
   addresses. However, there may be situations in which there are several
   keys, weakly certified user ID fields, or where no matching keys can be
   found.

   In these cases, you are dropped into a menu with a list of keys from
   which you can select one. When you quit this menu, or NeoMutt can't
   find any matching keys, you are prompted for a user ID. You can, as
   usually, abort this prompt using ^G. When you do so, NeoMutt will
   return to the compose screen.

   Once you have successfully finished the key selection, the message will
   be encrypted using the selected public keys when sent out.

   To ensure you can view encrypted messages you have sent, you may wish
   to set $pgp_self_encrypt and $pgp_default_key for PGP, or
   $smime_self_encrypt and $smime_default_key for S/MIME.

   Most fields of the entries in the key selection menu (see also
   $pgp_entry_format) have obvious meanings. But some explanations on the
   capabilities, flags, and validity fields are in order.

   The flags sequence ( "%f") will expand to one of the flags in
   Table 2.17, "PGP key menu flags".

   Table 2.17. PGP key menu flags
   Flag                    Description
   R    The key has been revoked and can't be used.
   X    The key is expired and can't be used.
   d    You have marked the key as disabled.
   c    There are unknown critical self-signature packets.

   The capabilities field ( "%c") expands to a two-character sequence
   representing a key's capabilities. The first character gives the key's
   encryption capabilities: A minus sign ( "-") means that the key cannot
   be used for encryption. A dot ( ".") means that it's marked as a
   signature key in one of the user IDs, but may also be used for
   encryption. The letter "e" indicates that this key can be used for
   encryption.

   The second character indicates the key's signing capabilities. Once
   again, a "-"implies "not for signing", "."implies that the key is
   marked as an encryption key in one of the user-ids, and "s" denotes a
   key which can be used for signing.

   Finally, the validity field ( "%t") indicates how well-certified a
   user-id is. A question mark ( "?") indicates undefined validity, a
   minus character ( "-") marks an untrusted association, a space
   character means a partially trusted association, and a plus character (
   "+") indicates complete validity.

6.4. Sending Format=Flowed Messages

6.4.1. Concept

   format=flowed-style messages (or f=f for short) are text/plain messages
   that consist of paragraphs which a receiver's mail client may reformat
   to its own needs which mostly means to customize line lengths
   regardless of what the sender sent. Technically this is achieved by
   letting lines of a "flowable" paragraph end in spaces except for the
   last line.

   While for text-mode clients like NeoMutt it's the best way to assume
   only a standard 80x25 character cell terminal, it may be desired to let
   the receiver decide completely how to view a message.

6.4.2. NeoMutt Support

   NeoMutt only supports setting the required format=flowed MIME parameter
   on outgoing messages if the $text_flowed variable is set, specifically
   it does not add the trailing spaces.

   After editing the initial message text and before entering the compose
   menu, NeoMutt properly space-stuffs the message. Space-stuffing is
   required by RFC3676 defining format=flowed and means to prepend a space
   to:
     * all lines starting with a space
     * lines starting with the word " From "followed by space
     * all lines starting with " > "which is not intended to be a quote
       character

Note

   NeoMutt only supports space-stuffing for the first two types of lines
   but not for the third: It is impossible to safely detect whether a
   leading >character starts a quote or not. Furthermore, NeoMutt only
   applies space-stuffing once after the initial edit is finished.

   All leading spaces are to be removed by receiving clients to restore
   the original message prior to further processing.

6.4.3. Editor Considerations

   As NeoMutt provides no additional features to compose f=f messages,
   it's completely up to the user and his editor to produce proper
   messages. Please consider your editor's documentation if you intend to
   send f=f messages.

   Please note that when editing messages from the compose menu several
   times before really sending a mail, it's up to the user to ensure that
   the message is properly space-stuffed.

   For example, vim provides the w flag for its formatoptions setting to
   assist in creating f=f messages, see :help fo-table for details.

6.4.4. Reformatting

   NeoMutt has some support for reformatting when viewing and replying to
   format=flowed messages. In order to take advantage of these,
   $reflow_text must be set.
     * Paragraphs are automatically reflowed and wrapped at a width
       specified by $reflow_wrap.
     * In its original format, the quoting style of format=flowed messages
       can be difficult to read, and doesn't intermix well with non-flowed
       replies. Setting $reflow_space_quotes adds spaces after each level
       of quoting when in the pager and replying in a non-flowed format
       (i.e. with $text_flowed unset).
     * If $reflow_space_quotes is unset, NeoMutt will still add one
       trailing space after all the quotes in the pager (but not when
       replying).

7. Forwarding and Bouncing Mail

   Bouncing and forwarding let you send an existing message to recipients
   that you specify. Bouncing a message sends a verbatim copy of a message
   to alternative addresses as if they were the message's original
   recipients specified in the Bcc header. Forwarding a message, on the
   other hand, allows you to modify the message before it is resent (for
   example, by adding your own comments). Bouncing is done using the
   <bounce>function and forwarding using the <forward>function bound to
   "b" and "f" respectively.

   Forwarding can be done by including the original message in the new
   message's body (surrounded by indicating lines) or including it as a
   MIME attachment, depending on the value of the $mime_forward variable.
   Decoding of attachments, like in the pager, can be controlled by the
   $forward_decode and $mime_forward_decode variables, respectively. The
   desired forwarding format may depend on the content, therefore
   $mime_forward is a quadoption which, for example, can be set to
   "ask-no".

   The inclusion of headers is controlled by the current setting of the
   $weed variable, unless $mime_forward is set.

   By default a forwarded message does not reference the messages it
   contains. When $forward_references is set, a forwarded message includes
   the "In-Reply-To:"and "References:"headers, just like a reply would.
   Hence the forwarded message becomes part of the original thread instead
   of starting a new one.

   Editing the message to forward follows the same procedure as sending or
   replying to a message does.

8. Postponing Mail

   At times it is desirable to delay sending a message that you have
   already begun to compose. When the <postpone-message>function is used
   in the compose menu, the body of your message and attachments are
   stored in the mailbox specified by the $postponed variable. This means
   that you can recall the message even if you exit NeoMutt and then
   restart it at a later time.

   Once a message is postponed, there are several ways to resume it. From
   the command line you can use the "-p" option, or if you compose a new
   message from the index or pager you will be prompted if postponed
   messages exist. If multiple messages are currently postponed, the
   postponed menu will pop up and you can select which message you would
   like to resume.

Note

   If you postpone a reply to a message, the reply setting of the message
   is only updated when you actually finish the message and send it. Also,
   you must be in the same folder with the message you replied to for the
   status of the message to be updated.

   See also the $postpone quad-option.

Chapter 3. Configuration

   Table of Contents

   1. Location of Initialization Files

        1.1. Location of system config files
        1.2. Location of user config files

   2. Syntax of Initialization Files
   3. Address Groups
   4. Defining/Using Aliases
   5. Changing the Default Key Bindings

        5.1. Warnings about Duplicated Bindings

   6. Defining Aliases for Character Sets
   7. Setting Variables Based Upon Mailbox
   8. Keyboard Macros
   9. Using Color and Mono Video Attributes
   10. Message Header Display

        10.1. Header Display
        10.2. Selecting Headers
        10.3. Ordering Displayed Headers

   11. Alternative Addresses
   12. Mailing Lists
   13. Using Multiple Spool Mailboxes
   14. Monitoring Incoming Mail
   15. User-Defined Headers
   16. Specify Default Save Mailbox
   17. Specify Default Fcc: Mailbox When Composing
   18. Specify Default Save Filename and Default Fcc: Mailbox at Once
   19. Change Settings Based Upon Message Recipients
   20. Change Settings Before Formatting a Message
   21. Choosing the Cryptographic Key of the Recipient
   22. Adding Key Sequences to the Keyboard Buffer
   23. Executing Functions
   24. Message Scoring
   25. Spam Detection
   26. Setting and Querying Variables

        26.1. Variable Types
        26.2. Commands
        26.3. User-Defined Variables
        26.4. Type Conversions

   27. Reading Initialization Commands From Another File
   28. Removing Hooks
   29. Format Strings

        29.1. Basic usage
        29.2. Conditionals
        29.3. Filters
        29.4. Padding
        29.5. Conditional Dates

   30. Control allowed header fields in a mailto: URL

1. Location of Initialization Files

   When NeoMutt starts up it looks for two configuration files -- one
   "system" file and one "user" file.

   NeoMutt searches for several different file names when looking for
   config. It looks for NeoMutt config files before Mutt config files and
   versioned config before plain config. For example:

   Table 3.1. NeoMutt config file search order
   neomuttrc
   muttrc

   This allows the user to create separate NeoMutt and Mutt config files
   on the same system.

1.1. Location of system config files

   NeoMutt will search for a system config file in a neomutt directory in
   several places. First it searches the locations specified in the
   XDG_CONFIG_DIRS environment variable, which defaults to /etc/xdg. Next,
   it looks in /etc. Finally, it tries /usr/share.

   The system config file will not be read if the "-n" option is used on
   the command line.

   NeoMutt will read just one file, the first file it finds, from the list
   below.

   Table 3.2. NeoMutt system config file locations
          File Location                     Notes
   /etc/xdg/neomutt/neomuttrc
   /etc/xdg/neomutt/Muttrc      Note the case of the filename
   /etc/neomuttrc
   /etc/Muttrc                  Note the case of the filename
   /usr/share/neomutt/neomuttrc
   /usr/share/neomutt/Muttrc    Note the case of the filename

1.2. Location of user config files

   NeoMutt will search for a user config file in several places. First it
   looks in the directory specified in the XDG_CONFIG_HOME environment
   variable, which defaults to ~/.config/neomutt. Next, it looks in ~
   (your home directory). Finally, it tries ~/.neomutt.

   You may specify your own location for the user config file using the
   "-F" option on the command line.

   NeoMutt will read just one file, the first file it finds, from the list
   below.

   Table 3.3. NeoMutt user config file locations
          File Location
   ~/.config/neomutt/neomuttrc
   ~/.config/neomutt/muttrc
   ~/.config/mutt/neomuttrc
   ~/.config/mutt/muttrc
   ~/.neomutt/neomuttrc
   ~/.neomutt/muttrc
   ~/.mutt/neomuttrc
   ~/.mutt/muttrc
   ~/.neomuttrc
   ~/.muttrc

2. Syntax of Initialization Files

   An initialization file consists of a series of commands. Each line of
   the file may contain one or more commands. When multiple commands are
   used, they must be separated by a semicolon ( ";").

   Example 3.1. Multiple configuration commands per line
set realname='John Smith' ; ignore x-

   The hash mark, or pound sign ( "#"), is used as a "comment" character.
   You can use it to annotate your initialization file. All text after the
   comment character to the end of the line is ignored.

   Example 3.2. Commenting configuration files
my_hdr X-Disclaimer: Why are you listening to me?
        # This is a comment

   Single quotes ( "'") and double quotes ( """) can be used to quote
   strings which contain spaces or other special characters. The
   difference between the two types of quotes is similar to that of many
   popular shell programs, namely that a single quote is used to specify a
   literal string (one that is not interpreted for shell variables or
   quoting with a backslash [see next paragraph]), while double quotes
   indicate a string for which should be evaluated. For example, backticks
   are evaluated inside of double quotes, but not for single quotes.

   "\"quotes the next character, just as in shells such as bash and zsh.
   For example, if want to put quotes """inside of a string, you can use
   "\"to force the next character to be a literal instead of interpreted
   character.

   Example 3.3. Escaping quotes in configuration files
set realname="Michael \"MuttDude\" Elkins"

   "\\"means to insert a literal "\"into the line. "\n" and "\r" have
   their usual C meanings of linefeed and carriage-return, respectively.

   A "\"at the end of a line can be used to split commands over multiple
   lines as it "escapes" the line end, provided that the split points
   don't appear in the middle of command names. Lines are first
   concatenated before interpretation so that a multi-line can be
   commented by commenting out the first line only.

   Example 3.4. Splitting long configuration commands over several lines
set status_format="some very \
long value split \
over several lines"

   It is also possible to substitute the output of a Unix command in an
   initialization file. This is accomplished by enclosing the command in
   backticks (``). In Example 3.5, "Using external command's output in
   configuration files", the output of the Unix command "uname -a" will be
   substituted before the line is parsed. Since initialization files are
   line oriented, only the first line of output from the Unix command will
   be substituted.

   Example 3.5. Using external command's output in configuration files
my_hdr X-Operating-System: `uname -a`

   Both environment variables and NeoMutt variables can be accessed by
   prepending "$"to the name of the variable. For example,

   Example 3.6. Using environment variables in configuration files
set record=+sent_on_$HOSTNAME

   will cause NeoMutt to save outgoing messages to a folder named
   "sent_on_kremvax" if the environment variable $HOSTNAME is set to
   "kremvax."(See $record for details.)

   NeoMutt expands the variable when it is assigned, not when it is used.
   If the value of a variable on the right-hand side of an assignment
   changes after the assignment, the variable on the left-hand side will
   not be affected.

   The commands understood by NeoMutt are explained in the next
   paragraphs. For a complete list, see the command reference.

   All configuration files are expected to be in the current locale as
   specified by the $charset variable which doesn't have a default value
   since it's determined by NeoMutt at startup. If a configuration file is
   not encoded in the same character set the $config_charset variable
   should be used: all lines starting with the next are recoded from
   $config_charset to $charset.

   This mechanism should be avoided if possible as it has the following
   implications:
     * These variables should be set early in a configuration file with
       $charset preceding $config_charset so NeoMutt knows what character
       set to convert to.
     * If $config_charset is set, it should be set in each configuration
       file because the value is global and not per configuration file.
     * Because NeoMutt first recodes a line before it attempts to parse
       it, a conversion introducing question marks or other characters as
       part of errors (unconvertable characters, transliteration) may
       introduce syntax errors or silently change the meaning of certain
       tokens (e.g. inserting question marks into regular expressions).

3. Address Groups

   Usage:

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

   NeoMutt supports grouping addresses logically into named groups. An
   address or address pattern can appear in several groups at the same
   time. These groups can be used in patterns(for searching, limiting and
   tagging) and in hooks by using group patterns. This can be useful to
   classify mail and take certain actions depending on in what groups the
   message is. For example, the NeoMutt user's mailing list would fit into
   the categories "mailing list" and "NeoMutt-related". Using send-hook ,
   the sender can be set to a dedicated one for writing mailing list
   messages, and the signature could be set to a NeoMutt-related one for
   writing to a NeoMutt list -- for other lists, the list sender setting
   still applies but a different signature can be selected. Or, given a
   group only containing recipients known to accept encrypted mail,
   "auto-encryption" can be achieved easily.

   The group command is used to directly add either addresses or regular
   expressions to the specified group or groups. The different categories
   of arguments to the group command can be in any order. The flags -rx
   and -addr specify what the following strings (that cannot begin with a
   hyphen) should be interpreted as: either a regular expression or an
   email address, respectively.

   These address groups can also be created implicitly by the alias ,
   lists , subscribe and alternates commands by specifying the optional
   -group option. For example,
alternates -group me address1 address2
alternates -group me -group work address3

   would create a group named "me" which contains all your addresses and a
   group named "work" which contains only your work address address3.
   Besides many other possibilities, this could be used to automatically
   mark your own messages in a mailing list folder as read or use a
   special signature for work-related messages.

   The ungroup command is used to remove addresses or regular expressions
   from the specified group or groups. The syntax is similar to the group
   command, however the special character *can be used to empty a group of
   all of its contents. As soon as a group gets empty because all
   addresses and regular expressions have been removed, it'll internally
   be removed, too (i.e. there cannot be an empty group). When removing
   regular expressions from a group, the pattern must be specified exactly
   as given to the group command or -group argument.

4. Defining/Using Aliases

   Usage:

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

   It's usually very cumbersome to remember or type out the address of
   someone you are communicating with. NeoMutt allows you to create
   "aliases" which map a short string to a full address.

Note

   If you want to create an alias for more than one address, you must
   separate the addresses with a comma ( ",").

   The optional -group argument to alias causes the aliased address(es) to
   be added to the named group.

   To remove an alias or aliases ( "*"means all aliases):
alias muttdude me@cs.hmc.edu (Michael Elkins)
alias theguys manny, moe, jack

   Unlike other mailers, NeoMutt doesn't require aliases to be defined in
   a special file. The alias command can appear anywhere in a
   configuration file, as long as this file is sourced. Consequently, you
   can have multiple alias files, or you can have all aliases defined in
   your .neomuttrc.

   On the other hand, the <create-alias> function can use only one file,
   the one pointed to by the $alias_file variable (which is ~/.neomuttrc
   by default). This file is not special either, in the sense that NeoMutt
   will happily append aliases to any file, but in order for the new
   aliases to take effect you need to explicitly source this file too.

   Example 3.7. Configuring external alias files
source /usr/local/share/NeoMutt.aliases
source ~/.mail_aliases
set alias_file=~/.mail_aliases

   To use aliases, you merely use the alias at any place in NeoMutt where
   NeoMutt prompts for addresses, such as the To:or Cc:prompt. You can
   also enter aliases in your editor at the appropriate headers if you
   have the $edit_headers variable set.

   In addition, at the various address prompts, you can use the tab
   character to expand a partial alias to the full alias. If there are
   multiple matches, NeoMutt will bring up a menu with the matching
   aliases. In order to be presented with the full list of aliases, you
   must hit tab without a partial alias, such as at the beginning of the
   prompt or after a comma denoting multiple addresses.

   In the alias menu, you can select as many aliases as you want with the
   select-entry key (default: <Return>), and use the exit key (default: q)
   to return to the address prompt.

5. Changing the Default Key Bindings

   Usage:

   bind map key function

   This command allows you to change the default key bindings (operation
   invoked when pressing a key).

   map specifies in which menu the binding belongs. Multiple maps may be
   specified by separating them with commas (no additional whitespace is
   allowed). The currently defined maps are:

   generic
          This is not a real menu, but is used as a fallback for all of
          the other menus except for the pager and editor modes. If a key
          is not defined in another menu, NeoMutt will look for a binding
          to use in this menu. This allows you to bind a key to a certain
          function in multiple menus instead of having multiple bind
          statements to accomplish the same task.

   alias
          The alias menu is the list of your personal aliases as defined
          in your .neomuttrc. It is the mapping from a short alias name to
          the full email address(es) of the recipient(s).

   attach
          The attachment menu is used to access the attachments on
          received messages.

   browser
          The browser is used for both browsing the local directory
          structure, and for listing all of your incoming mailboxes.

   editor
          The editor is used to allow the user to enter a single line of
          text, such as the To or Subject prompts in the compose menu.

   index
          The index is the list of messages contained in a mailbox.

   compose
          The compose menu is the screen used when sending a new message.

   pager
          The pager is the mode used to display message/attachment data,
          and help listings.

   pgp
          The pgp menu is used to select the OpenPGP keys used to encrypt
          outgoing messages.

   smime
          The smime menu is used to select the OpenSSL certificates used
          to encrypt outgoing messages.

   postpone
          The postpone menu is similar to the index menu, except is used
          when recalling a message the user was composing, but saved until
          later.

   query
          The query menu is the browser for results returned by
          $query_command.

   mix
          The mixmaster screen is used to select remailer options for
          outgoing messages (if NeoMutt is compiled with Mixmaster
          support).

   key is the key (or key sequence) you wish to bind. To specify a control
   character, use the sequence \Cx, where x is the letter of the control
   character (for example, to specify control-A use "\Ca"). Note that the
   case of x as well as \C is ignored, so that \CA, \Ca, \cA and \ca are
   all equivalent. An alternative form is to specify the key as a three
   digit octal number prefixed with a "\"(for example \177 is equivalent
   to \c?). In addition, key may be a symbolic name as shown in Table 3.4,
   "Symbolic key names".

   Table 3.4. Symbolic key names
   Symbolic name       Meaning
   \t            tab
   <tab>         tab
   <backtab>     backtab / shift-tab
   \r            carriage return
   \n            newline
   \e            escape/alt
   <esc>         escape/alt
   <up>          up arrow
   <down>        down arrow
   <left>        left arrow
   <right>       right arrow
   <pageup>      Page Up
   <pagedown>    Page Down
   <backspace>   Backspace
   <delete>      Delete
   <insert>      Insert
   <enter>       Enter
   <return>      Return
   <home>        Home
   <end>         End
   <space>       Space bar
   <f1>          function key 1
   <f10>         function key 10

   The <what-key>function can be used to explore keycode and symbolic
   names for other keys on your keyboard. Executing this function will
   display information about each key pressed, until terminated by ^G.

   key does not need to be enclosed in quotes unless it contains a space (
   " ") or semi-colon ( ";").

   function specifies which action to take when key is pressed. For a
   complete list of functions, see the reference. Note that the bind
   expects function to be specified without angle brackets.

   The special function <noop>unbinds the specified key sequence.

5.1. Warnings about Duplicated Bindings

   Due to a limitation of NeoMutt, creating key bindings, or macros, will
   overwrite existing mappings with similar, shorter, names.
bind index g  group-reply
bind index gg first-entry

   In this example, the g binding will be overwritten and cannot be used.
   Newer versions of NeoMutt will warn the user about this.

   To avoid warnings on startup, first set the shorter binding to noop (no
   operation).
bind index g  noop
bind index gg first-entry

6. Defining Aliases for Character Sets

   Usage:

   charset-hook alias charset
   iconv-hook charset local-charset

   The charset-hook command defines an alias for a character set. This is
   useful to properly display messages which are tagged with a character
   set name not known to NeoMutt.

   The iconv-hook command defines a system-specific name for a character
   set. This is helpful when your systems character conversion library
   insists on using strange, system-specific names for character sets.

7. Setting Variables Based Upon Mailbox

   Usage:

   folder-hook [!]regex command

   It is often desirable to change settings based on which mailbox you are
   reading. The folder-hook command provides a method by which you can
   execute any configuration command. regex is a regular expression
   specifying in which mailboxes to execute command before loading. If a
   mailbox matches multiple folder-hooks, they are executed in the order
   given in the .neomuttrc.

   The regex parameter has mailbox shortcut expansion performed on the
   first character. See Mailbox Matching in Hooksfor more details.

Note

   If you use the "!"shortcut for $spoolfile at the beginning of the
   pattern, you must place it inside of double or single quotes in order
   to distinguish it from the logical not operator for the expression.

Note

   Settings are not restored when you leave the mailbox. For example, a
   command action to perform is to change the sorting method based upon
   the mailbox being read:
folder-hook work "set sort=threads"

   However, the sorting method is not restored to its previous value when
   reading a different mailbox. To specify a default command, use the
   pattern "."before other folder-hooks adjusting a value on a per-folder
   basis because folder-hooks are evaluated in the order given in the
   configuration file.

Note

   The keyboard buffer will not be processed until after all hooks are
   run; multiple push or exec commands will end up being processed in
   reverse order.

   The following example will set the sort variable to date-sent for all
   folders but to threads for all folders containing "work" in their name.

   Example 3.8. Setting sort method based on mailbox name
folder-hook . "set sort=date-sent"
folder-hook work "set sort=threads"

8. Keyboard Macros

   Usage:

   macro menu key sequence [ description ]

   Macros are useful when you would like a single key to perform a series
   of actions. When you press key in menu menu, NeoMutt will behave as if
   you had typed sequence. So if you have a common sequence of commands
   you type, you can create a macro to execute those commands with a
   single key or fewer keys.

   menu is the map which the macro will be bound in. Multiple maps may be
   specified by separating multiple menu arguments by commas. Whitespace
   may not be used in between the menu arguments and the commas separating
   them.

   key and sequence are expanded by the same rules as the key bindings
   with some additions. The first is that control characters in sequence
   can also be specified as ^x. In order to get a caret ( "^") you need to
   use ^^. Secondly, to specify a certain key such as up or to invoke a
   function directly, you can use the format <key name>and <function
   name>. For a listing of key names see the section on key bindings.
   Functions are listed in the reference.

   The advantage with using function names directly is that the macros
   will work regardless of the current key bindings, so they are not
   dependent on the user having particular key definitions. This makes
   them more robust and portable, and also facilitates defining of macros
   in files used by more than one user (e.g., the system neomuttrc).

   Optionally you can specify a descriptive text after sequence, which is
   shown in the help screens if they contain a description.

Note

   Macro definitions (if any) listed in the help screen(s), are silently
   truncated at the screen width, and are not wrapped.

9. Using Color and Mono Video Attributes

   Usage:

   color object foreground background
   color { header | body } foreground background regex
   color index-object foreground background pattern
   color compose composeobject foreground background
   uncolor { index-object | header | body } { * | pattern ... }

   If your terminal supports color, you can spice up NeoMutt by creating
   your own color scheme. To define the color of an object (type of
   information), you must specify both a foreground color and a background
   color (it is not possible to only specify one or the other).

   header and body match regex in the header/body of a message,
   index-object can match pattern(see Section 3, "Patterns: Searching,
   Limiting and Tagging") in the message index. Note that IMAP server-side
   searches (=b, =B, =h) are not supported for color index patterns.

   When $header_color_partial is unset (the default), a header matched by
   regex will have color applied to the entire header. When set, color is
   applied only to the exact text matched by regex.

   object can be one of:
     * attachment
     * bold (highlighting bold patterns in the body of messages)
     * error (error messages printed by NeoMutt)
     * hdrdefault (default color of the message header in the pager)
     * index_author (color of the author name in the index, uses pattern)
     * index_collapsed (the number of messages in a collapsed thread in
       the index)
     * index_date (color of the date field in the index)
     * index_flags (color of the message flags in the index)
     * index_label (color of the message label in the index)
     * index_number (color of the message number in the index)
     * index_size (color of the message size and line number in the index)
     * index_subject (color of the subject in the index, uses pattern)
     * indicator (arrow or bar used to indicate the current item in a
       menu)
     * markers (the "+"markers at the beginning of wrapped lines in the
       pager)
     * message (informational messages)
     * normal
     * progress(visual progress bar)
     * prompt
     * quoted (text matching $quote_regex in the body of a message)
     * quoted1, quoted2, ..., quoted N(higher levels of quoting)
     * search (highlighting of words in the pager)
     * signature
     * status (mode lines used to display info about the mailbox or
       message)
     * tilde (the "~"used to pad blank lines in the pager)
     * tree (thread tree drawn in the message index and attachment menu)
     * underline (highlighting underlined patterns in the body of
       messages)

   composeobject can be one of:
     * header
     * security_encrypt
     * security_sign
     * security_both
     * security_none

   index-object can be one of the following:
     * index (default highlighting of the entire index line, uses pattern)
     * index_date (the date field)
     * index_flags (the message flags, %S %Z, uses pattern)
     * index_number (the message number, %C)
     * index_collapsed (the number of messages in a collapsed thread, %M)
     * index_author (the author name, %A %a %F %L %n, uses pattern)
     * index_subject (the subject, %s, uses pattern)
     * index_size (the message size, %c %l)
     * index_label (the message label, %y %Y)
     * index_tags (the transformed message tags, %g)
     * index_tag (an individual message tag, %G, uses pattern / tag name)

   foreground and background can be one of the following:
     * white
     * black
     * green
     * magenta
     * blue
     * cyan
     * yellow
     * red
     * default
     * color x

   foreground can optionally be prefixed with the keyword bright to make
   the foreground color boldfaced (e.g., brightred).

   If your terminal supports it, the special keyword default can be used
   as a transparent color. The value brightdefault is also valid. If
   NeoMutt is linked against the S-Lang library, you also need to set the
   $COLORFGBG environment variable to the default colors of your terminal
   for this to work; for example (for Bourne-like shells):
set COLORFGBG="green;black"
export COLORFGBG

Note

   The S-Lang library requires you to use the lightgray and brown keywords
   instead of white and yellow when setting this variable.

Note

   The uncolor command can be applied to the index, header and body
   objects only. It removes entries from the list. You must specify the
   same pattern specified in the color command for it to be removed. The
   pattern "*"is a special token which means to clear the color list of
   all entries.

   NeoMutt also recognizes the keywords color0, color1, ..., color N-1( N
   being the number of colors supported by your terminal). This is useful
   when you remap the colors for your display (for example by changing the
   color associated with color2 for your xterm), since color names may
   then lose their normal meaning.

   If your terminal does not support color, it is still possible change
   the video attributes through the use of the "mono" command. Usage:

   mono object attribute
   mono { header | body } attribute regex
   mono index attribute pattern
   unmono { index-object | header | body } { * | pattern ... }

   For object, see the color command. attribute can be one of the
   following:
     * none
     * bold
     * underline
     * reverse
     * standout

10. Message Header Display

10.1. Header Display

   When displaying a message in the pager, NeoMutt folds long header lines
   at $wrap columns. Though there're precise rules about where to break
   and how, NeoMutt always folds headers using a tab for readability.
   (Note that the sending side is not affected by this, NeoMutt tries to
   implement standards compliant folding.)

10.2. Selecting Headers

   Usage:

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

   Messages often have many header fields added by automatic processing
   systems, or which may not seem useful to display on the screen. This
   command allows you to specify header fields which you don't normally
   want to see in the pager.

   You do not need to specify the full header field name. For example,
   "ignore content-"will ignore all header fields that begin with the
   pattern "content-". "ignore *"will ignore all headers.

   To remove a previously added token from the list, use the "unignore"
   command. The "unignore" command will make NeoMutt display headers with
   the given pattern. For example, if you do "ignore x-"it is possible to
   "unignore x-mailer".

   "unignore *"will remove all tokens from the ignore list.

   Example 3.9. Header weeding
# Sven's draconian header weeding
ignore *
unignore from date subject to cc
unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
unignore posted-to:

10.3. Ordering Displayed Headers

   Usage:

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

   With the hdr_order command you can specify an order in which NeoMutt
   will attempt to present these headers to you when viewing messages.

   " unhdr_order*"will clear all previous headers from the order list,
   thus removing the header order effects set by the system-wide startup
   file.

   Example 3.10. Configuring header display order
hdr_order From Date: From: To: Cc: Subject:

11. Alternative Addresses

   Usage:

   alternates [ -group name ...] regex [ regex ...]
   unalternates [ -group name ...] { * | regex ... }

   With various functions, NeoMutt will treat messages differently,
   depending on whether you sent them or whether you received them from
   someone else. For instance, when replying to a message that you sent to
   a different party, NeoMutt will automatically suggest to send the
   response to the original message's recipients -- responding to yourself
   won't make much sense in many cases. (See $reply_to.)

   Many users receive e-mail under a number of different addresses. To
   fully use NeoMutt's features here, the program must be able to
   recognize what e-mail addresses you receive mail under. That's the
   purpose of the alternates command: It takes a list of regular
   expressions, each of which can identify an address under which you
   receive e-mail.

   As addresses are matched using regular expressions and not exact strict
   comparisons, you should make sure you specify your addresses as precise
   as possible to avoid mismatches. For example, if you specify:
alternates user@example

   NeoMutt will consider " some-user@example "as being your address, too
   which may not be desired. As a solution, in such cases addresses should
   be specified as:
alternates '^user@example$'

   The -group flag causes all of the subsequent regular expressions to be
   added to the named group.

   The unalternates command can be used to write exceptions to alternates
   patterns. If an address matches something in an alternates command, but
   you nonetheless do not think it is from you, you can list a more
   precise pattern under an unalternates command.

   To remove a regular expression from the alternates list, use the
   unalternates command with exactly the same regex. Likewise, if the
   regex for an alternates command matches an entry on the unalternates
   list, that unalternates entry will be removed. If the regex for
   unalternates is "*", all entries on alternates will be removed.

12. Mailing Lists

   Usage:

   lists [ -group name ...] regex [ regex ...]
   unlists { * | regex ... }
   subscribe [ -group name ...] regex [ regex ...]
   unsubscribe { * | regex ... }

   NeoMutt has a few nice features for handling mailing lists. In order to
   take advantage of them, you must specify which addresses belong to
   mailing lists, and which mailing lists you are subscribed to. NeoMutt
   also has limited support for auto-detecting mailing lists: it supports
   parsing mailto:links in the common List-Post:header which has the same
   effect as specifying the list address via the lists command (except the
   group feature). Once you have done this, the <list-reply> function will
   work for all known lists. Additionally, when you send a message to a
   subscribed list, NeoMutt will add a Mail-Followup-To header to tell
   other users' mail user agents not to send copies of replies to your
   personal address.

Note

   The Mail-Followup-To header is a non-standard extension which is not
   supported by all mail user agents. Adding it is not bullet-proof
   against receiving personal CCs of list messages. Also note that the
   generation of the Mail-Followup-To header is controlled by the
   $followup_to configuration variable since it's common practice on some
   mailing lists to send Cc upon replies (which is more a group- than a
   list-reply).

   More precisely, NeoMutt maintains lists of patterns for the addresses
   of known and subscribed mailing lists. Every subscribed mailing list is
   known. To mark a mailing list as known, use the list command. To mark
   it as subscribed, use subscribe.

   You can use regular expressions with both commands. To mark all
   messages sent to a specific bug report's address on Debian's bug
   tracking system as list mail, for instance, you could say
subscribe [0-9]+.*@bugs.debian.org

   as it's often sufficient to just give a portion of the list's e-mail
   address.

   Specify as much of the address as you need to to remove ambiguity. For
   example, if you've subscribed to the NeoMutt mailing list, you will
   receive mail addressed to neomutt-users@neomutt.org. So, to tell
   NeoMutt that this is a mailing list, you could add lists
   neomutt-users@to your initialization file. To tell NeoMutt that you are
   subscribed to it, add subscribe neomutt-users to your initialization
   file instead. If you also happen to get mail from someone whose address
   is neomutt-users@example.com, you could use lists
   ^neomutt-users@neomutt\\.org$or subscribe
   ^neomutt-users@neomutt\\.org$to match only mail from the actual list.

   The -group flag adds all of the subsequent regular expressions to the
   named address group in addition to adding to the specified address
   list.

   The "unlists" command is used to remove a token from the list of known
   and subscribed mailing-lists. Use "unlists *"to remove all tokens.

   To remove a mailing list from the list of subscribed mailing lists, but
   keep it on the list of known mailing lists, use unsubscribe.

13. Using Multiple Spool Mailboxes

   Usage:

   mbox-hook [!]regex mailbox

   This command is used to move read messages from a specified mailbox to
   a different mailbox automatically when you quit or change folders.
   regex is a regular expression specifying the mailbox to treat as a
   "spool" mailbox and mailbox specifies where mail should be saved when
   read.

   The regex parameter has mailbox shortcut expansion performed on the
   first character. See Mailbox Matching in Hooksfor more details.

   Note that execution of mbox-hooks is dependent on the $move
   configuration variable. If set to "no"(the default), mbox-hooks will
   not be executed.

   Unlike some of the other hook commands, only the first matching regex
   is used (it is not possible to save read mail in more than a single
   mailbox).

14. Monitoring Incoming Mail

   Usage:

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

   This command specifies folders which can receive mail and which will be
   checked for new messages periodically.

   folder can either be a local file or directory (Mbox/Mmdf or
   Maildir/Mh). If NeoMutt was built with POP and/or IMAP support, folder
   can also be a POP/IMAP folder URL. The URL syntax is described in
   Section 1.2, "URL Syntax", POP and IMAP are described in Section 3,
   "POP3 Support"and Section 4, "IMAP Support"respectively.

   NeoMutt provides a number of advanced features for handling (possibly
   many) folders and new mail within them, please refer to Section 13,
   "New Mail Detection"for details (including in what situations and how
   often NeoMutt checks for new mail). Additionally, $new_mail_command can
   be used to run a command when new mail is detected.

   The "unmailboxes" command is used to remove a token from the list of
   folders which receive mail. Use "unmailboxes *"to remove all tokens.

Note

   The folders in the mailboxes command are resolved when the command is
   executed, so if these names contain shortcut characters(such as "="and
   "!"), any variable definition that affects these characters (like
   $folder and $spoolfile) should be set before the mailboxes command. If
   none of these shortcuts are used, a local path should be absolute as
   otherwise NeoMutt tries to find it relative to the directory from where
   NeoMutt was started which may not always be desired.

15. User-Defined Headers

   Usage:

   my_hdr string
   unmy_hdr { * | field ... }

   The my_hdr command allows you to create your own header fields which
   will be added to every message you send and appear in the editor if
   $edit_headers is set.

   For example, if you would like to add an "Organization:"header field to
   all of your outgoing messages, you can put the command something like
   shown in Example 3.11, "Defining custom headers"in your .neomuttrc.

   Example 3.11. Defining custom headers
my_hdr Organization: A Really Big Company, Anytown, USA

Note

   Space characters are not allowed between the keyword and the colon (
   ":"). The standard for electronic mail (RFC2822) says that space is
   illegal there, so NeoMutt enforces the rule.

   If you would like to add a header field to a single message, you should
   either set the $edit_headers variable, or use the
   <edit-headers>function (default: "E") in the compose menu so that you
   can edit the header of your message along with the body.

   To remove user defined header fields, use the unmy_hdr command. You may
   specify an asterisk ( "*") to remove all header fields, or the fields
   to remove. For example, to remove all "To" and "Cc" header fields, you
   could use:
unmy_hdr to cc

16. Specify Default Save Mailbox

   Usage:

   save-hook [!]pattern mailbox

   This command is used to override the default mailbox used when saving
   messages. mailbox will be used as the default if the message matches
   pattern, see Message Matching in Hooksfor information on the exact
   format.

   To provide more flexibility and good defaults, NeoMutt applies the
   expandos of $index_format to mailbox after it was expanded.

   Example 3.12. Using %-expandos in save-hook
# default: save all to ~/Mail/<author name>
save-hook . ~/Mail/%F
# save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins
save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
# save from aol.com to $folder/spam
save-hook aol\\.com$ +spam

   Also see the fcc-save-hook command.

17. Specify Default Fcc: Mailbox When Composing

   Usage:

   fcc-hook [!]pattern mailbox

   This command is used to save outgoing mail in a mailbox other than
   $record. NeoMutt searches the initial list of message recipients for
   the first matching pattern and uses mailbox as the default Fcc:
   mailbox. If no match is found the message will be saved to $record
   mailbox.

   To provide more flexibility and good defaults, NeoMutt applies the
   expandos of $index_format to mailbox after it was expanded.

   See Message Matching in Hooksfor information on the exact format of
   pattern.
fcc-hook [@.]aol\\.com$ +spammers

   ...will save a copy of all messages going to the aol.com domain to the
   `+spammers' mailbox by default. Also see the fcc-save-hook command.

18. Specify Default Save Filename and Default Fcc: Mailbox at Once

   Usage:

   fcc-save-hook [!]pattern mailbox

   This command is a shortcut, equivalent to doing both a fcc-hook and a
   save-hook with its arguments, including %-expansion on mailbox
   according to $index_format.

19. Change Settings Based Upon Message Recipients

   Usage:

   reply-hook [!]pattern command
   send-hook [!]pattern command
   send2-hook [!]pattern command

   These commands can be used to execute arbitrary configuration commands
   based upon recipients of the message. pattern is used to match the
   message, see Message Matching in Hooksfor details. command is executed
   when pattern matches.

   reply-hook is matched against the message you are replying to, instead
   of the message you are sending. send-hook is matched against all
   messages, both new and replies.

Note

   reply-hooks are matched before the send-hook, regardless of the order
   specified in the user's configuration file. However, you can inhibit
   send-hook in the reply case by using the pattern '! ~Q'( not replied,
   see Message Matching in Hooks) in the send-hook to tell when reply-hook
   have been executed.

   send2-hook is matched every time a message is changed, either by
   editing it, or by using the compose menu to change its recipients or
   subject. send2-hook is executed after send-hook, and can, e.g., be used
   to set parameters such as the $sendmail variable depending on the
   message's sender address.

   For each type of send-hook or reply-hook, when multiple matches occur,
   commands are executed in the order they are specified in the
   .neomuttrc(for that type of hook).

   Example: send-hook work " set mime_forward signature=''"

   Another typical use for this command is to change the values of the
   $attribution, $attribution_locale, and $signature variables in order to
   change the language of the attributions and signatures based upon the
   recipients.

Note

   send-hook's are only executed once after getting the initial list of
   recipients. Adding a recipient after replying or editing the message
   will not cause any send-hook to be executed, similarly if $autoedit is
   set (as then the initial list of recipients is empty). Also note that
   my_hdr commands which modify recipient headers, or the message's
   subject, don't have any effect on the current message when executed
   from a send-hook.

20. Change Settings Before Formatting a Message

   Usage:

   message-hook [!]pattern command

   This command can be used to execute arbitrary configuration commands
   before viewing or formatting a message based upon information about the
   message. command is executed if the pattern matches the message to be
   displayed. When multiple matches occur, commands are executed in the
   order they are specified in the .neomuttrc.

   See Message Matching in Hooksfor information on the exact format of
   pattern.

   Example:
message-hook ~A 'set pager=builtin'
message-hook '~f freshmeat-news' 'set pager="less \"+/^  subject: .*\""'

21. Choosing the Cryptographic Key of the Recipient

   Usage:

   crypt-hook regex keyid

   When encrypting messages with PGP/GnuPG or OpenSSL, you may want to
   associate a certain key with a given e-mail address automatically,
   either because the recipient's public key can't be deduced from the
   destination address, or because, for some reasons, you need to override
   the key NeoMutt would normally use. The crypt-hook command provides a
   method by which you can specify the ID of the public key to be used
   when encrypting messages to a certain recipient. You may use multiple
   crypt-hooks with the same regex; multiple matching crypt-hooks result
   in the use of multiple keyids for a recipient. During key selection,
   NeoMutt will confirm whether each crypt-hook is to be used (unless the
   $crypt_confirmhook option is unset). If all crypt-hooks for a recipient
   are declined, NeoMutt will use the original recipient address for key
   selection instead.

   The meaning of keyid is to be taken broadly in this context: You can
   either put a numerical key ID or fingerprint here, an e-mail address,
   or even just a real name.

22. Adding Key Sequences to the Keyboard Buffer

   Usage:

   push string

   This command adds the named string to the beginning of the keyboard
   buffer. The string may contain control characters, key names and
   function names like the sequence string in the macro command. You may
   use it to automatically run a sequence of commands at startup, or when
   entering certain folders. For example, Example 3.13, "Embedding push in
   folder-hook"shows how to automatically collapse all threads when
   entering a folder.

   Example 3.13. Embedding push in folder-hook
folder-hook . 'push <collapse-all>'

   For using functions like shown in the example, it's important to use
   angle brackets ( "<"and ">") to make NeoMutt recognize the input as a
   function name. Otherwise it will simulate individual just keystrokes,
   i.e. " push collapse-all "would be interpreted as if you had typed "c",
   followed by "o", followed by "l", ..., which is not desired and may
   lead to very unexpected behavior.

   Keystrokes can be used, too, but are less portable because of
   potentially changed key bindings. With default bindings, this is
   equivalent to the above example:
folder-hook . 'push \eV'

   because it simulates that Esc+V was pressed (which is the default
   binding of <collapse-all>).

23. Executing Functions

   Usage:

   exec function [ function ...]

   This command can be used to execute any function. Functions are listed
   in the function reference. " exec function "is equivalent to " push
   <function> ".

24. Message Scoring

   Usage:

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

   The score commands adds value to a message's score if pattern matches
   it. pattern is a string in the format described in the patterns section
   (note: For efficiency reasons, patterns which scan information not
   available in the index, such as ~b, ~B, ~h, or ~X may not be used).
   value is a positive or negative integer. A message's final score is the
   sum total of all matching score entries. However, you may optionally
   prefix value with an equal sign ( "=") to cause evaluation to stop at a
   particular entry if there is a match. Negative final scores are rounded
   up to 0.

   The unscore command removes score entries from the list. You must
   specify the same pattern specified in the score command for it to be
   removed. The pattern "*"is a special token which means to clear the
   list of all score entries.

   Scoring occurs as the messages are read in, before the mailbox is
   sorted. Because of this, patterns which depend on threading, such as
   ~=, ~$, and ~(), will not work by default. A workaround is to push the
   scoring command in a folder hook. This will cause the mailbox to be
   rescored after it is opened and input starts being processed:
folder-hook . 'push "<enter-command>score ~= 10<enter>"'

25. Spam Detection

   Usage:

   spam pattern format
   nospam { * | pattern }

   NeoMutt has generalized support for external spam-scoring filters. By
   defining your spam patterns with the spam and nospam commands, you can
   limit, search, and sort your mail based on its spam attributes, as
   determined by the external filter. You also can display the spam
   attributes in your index display using the %H selector in the
   $index_format variable. (Tip: try %?H?[%H] ?to display spam tags only
   when they are defined for a given message.)

   Your first step is to define your external filter's spam patterns using
   the spam command. pattern should be a regular expression that matches a
   header in a mail message. If any message in the mailbox matches this
   regular expression, it will receive a "spam tag" or "spam
   attribute"(unless it also matches a nospam pattern -- see below.) The
   appearance of this attribute is entirely up to you, and is governed by
   the format parameter. format can be any static text, but it also can
   include back-references from the pattern expression. (A regular
   expression "back-reference" refers to a sub-expression contained within
   parentheses.) %1 is replaced with the first back-reference in the
   regex, %2 with the second, etc.

   To match spam tags, NeoMutt needs the corresponding header information
   which is always the case for local and POP folders but not for IMAP in
   the default configuration. Depending on the spam header to be analyzed,
   $imap_headers may need to be adjusted.

   If you're using multiple spam filters, a message can have more than one
   spam-related header. You can define spam patterns for each filter you
   use. If a message matches two or more of these patterns, and the
   $spam_separator variable is set to a string, then the message's spam
   tag will consist of all the format strings joined together, with the
   value of $spam_separator separating them.

   For example, suppose one uses DCC, SpamAssassin, and PureMessage, then
   the configuration might look like in Example 3.14, "Configuring spam
   detection".

   Example 3.14. Configuring spam detection
spam "X-DCC-.*-Metrics:.*(....)=many"         "90+/DCC-%1"
spam "X-Spam-Status: Yes"                     "90+/SA"
spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
set spam_separator=", "

   If then a message is received that DCC registered with "many" hits
   under the "Fuz2" checksum, and that PureMessage registered with a 97%
   probability of being spam, that message's spam tag would read
   90+/DCC-Fuz2, 97/PM. (The four characters before "=many" in a DCC
   report indicate the checksum used -- in this case, "Fuz2".)

   If the $spam_separator variable is unset, then each spam pattern match
   supersedes the previous one. Instead of getting joined format strings,
   you'll get only the last one to match.

   The spam tag is what will be displayed in the index when you use %H in
   the $index_format variable. It's also the string that the ~H
   pattern-matching expression matches against for <search>and
   <limit>functions. And it's what sorting by spam attribute will use as a
   sort key.

   That's a pretty complicated example, and most people's actual
   environments will have only one spam filter. The simpler your
   configuration, the more effective NeoMutt can be, especially when it
   comes to sorting.

   Generally, when you sort by spam tag, NeoMutt will sort lexically--
   that is, by ordering strings alphanumerically. However, if a spam tag
   begins with a number, NeoMutt will sort numerically first, and
   lexically only when two numbers are equal in value. (This is like
   UNIX's sort -n.) A message with no spam attributes at all -- that is,
   one that didn't match any of your spam patterns -- is sorted at lowest
   priority. Numbers are sorted next, beginning with 0 and ranging upward.
   Finally, non-numeric strings are sorted, with "a" taking lower priority
   than "z". Clearly, in general, sorting by spam tags is most effective
   when you can coerce your filter to give you a raw number. But in case
   you can't, NeoMutt can still do something useful.

   The nospam command can be used to write exceptions to spam patterns. If
   a header pattern matches something in a spam command, but you
   nonetheless do not want it to receive a spam tag, you can list a more
   precise pattern under a nospam command.

   If the pattern given to nospam is exactly the same as the pattern on an
   existing spam list entry, the effect will be to remove the entry from
   the spam list, instead of adding an exception. Likewise, if the pattern
   for a spam command matches an entry on the nospam list, that nospam
   entry will be removed. If the pattern for nospam is "*", all entries on
   both lists will be removed. This might be the default action if you use
   spam and nospam in conjunction with a folder-hook.

   You can have as many spam or nospam commands as you like. You can even
   do your own primitive spam detection within NeoMutt -- for example, if
   you consider all mail from MAILER-DAEMON to be spam, you can use a spam
   command like this:
spam "^From: .*MAILER-DAEMON"       "999"

26. Setting and Querying Variables

26.1. Variable Types

   NeoMutt supports these types of configuration variables:

   boolean
          A boolean expression, either "yes" or "no".

   number
          A signed integer number in the range -32768 to 32767.

   string
          Arbitrary text.

   path
          A specialized string for representing paths including support
          for mailbox shortcuts (see Section 10, "Mailbox Shortcuts") as
          well as tilde ( "~") for a user's home directory and more.

   quadoption
          Like a boolean but triggers a prompt when set to "ask-yes" or
          "ask-no" with "yes" and "no" preselected respectively.

   sort order
          A specialized string allowing only particular words as values
          depending on the variable.

   regular expression
          A regular expression, see Section 2, "Regular Expressions"for an
          introduction.

   folder magic
          Specifies the type of folder to use: mbox, mmdf, mh or maildir.
          Currently only used to determine the type for newly created
          folders.

   e-mail address
          An e-mail address either with or without realname. The older "
          user@example.org (Joe User) "form is supported but strongly
          deprecated.

   user-defined
          Arbitrary text, see Section 26.3, "User-Defined Variables"for
          details.

26.2. Commands

   The following commands are available to manipulate and query variables:

   Usage:

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

   This command is used to set (and unset) configuration variables. There
   are four basic types of variables: boolean, number, string and
   quadoption. boolean variables can be set(true) or unset(false). number
   variables can be assigned a positive integer value. string variables
   consist of any number of printable characters and must be enclosed in
   quotes if they contain spaces or tabs. You may also use the escape
   sequences "\n" and "\t" for newline and tab, respectively. quadoption
   variables are used to control whether or not to be prompted for certain
   actions, or to specify a default action. A value of yes will cause the
   action to be carried out automatically as if you had answered yes to
   the question. Similarly, a value of no will cause the action to be
   carried out as if you had answered "no."A value of ask-yes will cause a
   prompt with a default answer of "yes" and ask-no will provide a default
   answer of "no."

   Prefixing a variable with "no" will unset it. Example: set noaskbcc.

   For boolean variables, you may optionally prefix the variable name with
   inv to toggle the value (on or off). This is useful when writing
   macros. Example: set invsmart_wrap.

   The toggle command automatically prepends the inv prefix to all
   specified variables.

   The unset command automatically prepends the no prefix to all specified
   variables.

   Using the <enter-command>function in the index menu, you can query the
   value of a variable by prefixing the name of the variable with a
   question mark:
set ?allow_8bit

   The question mark is actually only required for boolean and quadoption
   variables.

   The reset command resets all given variables to the compile time
   defaults (hopefully mentioned in this manual). If you use the command
   set and prefix the variable with "&"this has the same behavior as the
   reset command.

   With the reset command there exists the special variable "all", which
   allows you to reset all variables to their system defaults.

26.3. User-Defined Variables

26.3.1. Introduction

   Along with the variables listed in the Configuration variables section,
   NeoMutt supports user-defined variables with names starting with my_ as
   in, for example, my_cfgdir.

   The set command either creates a custom my_ variable or changes its
   value if it does exist already. The unset and reset commands remove the
   variable entirely.

   Since user-defined variables are expanded in the same way that
   environment variables are (except for the shell-escape command and
   backtick expansion), this feature can be used to make configuration
   files more readable.

26.3.2. Examples

   The following example defines and uses the variable my_cfgdir to
   abbreviate the calls of the source command:

   Example 3.15. Using user-defined variables for config file readability
set my_cfgdir = $HOME/neomutt/config
source $my_cfgdir/hooks $my_cfgdir/macros
# more source commands...

   A custom variable can also be used in macros to backup the current
   value of another variable. In the following example, the value of the
   $delete is changed temporarily while its original value is saved as
   my_delete. After the macro has executed all commands, the original
   value of $delete is restored.

   Example 3.16. Using user-defined variables for backing up other config
   option values
macro pager ,x '\
<enter-command>set my_delete=$delete<enter>\
<enter-command>set delete=yes<enter>\
...\
<enter-command>set delete=$my_delete<enter>'

   Since NeoMutt expands such values already when parsing the
   configuration file(s), the value of $my_delete in the last example
   would be the value of $delete exactly as it was at that point during
   parsing the configuration file. If another statement would change the
   value for $delete later in the same or another file, it would have no
   effect on $my_delete. However, the expansion can be deferred to
   runtime, as shown in the next example, when escaping the dollar sign.

   Example 3.17. Deferring user-defined variable expansion to runtime
macro pager <PageDown> "\
<enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
<next-page>\
<enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
<enter-command> unset my_old_pager_stop<Enter>"

   Note that there is a space between <enter-command>and the set
   configuration command, preventing NeoMutt from recording the macro's
   commands into its history.

26.4. Type Conversions

   Variables are always assigned string values which NeoMutt parses into
   its internal representation according to the type of the variable, for
   example an integer number for numeric types. For all queries (including
   $-expansion) the value is converted from its internal type back into
   string. As a result, any variable can be assigned any value given that
   its content is valid for the target. This also counts for custom
   variables which are of type string. In case of parsing errors, NeoMutt
   will print error messages. Example 3.18, "Type conversions using
   variables"demonstrates type conversions.

   Example 3.18. Type conversions using variables
set my_lines = "5"                # value is string "5"
set pager_index_lines = $my_lines # value is integer 5
set my_sort = "date-received"     # value is string "date-received"
set sort = "last-$my_sort"        # value is sort last-date-received
set my_inc = $read_inc            # value is string "10" (default of $read_inc)
set my_foo = $my_inc
          # value is string "10"

   These assignments are all valid. If, however, the value of $my_lines
   would have been "five"(or something else that cannot be parsed into a
   number), the assignment to $pager_index_lines would have produced an
   error message.

   Type conversion applies to all configuration commands which take
   arguments. But please note that every expanded value of a variable is
   considered just a single token. A working example is:
set my_pattern = "~A"
set my_number = "10"
# same as: score ~A +10
score $my_pattern +$my_number

   What does not work is:
set my_mx = "+mailbox1 +mailbox2"
mailboxes $my_mx +mailbox3

   because the value of $my_mx is interpreted as a single mailbox named
   "+mailbox1 +mailbox2" and not two distinct mailboxes.

27. Reading Initialization Commands From Another File

   Usage:

   source file ...

   This command allows the inclusion of initialization commands from other
   files. For example, I place all of my aliases in ~/.mail_aliases so
   that I can make my ~/.neomuttrc readable and keep my aliases private.

   If the filename begins with a tilde ( "~"), it will be expanded to the
   path of your home directory.

   If the filename ends with a vertical bar ( "|"), then filename is
   considered to be an executable program from which to read input (e.g.
   source~/bin/myscript|).

28. Removing Hooks

   Usage:

   unhook { * | hook-type }

   This command permits you to flush hooks you have previously defined.
   You can either remove all hooks by giving the "*"character as an
   argument, or you can remove all hooks of a specific type by saying
   something like unhook send-hook.

29. Format Strings

29.1. Basic usage

   Format strings are a general concept you'll find in several locations
   through the NeoMutt configuration, especially in the $index_format,
   $pager_format, $status_format, and other related variables. These can
   be very straightforward, and it's quite possible you already know how
   to use them.

   The most basic format string element is a percent symbol followed by
   another character. For example, %s represents a message's Subject:
   header in the $index_format variable. The "expandos" available are
   documented with each format variable, but there are general modifiers
   available with all formatting expandos, too. Those are our concern
   here.

   Some of the modifiers are borrowed right out of C (though you might
   know them from Perl, Python, shell, or another language). These are the
   [-]m.n modifiers, as in %-12.12s. As with such programming languages,
   these modifiers allow you to specify the minimum and maximum size of
   the resulting string, as well as its justification. If the "-"sign
   follows the percent, the string will be left-justified instead of
   right-justified. If there's a number immediately following that, it's
   the minimum amount of space the formatted string will occupy -- if it's
   naturally smaller than that, it will be padded out with spaces. If a
   decimal point and another number follow, that's the maximum space
   allowable -- the string will not be permitted to exceed that width, no
   matter its natural size. Each of these three elements is optional, so
   that all these are legal format strings: %-12s, %4c, %.15F and
   %-12.15L.

   NeoMutt adds some other modifiers to format strings. If you use an
   equals symbol ( =) as a numeric prefix (like the minus above), it will
   force the string to be centered within its minimum space range. For
   example, %=14y will reserve 14 characters for the %y expansion --
   that's the set of message keywords (formerly X-Label). If the expansion
   results in a string less than 14 characters, it will be centered in a
   14-character space. If the X-Label for a message were "test", that
   expansion would look like "      test     ".

   There are two very little-known modifiers that affect the way that an
   expando is replaced. If there is an underline ( "_") character between
   any format modifiers (as above) and the expando letter, it will expands
   in all lower case. And if you use a colon ( ":"), it will replace all
   decimal points with underlines.

29.2. Conditionals

   Depending on the format string variable, some of its sequences can be
   used to optionally print a string if their value is nonzero. For
   example, you may only want to see the number of flagged messages if
   such messages exist, since zero is not particularly meaningful. To
   optionally print a string based upon one of the above sequences, the
   following construct is used:
%?<sequence_char>?<optional_string>?

   where sequence_char is an expando, and optional_string is the string
   you would like printed if sequence_char is nonzero. optional_string may
   contain other sequences as well as normal text, but you may not nest
   optional strings.

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

   You can also switch between two strings using the following construct:
%?<sequence_char>?<if_string>&<else_string>?

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

   The conditional sequences can also be nested by using the %< and >
   operators. The %? notation can still be used but requires quoting. For
   example:
%<x?true&false>
%<x?%<y?%<z?xyz&xy>&x>&none>

   For more examples, see Section 24, "Nested If Feature"

29.3. Filters

   Any format string ending in a vertical bar ( "|") will be expanded and
   piped through the first word in the string, using spaces as separator.
   The string returned will be used for display. If the returned string
   ends in %, it will be passed through the formatter a second time. This
   allows the filter to generate a replacement format string including %
   expandos.

   All % expandos in a format string are expanded before the script is
   called so that:

   Example 3.19. Using external filters in format strings
set status_format="script.sh '%r %f (%L)'|"

   will make NeoMutt expand %r, %f and %L before calling the script. The
   example also shows that arguments can be quoted: the script will
   receive the expanded string between the single quotes as the only
   argument.

   A practical example is the mutt_xtitle script installed in the samples
   subdirectory of the NeoMutt documentation: it can be used as filter for
   $status_format to set the current terminal's title, if supported.

29.4. Padding

   In most format strings, NeoMutt supports different types of padding
   using special %-expandos:

   %|X
          When this occurs, NeoMutt will fill the rest of the line with
          the character X. For example, filling the rest of the line with
          dashes is done by setting:

set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"

   %>X
          Since the previous expando stops at the end of line, there must
          be a way to fill the gap between two items via the %>X expando:
          it puts as many characters X in between two items so that the
          rest of the line will be right-justified. For example, to not
          put the version string and hostname the above example on the
          left but on the right and fill the gap with spaces, one might
          use (note the space after %>):

set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"

   %*X
          Normal right-justification will print everything to the left of
          the %>, displaying padding and whatever lies to the right only
          if there's room. By contrast, "soft-fill" gives priority to the
          right-hand side, guaranteeing space to display it and showing
          padding only if there's still room. If necessary, soft-fill will
          eat text leftwards to make room for rightward text. For example,
          to right-justify the subject making sure as much as possible of
          it fits on screen, one might use (note two spaces after %*: the
          second ensures there's a space between the truncated right-hand
          side and the subject):

set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%*  %s"

29.5. Conditional Dates

   This feature allows the format of dates in the index to vary based on
   how recent the message is. This is especially useful in combination
   with the nested-if feature.

   For example, using %<[y?%<[d?%[%H:%M]&%[%m/%d]>&%[%y.%m]>for the date
   in the $index_format will produce a display like:
   1   + 14.12 Grace Hall      (   13) Gulliver's Travels
   2   + 10/02 Callum Harrison (   48) Huckleberry Finn
   3     12:17 Rhys Lee        (   42) The Lord Of The Rings

30. Control allowed header fields in a mailto: URL

   Usage:

   mailto_allow { * | header-field ... }
   unmailto_allow { * | header-field ... }

   As a security measure, NeoMutt will only add user-approved header
   fields from a mailto:URL. This is necessary since NeoMutt will handle
   certain header fields, such as Attach:, in a special way. The
   mailto_allow and unmailto_allow commands allow the user to modify the
   list of approved headers.

   NeoMutt initializes the default list to contain only the Subject and
   Body header fields, which are the only requirement specified by the
   mailto:specification in RFC2368, and the Cc, In-Reply-To, References
   headers to aid with replies to mailing lists.

Chapter 4. Advanced Usage

   Table of Contents

   1. Character Set Handling
   2. Regular Expressions
   3. Patterns: Searching, Limiting and Tagging

        3.1. Pattern Modifier
        3.2. Simple Searches
        3.3. Nesting and Boolean Operators
        3.4. Searching by Date
        3.5. GMail Patterns

   4. Marking Messages
   5. Using Tags
   6. Using Hooks

        6.1. Message Matching in Hooks
        6.2. Mailbox Matching in Hooks

   7. Managing the Environment
   8. External Address Queries
   9. Mailbox Formats
   10. Mailbox Shortcuts
   11. Handling Mailing Lists
   12. Display Munging
   13. New Mail Detection

        13.1. How New Mail Detection Works
        13.2. Polling For New Mail
        13.3. Calculating Mailbox Message Counts

   14. Editing Threads

        14.1. Linking Threads
        14.2. Breaking Threads

   15. Delivery Status Notification (DSN) Support
   16. Start a WWW Browser on URLs
   17. Miscellany

1. Character Set Handling

   A "character set" is basically a mapping between bytes and glyphs and
   implies a certain character encoding scheme. For example, for the ISO
   8859 family of character sets, an encoding of 8bit per character is
   used. For the Unicode character set, different character encodings may
   be used, UTF-8 being the most popular. In UTF-8, a character is
   represented using a variable number of bytes ranging from 1 to 4.

   Since NeoMutt is a command-line tool run from a shell, and delegates
   certain tasks to external tools (such as an editor for
   composing/editing messages), all of these tools need to agree on a
   character set and encoding. There exists no way to reliably deduce the
   character set a plain text file has. Interoperability is gained by the
   use of well-defined environment variables. The full set can be printed
   by issuing locale on the command line.

   Upon startup, NeoMutt determines the character set on its own using
   routines that inspect locale-specific environment variables. Therefore,
   it is generally not necessary to set the $charset variable in NeoMutt.
   It may even be counter-productive as NeoMutt uses system and library
   functions that derive the character set themselves and on which NeoMutt
   has no influence. It's safest to let NeoMutt work out the locale setup
   itself.

   If you happen to work with several character sets on a regular basis,
   it's highly advisable to use Unicode and an UTF-8 locale. Unicode can
   represent nearly all characters in a message at the same time. When not
   using a Unicode locale, it may happen that you receive messages with
   characters not representable in your locale. When displaying such a
   message, or replying to or forwarding it, information may get lost
   possibly rendering the message unusable (not only for you but also for
   the recipient, this breakage is not reversible as lost information
   cannot be guessed).

   A Unicode locale makes all conversions superfluous which eliminates the
   risk of conversion errors. It also eliminates potentially wrong
   expectations about the character set between NeoMutt and external
   programs.

   The terminal emulator used also must be properly configured for the
   current locale. Terminal emulators usually do not derive the locale
   from environment variables, they need to be configured separately. If
   the terminal is incorrectly configured, NeoMutt may display random and
   unexpected characters (question marks, octal codes, or just random
   glyphs), format strings may not work as expected, you may not be abled
   to enter non-ascii characters, and possible more. Data is always
   represented using bytes and so a correct setup is very important as to
   the machine, all character sets "look" the same.

   Warning: A mismatch between what system and library functions think the
   locale is and what NeoMutt was told what the locale is may make it
   behave badly with non-ascii input: it will fail at seemingly random
   places. This warning is to be taken seriously since not only local mail
   handling may suffer: sent messages may carry wrong character set
   information the receiver has too deal with. The need to set $charset
   directly in most cases points at terminal and environment variable
   setup problems, not NeoMutt problems.

   A list of officially assigned and known character sets can be found at
   IANA, a list of locally supported locales can be obtained by running
   locale -a.

2. Regular Expressions

   All string patterns in NeoMutt including those in more complex patterns
   must be specified using regular expressions (regex) in the "POSIX
   extended" syntax (which is more or less the syntax used by egrep and
   GNU awk). For your convenience, we have included below a brief
   description of this syntax.

   The search is case sensitive if the pattern contains at least one upper
   case letter, and case insensitive otherwise.

Note

   "\"must be quoted if used for a regular expression in an initialization
   command: "\\".

   A regular expression is a pattern that describes a set of strings.
   Regular expressions are constructed analogously to arithmetic
   expressions, by using various operators to combine smaller expressions.

Note

   The regular expression can be enclosed/delimited by either " or ' which
   is useful if the regular expression includes a white-space character.
   See Syntax of Initialization Filesfor more information on " and '
   delimiter processing. To match a literal " or ' you must preface it
   with \ (backslash).

   The fundamental building blocks are the regular expressions that match
   a single character. Most characters, including all letters and digits,
   are regular expressions that match themselves. Any metacharacter with
   special meaning may be quoted by preceding it with a backslash.

   The period "."matches any single character. The caret "^"and the dollar
   sign "$"are metacharacters that respectively match the empty string at
   the beginning and end of a line.

   A list of characters enclosed by "["and "]"matches any single character
   in that list; if the first character of the list is a caret "^"then it
   matches any character not in the list. For example, the regular
   expression [0123456789]matches any single digit. A range of ASCII
   characters may be specified by giving the first and last characters,
   separated by a hyphen "-". Most metacharacters lose their special
   meaning inside lists. To include a literal "]"place it first in the
   list. Similarly, to include a literal "^"place it anywhere but first.
   Finally, to include a literal hyphen "-"place it last.

   Certain named classes of characters are predefined. Character classes
   consist of "[:", a keyword denoting the class, and ":]". The following
   classes are defined by the POSIX standard in Table 4.1, "POSIX regular
   expression character classes"

   Table 4.1. POSIX regular expression character classes
   Character class Description
   [:alnum:] Alphanumeric characters
   [:alpha:] Alphabetic characters
   [:blank:] Space or tab characters
   [:cntrl:] Control characters
   [:digit:] Numeric characters
   [:graph:] Characters that are both printable and visible. (A space is
   printable, but not visible, while an "a" is both)
   [:lower:] Lower-case alphabetic characters
   [:print:] Printable characters (characters that are not control
   characters)
   [:punct:] Punctuation characters (characters that are not letter,
   digits, control characters, or space characters)
   [:space:] Space characters (such as space, tab and formfeed, to name a
   few)
   [:upper:] Upper-case alphabetic characters
   [:xdigit:] Characters that are hexadecimal digits

   A character class is only valid in a regular expression inside the
   brackets of a character list.

Note

   Note that the brackets in these class names are part of the symbolic
   names, and must be included in addition to the brackets delimiting the
   bracket list. For example, [[:digit:]]is equivalent to [0-9].

   Two additional special sequences can appear in character lists. These
   apply to non-ASCII character sets, which can have single symbols
   (called collating elements) that are represented with more than one
   character, as well as several characters that are equivalent for
   collating or sorting purposes:

   Collating Symbols
          A collating symbol is a multi-character collating element
          enclosed in "[."and ".]". For example, if "ch" is a collating
          element, then [[.ch.]]is a regex that matches this collating
          element, while [ch]is a regex that matches either "c" or "h".

   Equivalence Classes
          An equivalence class is a locale-specific name for a list of
          characters that are equivalent. The name is enclosed in "[="and
          "=]". For example, the name "e" might be used to represent all
          of "e" with grave ( "e"), "e" with acute ( "e") and "e". In this
          case, [[=e=]]is a regex that matches any of: "e" with grave (
          "e"), "e" with acute ( "e") and "e".

   A regular expression matching a single character may be followed by one
   of several repetition operators described in Table 4.2, "Regular
   expression repetition operators".

   Table 4.2. Regular expression repetition operators
   Operator Description
   ? The preceding item is optional and matched at most once
   * The preceding item will be matched zero or more times
   + The preceding item will be matched one or more times
   {n} The preceding item is matched exactly n times
   {n,} The preceding item is matched n or more times
   {,m} The preceding item is matched at most m times
   {n,m} The preceding item is matched at least n times, but no more than
   m times

   Two regular expressions may be concatenated; the resulting regular
   expression matches any string formed by concatenating two substrings
   that respectively match the concatenated subexpressions.

   Two regular expressions may be joined by the infix operator "|"; the
   resulting regular expression matches any string matching either
   subexpression.

   Repetition takes precedence over concatenation, which in turn takes
   precedence over alternation. A whole subexpression may be enclosed in
   parentheses to override these precedence rules.

Note

   If you compile NeoMutt with the included regular expression engine, the
   following operators may also be used in regular expressions as
   described in Table 4.3, "GNU regular expression extensions".

   Table 4.3. GNU regular expression extensions
   Expression Description
   \\y Matches the empty string at either the beginning or the end of a
   word
   \\B Matches the empty string within a word
   \\< Matches the empty string at the beginning of a word
   \\> Matches the empty string at the end of a word
   \\w Matches any word-constituent character (letter, digit, or
   underscore)
   \\W Matches any character that is not word-constituent
   \\` Matches the empty string at the beginning of a buffer (string)
   \\' Matches the empty string at the end of a buffer

   Please note however that these operators are not defined by POSIX, so
   they may or may not be available in stock libraries on various systems.

3. Patterns: Searching, Limiting and Tagging

3.1. Pattern Modifier

   Many of NeoMutt's commands allow you to specify a pattern to match (
   limit, tag-pattern, delete-pattern, etc.). Table 4.4, "Pattern
   modifiers"shows several ways to select messages.

   Table 4.4. Pattern modifiers
   Pattern modifier Description
   ~A all messages
   ~b EXPR messages which contain EXPR in the message body
   =b STRING messages which contain STRING in the message body. If IMAP is
   enabled, searches for STRING on the server, rather than downloading
   each message and searching it locally.
   ~B EXPR messages which contain EXPR in the whole message
   =B STRING messages which contain STRING in the whole message. If IMAP
   is enabled, searches for STRING on the server, rather than downloading
   each message and searching it locally.
   ~c EXPR messages carbon-copied to EXPR
   %c GROUP messages carbon-copied to any member of GROUP
   ~C EXPR messages either to: or cc: EXPR
   %C GROUP messages either to: or cc: to any member of GROUP
   ~d [ MIN]-[ MAX] messages with "date-sent" in a Date range
   ~D deleted messages
   ~e EXPR messages which contains EXPR in the "Sender" field
   %e GROUP messages which contain a member of GROUP in the "Sender" field
   ~E expired messages
   ~F flagged messages
   ~f EXPR messages originating from EXPR
   %f GROUP messages originating from any member of GROUP
   ~g cryptographically signed messages
   ~G cryptographically encrypted messages
   ~h EXPR messages which contain EXPR in the message header
   =h STRING messages which contain STRING in the message header. If IMAP
   is enabled, searches for STRING on the server, rather than downloading
   each message and searching it locally; STRING must be of the form
   "header: substring"(see below).
   ~H EXPR messages with a spam attribute matching EXPR
   ~i EXPR messages which match EXPR in the "Message-ID" field
   ~k messages which contain PGP key material
   ~L EXPR messages either originated or received by EXPR
   %L GROUP message either originated or received by any member of GROUP
   ~l messages addressed to a known mailing list
   ~m [ MIN]-[ MAX] messages with numbers in the range MIN to MAX***)
   ~m <[ MAX] messages with numbers less than MAX***)
   ~m >[ MIN] messages with numbers greater than MIN***)
   ~m [ M] just message number M***)
   ~m [ MIN],[ MAX] messages with offsets (from selected message) in the
   range MIN to MAX***)
   ~n [ MIN]-[ MAX] messages with a score in the range MIN to MAX*)
   ~N new messages
   ~O old messages
   ~p messages addressed to you (consults alternates)
   ~P messages from you (consults alternates)
   ~Q messages which have been replied to
   ~r [ MIN]-[ MAX] messages with "date-received" in a Date range
   ~R read messages
   ~s EXPR messages having EXPR in the "Subject" field.
   ~S superseded messages
   ~t EXPR messages addressed to EXPR
   ~T tagged messages
   ~u messages addressed to a subscribed mailing list
   ~U unread messages
   ~v messages part of a collapsed thread.
   ~V cryptographically verified messages
   ~x EXPR messages which contain EXPR in the "References" or
   "In-Reply-To" field
   ~X [ MIN]-[ MAX] messages with MIN to MAX attachments *)
   ~y EXPR messages which contain EXPR in their keywords
   ~z [ MIN]-[ MAX] messages with a size in the range MIN to MAX*) **)
   =/ STRING IMAP custom server-side search for STRING. Currently only
   defined for Gmail. See: GMail Patterns
   ~= duplicated messages (see $duplicate_threads)
   ~# broken threads (see $strict_threads)
   ~$ unreferenced messages (requires threaded view)
   ~( PATTERN) messages in threads containing messages matching PATTERN,
   e.g. all threads containing messages from you: ~(~P)
   ~<( PATTERN) messages whose immediate parent matches PATTERN, e.g.
   replies to your messages: ~<(~P)
   ~>( PATTERN) messages having an immediate child matching PATTERN, e.g.
   messages you replied to: ~>(~P)

   Where EXPR is a regular expression, and GROUP is an address group.

   *) The forms "<[ MAX]", ">[ MIN]", "[ MIN]-"and "-[ MAX]"are allowed,
   too.

   **) The suffixes "K" and "M" are allowed to specify kilobyte and
   megabyte respectively.

   ***) The message number ranges (introduced by ~m) are even more general
   and powerful than the other types of ranges. Read on and see
   Section 3.1.1, "Message Ranges"below.

   Special attention has to be paid when using regular expressions inside
   of patterns. Specifically, NeoMutt's parser for these patterns will
   strip one level of backslash ( "\"), which is normally used for
   quoting. If it is your intention to use a backslash in the regular
   expression, you will need to use two backslashes instead ( "\\"). You
   can force NeoMutt to treat EXPR as a simple substring instead of a
   regular expression by using = instead of ~ in the pattern name. For
   example, =b *.*will find all messages that contain the literal string
   "*.*". Simple string matches are less powerful than regular expressions
   but can be considerably faster. This is especially true for IMAP
   folders, because string matches can be performed on the server instead
   of by fetching every message. IMAP treats =h specially: it must be of
   the form "header: substring" and will not partially match header names.
   The substring part may be omitted if you simply wish to find messages
   containing a particular header without regard to its value.

   Patterns matching lists of addresses (notably c, C, p, P and t) match
   if there is at least one match in the whole list. If you want to make
   sure that all elements of that list match, you need to prefix your
   pattern with "^". This example matches all mails which only has
   recipients from Germany.

   Example 4.1. Matching all addresses in address lists
^~C \.de$

   You can restrict address pattern matching to aliases that you have
   defined with the "@" modifier. This example matches messages whose
   recipients are all from Germany, and who are known to your alias list.

   Example 4.2. Matching restricted to aliases
^@~C \.de$

   To match any defined alias, use a regular expression that matches any
   string. This example matches messages whose senders are known aliases.

   Example 4.3. Matching any defined alias
@~f .

3.1.1. Message Ranges

   If a message number range (from now on: MNR) contains a comma ( ,), it
   is a relative MNR. That means the numbers denote offsets from the
   highlighted message. For example:

   Table 4.5. Relative Message Number Ranges
   Pattern                Explanation
   ~m -2,2 Previous 2, highlighted and next 2 emails
   ~m 0,1  Highlighted and next email

   In addition to numbers, either side of the range can also contain one
   of the special characters (shortcuts) .^$. The meaning is:

   Table 4.6. Message Number Shortcuts
   Shortcut Explanation Example Meaning
   . Current / Highlighted ~m -3,. Previous 3 emails plus the highlighted
   one
   $ Last ~m .,$ Highlighted email and all the later ones
   ^ First ~m ^,1 Highlighted, next and all preceding ones

   Lastly, you can also leave either side of the range blank, to make it
   extend as far as possible. For example, ~m ,1 has the same meaning as
   the last example in Table 4.6, "Message Number Shortcuts".

   Otherwise, if a MNR doesn't contain a comma, the meaning is similar to
   other ranges, except that the shortcuts are still available. Examples:

   Table 4.7. Absolute Message Number Ranges
   Pattern        Explanation
   ~m 3-10 Emails 3 to 10
   ~m -10  Emails 1 to 10
   ~m 10-  Emails 10 to last
   ~m <3   First and second email
   ~m ^-2  First and second email
   ~m >1   Everything but first email
   ~m 2-$  Everything but first email
   ~m 2    Just the second email

3.2. Simple Searches

   NeoMutt supports two versions of so called "simple searches". These are
   issued if the query entered for searching, limiting and similar
   operations does not seem to contain a valid pattern modifier (i.e. it
   does not contain one of these characters: "~", "="or "%"). If the query
   is supposed to contain one of these special characters, they must be
   escaped by prepending a backslash ( "\").

   The first type is by checking whether the query string equals a keyword
   case-insensitively from Table 4.8, "Simple search keywords": If that is
   the case, NeoMutt will use the shown pattern modifier instead. If a
   keyword would conflict with your search keyword, you need to turn it
   into a regular expression to avoid matching the keyword table. For
   example, if you want to find all messages matching "flag"(using
   $simple_search) but don't want to match flagged messages, simply search
   for " [f]lag ".

   Table 4.8. Simple search keywords
   Keyword Pattern modifier
   all     ~A
   .       ~A
   ^       ~A
   del     ~D
   flag    ~F
   new     ~N
   old     ~O
   repl    ~Q
   read    ~R
   tag     ~T
   unread  ~U

   The second type of simple search is to build a complex search pattern
   using $simple_search as a template. NeoMutt will insert your query
   properly quoted and search for the composed complex query.

3.3. Nesting and Boolean Operators

   Logical AND is performed by specifying more than one criterion. For
   example:
~t work ~f elkins

   would select messages which contain the word "work" in the list of
   recipients and that have the word "elkins" in the "From" header field.

   NeoMutt also recognizes the following operators to create more complex
   search patterns:
     * ! -- logical NOT operator
     * | -- logical OR operator
     * () -- logical grouping operator

   Here is an example illustrating a complex search pattern. This pattern
   will select all messages which do not contain "work" in the "To" or
   "Cc" field and which are from "elkins".

   Example 4.4. Using boolean operators in patterns
!(~t work|~c work) ~f elkins

   Here is an example using white space in the regular expression (note
   the "'"and """delimiters). For this to match, the mail's subject must
   match the "^Junk +From +Me$"and it must be from either "Jim +Somebody"
   or "Ed +SomeoneElse":
'~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'

Note

   If a regular expression contains parenthesis, or a vertical bar ("|"),
   you must enclose the expression in double or single quotes since those
   characters are also used to separate different parts of NeoMutt's
   pattern language. For example: ~f "user@(home\.org|work\.com)"Without
   the quotes, the parenthesis wouldn't end. This would be separated to
   two OR'd patterns: ~f user@(home\.org and work\.com). They are never
   what you want.

3.4. Searching by Date

   NeoMutt supports two types of dates, absolute and relative.

3.4.1. Absolute Dates

   Dates must be in DD/MM/YY format (month and year are optional,
   defaulting to the current month and year). An example of a valid range
   of dates is:
Limit to messages matching: ~d 20/1/95-31/10

   If you omit the minimum (first) date, and just specify "-DD/MM/YY", all
   messages before the given date will be selected. If you omit the
   maximum (second) date, and specify "DD/MM/YY-", all messages after the
   given date will be selected. If you specify a single date with no dash
   ( "-"), only messages sent on the given date will be selected.

   You can add error margins to absolute dates. An error margin is a sign
   (+ or -), followed by a digit, followed by one of the units in
   Table 4.9, "Date units". As a special case, you can replace the sign by
   a "*"character, which is equivalent to giving identical plus and minus
   error margins.

   Table 4.9. Date units
   Unit Description
   y    Years
   m    Months
   w    Weeks
   d    Days

   Example: To select any messages two weeks around January 15, 2001,
   you'd use the following pattern:
Limit to messages matching: ~d 15/1/2001*2w

3.4.2. Relative Dates

   This type of date is relative to the current date, and may be specified
   as:
     * > offset for messages older than offset units
     * < offset for messages newer than offset units
     * = offset for messages exactly offset units old

   offset is specified as a positive number with one of the units from
   Table 4.9, "Date units".

   Example: to select messages less than 1 month old, you would use
Limit to messages matching: ~d <1m

Note

   All dates used when searching are relative to the local time zone, so
   unless you change the setting of your $index_format to include a
   %[...]format, these are not the dates shown in the main index.

3.5. GMail Patterns

   =/ "search terms" invokes server-side search, passing along the search
   terms provided. Search results are constrained by IMAP to be within the
   current folder. At present this only supports Gmail's search API IMAP
   extension. The search language is entirely up to the mail provider and
   changes at their discretion. Using ~/ will silently fail.

   For up-to-date information about searching, see: GMail's Support Page.
   You will need to (once) use a web-browser to visit Settings/Labels and
   enable "Show in IMAP" for "All Mail". When searching, visit that folder
   in NeoMutt to most closely match Gmail search semantics.

   Table 4.10. GMail Example Patterns
   Pattern Matches
   =/ "list:foo.example.org has:attachment is:important" the
   foo.example.org mailing-list per Gmail's definitions, and has an
   attachment, and has been marked as important
   =/ "{has:purple-star has:yellow-star} older_than:2m" is older than two
   months and has either a purple-star or a yellow-star

4. Marking Messages

   There are times that it's useful to ask NeoMutt to "remember" which
   message you're currently looking at, while you move elsewhere in your
   mailbox. You can do this with the "mark-message" operator, which is
   bound to the "~"key by default. Press this key to enter an identifier
   for the marked message. When you want to return to this message, press
   "'"and the name that you previously entered.

   (Message marking is really just a shortcut for defining a macro that
   returns you to the current message by searching for its Message-ID. You
   can choose a different prefix by setting the $mark_macro_prefix
   variable.)

5. Using Tags

   Sometimes it is desirable to perform an operation on a group of
   messages all at once rather than one at a time. An example might be to
   save messages to a mailing list to a separate folder, or to delete all
   messages with a given subject. To tag all messages matching a pattern,
   use the <tag-pattern>function, which is bound to "shift-T" by default.
   Or you can select individual messages by hand using the
   <tag-message>function, which is bound to "t" by default. See patterns
   for NeoMutt's pattern matching syntax.

   Once you have tagged the desired messages, you can use the "tag-prefix"
   operator, which is the ";"(semicolon) key by default. When the
   "tag-prefix" operator is used, the next operation will be applied to
   all tagged messages if that operation can be used in that manner. If
   the $auto_tag variable is set, the next operation applies to the tagged
   messages automatically, without requiring the "tag-prefix".

   In macrosor push commands, you can use the <tag-prefix-cond>operator.
   If there are no tagged messages, NeoMutt will "eat" the rest of the
   macro to abort it's execution. NeoMutt will stop "eating" the macro
   when it encounters the <end-cond>operator; after this operator the rest
   of the macro will be executed as normal.

6. Using Hooks

   A hook is a concept found in many other programs which allows you to
   execute arbitrary commands before performing some operation. For
   example, you may wish to tailor your configuration based upon which
   mailbox you are reading, or to whom you are sending mail. In the
   NeoMutt world, a hook consists of a regular expression or pattern along
   with a configuration option/command. See:
     * account-hook
     * append-hook
     * charset-hook
     * close-hook
     * crypt-hook
     * fcc-hook
     * fcc-save-hook
     * folder-hook
     * iconv-hook
     * mbox-hook
     * message-hook
     * open-hook
     * reply-hook
     * save-hook
     * send-hook
     * send2-hook

   for specific details on each type of hook available.

Note

   If a hook changes configuration settings, these changes remain
   effective until the end of the current NeoMutt session. As this is
   generally not desired, a "default" hook needs to be added before all
   other hooks of that type to restore configuration defaults.

   Example 4.5. Specifying a "default" hook
send-hook . 'unmy_hdr From:'
send-hook ~C'^b@b\.b$' my_hdr from: c@c.c

   In Example 4.5, "Specifying a "default" hook", by default the value of
   $from and $realname is not overridden. When sending messages either To:
   or Cc: to <b@b.b>, the From: header is changed to <c@c.c>.

6.1. Message Matching in Hooks

   Hooks that act upon messages ( message-hook, reply-hook, send-hook,
   send2-hook, save-hook, fcc-hook) are evaluated in a slightly different
   manner. For the other types of hooks, a regular expression is
   sufficient. But in dealing with messages a finer grain of control is
   needed for matching since for different purposes you want to match
   different criteria.

   NeoMutt allows the use of the search pattern language for matching
   messages in hook commands. This works in exactly the same way as it
   would when limiting or searching the mailbox, except that you are
   restricted to those operators which match information NeoMutt extracts
   from the header of the message (i.e., from, to, cc, date, subject,
   etc.).

   For example, if you wanted to set your return address based upon
   sending mail to a specific address, you could do something like:
send-hook '~t ^user@work\.com$' 'my_hdr From: John Smith <user@host>'

   which would execute the given command when sending mail to
   user@work.com.

   However, it is not required that you write the pattern to match using
   the full searching language. You can still specify a simple regular
   expression like the other hooks, in which case NeoMutt will translate
   your pattern into the full language, using the translation specified by
   the $default_hook variable. The pattern is translated at the time the
   hook is declared, so the value of $default_hook that is in effect at
   that time will be used.

6.2. Mailbox Matching in Hooks

   Hooks that match against mailboxes ( folder-hook, mbox-hook) apply both
   regular expression syntax as well as mailbox shortcut expansion on the
   regex parameter. There is some overlap between these, so special
   attention should be paid to the first character of the regex.
# Here, ^ will expand to "the current mailbox" not "beginning of string":
folder-hook ^/home/user/Mail/bar "set sort=threads"
# If you want ^ to be interpreted as "beginning of string", one workaround
# is to enclose the regex in parenthesis:
folder-hook (^/home/user/Mail/bar) "set sort=threads"
# This will expand to the default save folder for the alias "imap.example.com",
which
# is probably not what you want:
folder-hook @imap.example.com "set sort=threads"
# A workaround is to use parenthesis or a backslash:
folder-hook (@imap.example.com) "set sort=threads"
folder-hook '\@imap.example.com' "set sort=threads"

   Keep in mind that mailbox shortcut expansion on the regex parameter
   takes place when the hook is initially parsed, not when the hook is
   matching against a mailbox. When NeoMutt starts up and is reading the
   .neomuttrc, some mailbox shortcuts may not be usable. For example, the
   "current mailbox" shortcut, ^, will expand to an empty string because
   no mailbox has been opened yet. NeoMutt will issue an error for this
   case or if the mailbox shortcut results in an empty regex.

7. Managing the Environment

   You can alter the environment that NeoMutt passes on to its child
   processes using the "setenv" and "unsetenv" operators. (N.B. These
   follow NeoMutt-style syntax, not shell-style!) You can also query
   current environment values by prefixing a "?"character.
setenv TERM vt100
setenv ORGANIZATION "The NeoMutt Development Team"
unsetenv DISPLAY
setenv ?LESS

8. External Address Queries

   NeoMutt supports connecting to external directory databases such as
   LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to
   NeoMutt using a simple interface. Using the $query_command variable,
   you specify the wrapper command to use. For example:
set query_command = "mutt_ldap_query.pl %s"

   The wrapper script should accept the query on the command-line. It
   should return a one line message, then each matching response on a
   single line, each line containing a tab separated address then name
   then some other optional information. On error, or if there are no
   matching addresses, return a non-zero exit code and a one line error
   message.

   An example multiple response output:
Searching database ... 20 entries ... 3 matching:
me@cs.hmc.edu           Michael Elkins  mutt dude
blong@fiction.net       Brandon Long    mutt and more
roessler@does-not-exist.org        Thomas Roessler mutt pgp

   There are two mechanisms for accessing the query function of NeoMutt.
   One is to do a query from the index menu using the <query>function
   (default: Q). This will prompt for a query, then bring up the query
   menu which will list the matching responses. From the query menu, you
   can select addresses to create aliases, or to mail. You can tag
   multiple addresses to mail, start a new query, or have a new query
   appended to the current responses.

   The other mechanism for accessing the query function is for address
   completion, similar to the alias completion. In any prompt for address
   entry, you can use the <complete-query>function (default: ^T) to run a
   query based on the current address you have typed. Like aliases,
   NeoMutt will look for what you have typed back to the last space or
   comma. If there is a single response for that query, NeoMutt will
   expand the address in place. If there are multiple responses, NeoMutt
   will activate the query menu. At the query menu, you can select one or
   more addresses to be added to the prompt.

9. Mailbox Formats

   NeoMutt supports reading and writing of four different local mailbox
   formats: mbox, MMDF, MH and Maildir. The mailbox type is auto detected,
   so there is no need to use a flag for different mailbox types. When
   creating new mailboxes, NeoMutt uses the default specified with the
   $mbox_type variable. A short description of the formats follows.

   mbox. This is a widely used mailbox format for UNIX. All messages are
   stored in a single file. Each message has a line of the form:
From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST

   to denote the start of a new message (this is often referred to as the
   "From_" line). The mbox format requires mailbox locking, is prone to
   mailbox corruption with concurrently writing clients or misinterpreted
   From_ lines. Depending on the environment, new mail detection can be
   unreliable. Mbox folders are fast to open and easy to archive.

   MMDF. This is a variant of the mbox format. Each message is surrounded
   by lines containing "^A^A^A^A"(four times control-A's). The same
   problems as for mbox apply (also with finding the right message
   separator as four control-A's may appear in message bodies).

   MH. A radical departure from mbox and MMDF, a mailbox consists of a
   directory and each message is stored in a separate file. The filename
   indicates the message number (however, this is may not correspond to
   the message number NeoMutt displays). Deleted messages are renamed with
   a comma ( ",") prepended to the filename. NeoMutt detects this type of
   mailbox by looking for either .mh_sequences or .xmhcache files (needed
   to distinguish normal directories from MH mailboxes). MH is more robust
   with concurrent clients writing the mailbox, but still may suffer from
   lost flags; message corruption is less likely to occur than with
   mbox/mmdf. It's usually slower to open compared to mbox/mmdf since many
   small files have to be read (NeoMutt provides Section 7.1, "Header
   Caching"to greatly speed this process up). Depending on the
   environment, MH is not very disk-space efficient.

   Maildir. The newest of the mailbox formats, used by the Qmail MTA (a
   replacement for sendmail). Similar to MH, except that it adds three
   subdirectories of the mailbox: tmp, new and cur. Filenames for the
   messages are chosen in such a way they are unique, even when two
   programs are writing the mailbox over NFS, which means that no file
   locking is needed and corruption is very unlikely. Maildir maybe slower
   to open without caching in NeoMutt, it too is not very disk-space
   efficient depending on the environment. Since no additional files are
   used for metadata (which is embedded in the message filenames) and
   Maildir is locking-free, it's easy to sync across different machines
   using file-level synchronization tools.

10. Mailbox Shortcuts

   There are a number of built in shortcuts which refer to specific
   mailboxes. These shortcuts can be used anywhere you are prompted for a
   file or mailbox path or in path-related configuration variables. Note
   that these only work at the beginning of a string.

   Table 4.11. Mailbox shortcuts
   Shortcut Refers to...
   ! your $spoolfile(incoming) mailbox
   > your $mbox file
   < your $record file
   ^ the current mailbox
   -or !! the file you've last visited
   ~ your home directory
   =or + your $folder directory
   @alias to the default save folder as determined by the address of the
   alias

   For example, to store a copy of outgoing messages in the folder they
   were composed in, a folder-hook can be used to set $record:
folder-hook . 'set record=^'

11. Handling Mailing Lists

   NeoMutt has a few configuration options that make dealing with large
   amounts of mail easier. The first thing you must do is to let NeoMutt
   know what addresses you consider to be mailing lists (technically this
   does not have to be a mailing list, but that is what it is most often
   used for), and what lists you are subscribed to. This is accomplished
   through the use of the lists and subscribecommands in your .neomuttrc.

   Now that NeoMutt knows what your mailing lists are, it can do several
   things, the first of which is the ability to show the name of a list
   through which you received a message (i.e., of a subscribed list) in
   the index menu display. This is useful to distinguish between personal
   and list mail in the same mailbox. In the $index_format variable, the
   expando "%L" will print the string "To <list>"when "list" appears in
   the "To" field, and "Cc <list>"when it appears in the "Cc" field
   (otherwise it prints the name of the author).

   Often times the "To" and "Cc" fields in mailing list messages tend to
   get quite large. Most people do not bother to remove the author of the
   message they reply to from the list, resulting in two or more copies
   being sent to that person. The <list-reply>function, which by default
   is bound to "L" in the index menu and pager, helps reduce the clutter
   by only replying to the known mailing list addresses instead of all
   recipients (except as specified by Mail-Followup-To, see below).

   NeoMutt also supports the Mail-Followup-To header. When you send a
   message to a list of recipients which includes one or several
   subscribed mailing lists, and if the $followup_to option is set,
   NeoMutt will generate a Mail-Followup-To header which contains all the
   recipients to whom you send this message, but not your address. This
   indicates that group-replies or list-replies (also known as
   "followups") to this message should only be sent to the original
   recipients of the message, and not separately to you - you'll receive
   your copy through one of the mailing lists you are subscribed to.

   Conversely, when group-replying or list-replying to a message which has
   a Mail-Followup-To header, NeoMutt will respect this header if the
   $honor_followup_to configuration variable is set. Using list-reply will
   in this case also make sure that the reply goes to the mailing list,
   even if it's not specified in the list of recipients in the
   Mail-Followup-To.

Note

   When header editing is enabled, you can create a Mail-Followup-To
   header manually. NeoMutt will only auto-generate this header if it
   doesn't exist when you send the message.

   The other method some mailing list admins use is to generate a
   "Reply-To" field which points back to the mailing list address rather
   than the author of the message. This can create problems when trying to
   reply directly to the author in private, since most mail clients will
   automatically reply to the address given in the "Reply-To" field.
   NeoMutt uses the $reply_to variable to help decide which address to
   use. If set to ask-yes or ask-no, you will be prompted as to whether or
   not you would like to use the address given in the "Reply-To" field, or
   reply directly to the address given in the "From" field. When set to
   yes, the "Reply-To" field will be used when present.

   You can change or delete the "X-Label:"field within NeoMutt using the
   "edit-label" command, bound to the "y" key by default. This works for
   tagged messages, too. While in the edit-label function, pressing the
   <complete> binding (TAB, by default) will perform completion against
   all labels currently in use.

   Lastly, NeoMutt has the ability to sort the mailbox into threads. A
   thread is a group of messages which all relate to the same subject.
   This is usually organized into a tree-like structure where a message
   and all of its replies are represented graphically. If you've ever used
   a threaded news client, this is the same concept. It makes dealing with
   large volume mailing lists easier because you can easily delete
   uninteresting threads and quickly find topics of value.

12. Display Munging

   Working within the confines of a console or terminal window, it is
   often useful to be able to modify certain information elements in a
   non-destructive way -- to change how they display, without changing the
   stored value of the information itself. This is especially so of
   message subjects, which may often be polluted with extraneous metadata
   that either is reproduced elsewhere, or is of secondary interest.

   subjectrx pattern replacement
   unsubjectrx { * | pattern }

   subjectrx specifies a regular expression "pattern" which, if detected
   in a message subject, causes the subject to be replaced with the
   "replacement" value. The replacement is subject to substitutions in the
   same way as for the spam command: %L for the text to the left of the
   match, %R for text to the right of the match, and %1 for the first
   subgroup in the match (etc). If you simply want to erase the match, set
   it to "%L%R". Any number of subjectrx commands may coexist.

   Note this well: the "replacement" value replaces the entire subject,
   not just the match!

   unsubjectrx removes a given subjectrx from the substitution list. If
   *is used as the pattern, all substitutions will be removed.

   Example 4.6. Subject Munging
# Erase [rt #12345] tags from Request Tracker (RT) e-mails
subjectrx '\[rt #[0-9]+\] *' '%L%R'
# Servicedesk is another RT that sends more complex subjects.

# Keep the ticket number.

subjectrx '\[servicedesk #([0-9]+)\] ([^.]+)\.([^.]+) - (new|open|pending|update
) - ' '%L[#%1] %R'
# Strip out annoying [listname] prefixes in subjects
subjectrx '\[[^\]]*\]:? *' '%L%R'

13. New Mail Detection

   NeoMutt supports setups with multiple folders, allowing all of them to
   be monitored for new mail (see Section 14, "Monitoring Incoming
   Mail"for details).

13.1. How New Mail Detection Works

   For Mbox and Mmdf folders, new mail is detected by comparing access
   and/or modification times of files: NeoMutt assumes a folder has new
   mail if it wasn't accessed after it was last modified. Utilities like
   biff or frm or any other program which accesses the mailbox might cause
   NeoMutt to never detect new mail for that mailbox if they do not
   properly reset the access time. Other possible causes of NeoMutt not
   detecting new mail in these folders are backup tools (updating access
   times) or filesystems mounted without access time update support (for
   Linux systems, see the relatime option).

Note

   Contrary to older NeoMutt releases, it now maintains the new mail
   status of a folder by properly resetting the access time if the folder
   contains at least one message which is neither read, nor deleted, nor
   marked as old.

   In cases where new mail detection for Mbox or Mmdf folders appears to
   be unreliable, the $check_mbox_size option can be used to make NeoMutt
   track and consult file sizes for new mail detection instead which won't
   work for size-neutral changes.

   New mail for Maildir is assumed if there is one message in the
   new/subdirectory which is not marked deleted (see $maildir_trash). For
   MH folders, a mailbox is considered having new mail if there's at least
   one message in the "unseen" sequence as specified by $mh_seq_unseen.
   Optionally, $new_mail_command can be configured to execute an external
   program every time new mail is detected in the current inbox.

   NeoMutt does not poll POP3 folders for new mail, it only periodically
   checks the currently opened folder (if it's a POP3 folder).

   For IMAP, by default NeoMutt uses recent message counts provided by the
   server to detect new mail. If the $imap_idle option is set, it'll use
   the IMAP IDLE extension if advertised by the server.

   The $mail_check_recent option changes whether NeoMutt will notify you
   of new mail in an already visited mailbox. When set (the default) it
   will only notify you of new mail received since the last time you
   opened the mailbox. When unset, NeoMutt will notify you of any new mail
   in the mailbox.

13.2. Polling For New Mail

   When in the index menu and being idle (also see $timeout), NeoMutt
   periodically checks for new mail in all folders which have been
   configured via the mailboxes command. The interval depends on the
   folder type: for local/IMAP folders it consults $mail_check and
   $pop_checkinterval for POP folders.

   Outside the index menu the directory browser supports checking for new
   mail using the <check-new>function which is unbound by default.
   Pressing TAB will bring up a menu showing the files specified by the
   mailboxes command, and indicate which contain new messages. NeoMutt
   will automatically enter this mode when invoked from the command line
   with the -y option.

   For the pager, index and directory browser menus, NeoMutt contains the
   <buffy-list>function (bound to "."by default) which will print a list
   of folders with new mail in the command line at the bottom of the
   screen.

   For the index, by default NeoMutt displays the number of mailboxes with
   new mail in the status bar, please refer to the $status_format variable
   for details.

   When changing folders, NeoMutt fills the prompt with the first folder
   from the mailboxes list containing new mail (if any), pressing
   <Space>will cycle through folders with new mail. The (by default
   unbound) function <next-unread-mailbox>in the index can be used to
   immediately open the next folder with unread mail (if any).

13.3. Calculating Mailbox Message Counts

   If $mail_check_stats is set, NeoMutt will periodically calculate the
   unread, flagged, and total message counts for each mailbox watched by
   the mailboxes command. This calculation takes place at the same time as
   new mail polling, but is controlled by a separate timer:
   $mail_check_stats_interval.

   The sidebar can display these message counts. See $sidebar_format.

14. Editing Threads

   NeoMutt has the ability to dynamically restructure threads that are
   broken either by misconfigured software or bad behavior from some
   correspondents. This allows to clean your mailboxes from these
   annoyances which make it hard to follow a discussion.

14.1. Linking Threads

   Some mailers tend to "forget" to correctly set the "In-Reply-To:"and
   "References:"headers when replying to a message. This results in broken
   discussions because NeoMutt has not enough information to guess the
   correct threading. You can fix this by tagging the reply, then moving
   to the parent message and using the <link-threads>function (bound to &
   by default). The reply will then be connected to this parent message.

   You can also connect multiple children at once, tagging them and using
   the <tag-prefix>command ( ";") or the $auto_tag option.

14.2. Breaking Threads

   On mailing lists, some people are in the bad habit of starting a new
   discussion by hitting "reply" to any message from the list and changing
   the subject to a totally unrelated one. You can fix such threads by
   using the <break-thread>function (bound by default to #), which will
   turn the subthread starting from the current message into a whole
   different thread.

15. Delivery Status Notification (DSN) Support

   RFC1894 defines a set of MIME content types for relaying information
   about the status of electronic mail messages. These can be thought of
   as "return receipts."

   To support DSN, there are two variables. $dsn_notify is used to request
   receipts for different results (such as failed message, message
   delivered, etc.). $dsn_return requests how much of your message should
   be returned with the receipt (headers or full message).

   When using $sendmail for mail delivery, you need to use either Berkeley
   sendmail 8.8.x (or greater) a MTA supporting DSN command line options
   compatible to Sendmail: The -N and -R options can be used by the mail
   client to make requests as to what type of status messages should be
   returned. Please consider your MTA documentation whether DSN is
   supported.

   For SMTP delivery using $smtp_url, it depends on the capabilities
   announced by the server whether NeoMutt will attempt to request DSN or
   not.

16. Start a WWW Browser on URLs

   If a message contains URLs, it is efficient to get a menu with all the
   URLs and start a WWW browser on one of them. This functionality is
   provided by the external urlview program which can be retrieved at
   ftp://ftp.mutt.org/mutt/contrib/and the configuration commands:
macro index \cb |urlview\n
macro pager \cb |urlview\n

17. Miscellany

   This section documents various features that fit nowhere else.

   Address normalization
          NeoMutt normalizes all e-mail addresses to the simplest form
          possible. If an address contains a realname, the form Joe User
          <joe@example.com>is used and the pure e-mail address without
          angle brackets otherwise, i.e. just joe@example.com.

          This normalization affects all headers NeoMutt generates
          including aliases.

   Initial folder selection
          The folder NeoMutt opens at startup is determined as follows:
          the folder specified in the $MAIL environment variable if
          present. Otherwise, the value of $MAILDIR is taken into account.
          If that isn't present either, NeoMutt takes the user's mailbox
          in the mailspool as determined at compile-time (which may also
          reside in the home directory). The $spoolfile setting overrides
          this selection. Highest priority has the mailbox given with the
          -f command line option.

Chapter 5. NeoMutt's MIME Support

   Table of Contents

   1. Using MIME in NeoMutt

        1.1. MIME Overview
        1.2. Viewing MIME Messages in the Pager
        1.3. The Attachment Menu
        1.4. The Compose Menu

   2. MIME Type Configuration with mime.types
   3. MIME Viewer Configuration with Mailcap

        3.1. The Basics of the Mailcap File
        3.2. Secure Use of Mailcap
        3.3. Advanced Mailcap Usage
        3.4. Example Mailcap Files

   4. MIME Autoview
   5. MIME Multipart/Alternative
   6. Attachment Searching and Counting
   7. MIME Lookup

   Quite a bit of effort has been made to make NeoMutt the premier
   text-mode MIME MUA. Every effort has been made to provide the
   functionality that the discerning MIME user requires, and the
   conformance to the standards wherever possible. When configuring
   NeoMutt for MIME, there are two extra types of configuration files
   which NeoMutt uses. One is the mime.types file, which contains the
   mapping of file extensions to IANA MIME types. The other is the mailcap
   file, which specifies the external commands to use for handling
   specific MIME types.

1. Using MIME in NeoMutt

1.1. MIME Overview

   MIME is short for "Multipurpose Internet Mail Extension" and describes
   mechanisms to internationalize and structure mail messages. Before the
   introduction of MIME, messages had a single text part and were limited
   to us-ascii header and content. With MIME, messages can have
   attachments (and even attachments which itself have attachments and
   thus form a tree structure), nearly arbitrary characters can be used
   for sender names, recipients and subjects.

   Besides the handling of non-ascii characters in message headers, to
   NeoMutt the most important aspect of MIME are so-called MIME types.
   These are constructed using a major and minor type separated by a
   forward slash. These specify details about the content that follows.
   Based upon these, NeoMutt decides how to handle this part. The most
   popular major type is " text "with minor types for plain text, HTML and
   various other formats. Major types also exist for images, audio, video
   and of course general application data (e.g. to separate
   cryptographically signed data with a signature, send office documents,
   and in general arbitrary binary data). There's also the multipart major
   type which represents the root of a subtree of MIME parts. A list of
   supported MIME types can be found in Table 5.1, "Supported MIME types".

   MIME also defines a set of encoding schemes for transporting MIME
   content over the network: 7bit, 8bit, quoted-printable, base64 and
   binary. There're some rules when to choose what for encoding headers
   and/or body (if needed), and NeoMutt will in general make a good
   choice.

   NeoMutt does most of MIME encoding/decoding behind the scenes to form
   messages conforming to MIME on the sending side. On reception, it can
   be flexibly configured as to how what MIME structure is displayed (and
   if it's displayed): these decisions are based on the content's MIME
   type. There are three areas/menus in dealing with MIME: the pager
   (while viewing a message), the attachment menu and the compose menu.

1.2. Viewing MIME Messages in the Pager

   When you select a message from the index and view it in the pager,
   NeoMutt decodes as much of a message as possible to a text
   representation. NeoMutt internally supports a number of MIME types,
   including the text major type (with all minor types), the
   message/rfc822(mail messages) type and some multipart types. In
   addition, it recognizes a variety of PGP MIME types, including PGP/MIME
   and application/pgp.

   NeoMutt will denote attachments with a couple lines describing them.
   These lines are of the form:
[-- Attachment #1: Description --]
[-- Type: text/plain, Encoding: 7bit, Size: 10000 --]

   Where the Description is the description or filename given for the
   attachment, and the Encoding is one of the already mentioned content
   encodings.

   If NeoMutt cannot deal with a MIME type, it will display a message
   like:
[-- image/gif is unsupported (use 'v' to view this part) --]

1.3. The Attachment Menu

   The default binding for <view-attachments>is "v", which displays the
   attachment menu for a message. The attachment menu displays a list of
   the attachments in a message. From the attachment menu, you can save,
   print, pipe, delete, and view attachments. You can apply these
   operations to a group of attachments at once, by tagging the
   attachments and by using the <tag-prefix>operator. You can also reply
   to the current message from this menu, and only the current attachment
   (or the attachments tagged) will be quoted in your reply. You can view
   attachments as text, or view them using the mailcap viewer definition
   (the mailcap mechanism is explained later in detail).

   Finally, you can apply the usual message-related functions (like
   <resend-message> , and the <reply>and <forward>functions) to
   attachments of type message/rfc822.

   See table Table 9.7, "Default Attachment Menu Bindings"for all
   available functions.

1.4. The Compose Menu

   The compose menu is the menu you see before you send a message. It
   allows you to edit the recipient list, the subject, and other aspects
   of your message. It also contains a list of the attachments of your
   message, including the main body. From this menu, you can print, copy,
   filter, pipe, edit, compose, review, and rename an attachment or a list
   of tagged attachments. You can also modifying the attachment
   information, notably the type, encoding and description.

   Attachments appear as follows by default:
- 1 [text/plain, 7bit, 1K]           /tmp/neomutt-euler-8082-0 <no description>
  2 [applica/x-gunzip, base64, 422K] ~/src/neomutt-0.85.tar.gz <no description>

   The "-"denotes that NeoMutt will delete the file after sending (or
   postponing, or canceling) the message. It can be toggled with the
   <toggle-unlink>command (default: u). The next field is the MIME
   content-type, and can be changed with the <edit-type>command (default:
   ^T). The next field is the encoding for the attachment, which allows a
   binary message to be encoded for transmission on 7bit links. It can be
   changed with the <edit-encoding>command (default: ^E). The next field
   is the size of the attachment, rounded to kilobytes or megabytes. The
   next field is the filename, which can be changed with the
   <rename-file>command (default: R). The final field is the description
   of the attachment, and can be changed with the
   <edit-description>command (default: d). See $attach_format for a full
   list of available expandos to format this display to your needs.

2. MIME Type Configuration with mime.types

   To get most out of MIME, it's important that a MIME part's content type
   matches the content as closely as possible so that the recipient's
   client can automatically select the right viewer for the content.
   However, there's no reliable for NeoMutt to know how to detect every
   possible file type. Instead, it uses a simple plain text mapping file
   that specifies what file extension corresponds to what MIME type. This
   file is called mime.types.

   When you add an attachment to your mail message, NeoMutt searches your
   personal mime.types file at $HOME/.mime.types, and then the system
   mime.types file at /usr/local/share/neomutt/mime.types or
   /etc/mime.types

   Each line starts with the full MIME type, followed by a space and
   space-separated list of file extensions. For example you could use:

   Example 5.1.  mime.types
application/postscript          ps eps
application/pgp                 pgp
audio/x-aiff                    aif aifc aiff

   A sample mime.types file comes with the NeoMutt distribution, and
   should contain most of the MIME types you are likely to use.

   If NeoMutt can not determine the MIME type by the extension of the file
   you attach, it will run the command specified in
   $mime_type_query_command. If that command is not specified, NeoMutt
   will look at the file. If the file is free of binary information,
   NeoMutt will assume that the file is plain text, and mark it as
   text/plain. If the file contains binary information, then NeoMutt will
   mark it as application/octet-stream. You can change the MIME type that
   NeoMutt assigns to an attachment by using the <edit-type>command from
   the compose menu (default: ^T), see Table 5.1, "Supported MIME
   types"for supported major types. NeoMutt recognizes all of these if the
   appropriate entry is found in the mime.types file. Non-recognized mime
   types should only be used if the recipient of the message is likely to
   be expecting such attachments.

   Table 5.1. Supported MIME types
   MIME major type Standard                Description
   application     yes      General application data
   audio           yes      Audio data
   image           yes      Image data
   message         yes      Mail messages, message status information
   model           yes      VRML and other modeling data
   multipart       yes      Container for other MIME parts
   text            yes      Text data
   video           yes      Video data
   chemical        no       Mostly molecular data

   MIME types are not arbitrary, they need to be assigned by IANA.

3. MIME Viewer Configuration with Mailcap

   NeoMutt supports RFC 1524 MIME Configuration, in particular the Unix
   specific format specified in Appendix A of RFC 1524. This file format
   is commonly referred to as the "mailcap" format. Many MIME compliant
   programs utilize the mailcap format, allowing you to specify handling
   for all MIME types in one place for all programs. Programs known to use
   this format include Firefox, lynx and metamail.

   In order to handle various MIME types that NeoMutt doesn't have
   built-in support for, it parses a series of external configuration
   files to find an external handler. The default search string for these
   files is a colon delimited list containing the following files:
    1. $HOME/.mailcap
    2. $PKGDATADIR/mailcap
    3. $SYSCONFDIR/mailcap
    4. /etc/mailcap
    5. /usr/etc/mailcap
    6. /usr/local/etc/mailcap

   where $HOME is your home directory. The $PKGDATADIR and the $SYSCONFDIR
   directories depend on where NeoMutt is installed: the former is the
   default for shared data, the latter for system configuration files.

   The default search path can be obtained by running the following
   command:
neomutt -nF /dev/null -Q mailcap_path

   In particular, the metamail distribution will install a mailcap file,
   usually as /usr/local/etc/mailcap, which contains some baseline
   entries.

3.1. The Basics of the Mailcap File

   A mailcap file consists of a series of lines which are comments, blank,
   or definitions.

   A comment line consists of a # character followed by anything you want.

   A blank line is blank.

   A definition line consists of a content type, a view command, and any
   number of optional fields. Each field of a definition line is divided
   by a semicolon ";"character.

   The content type is specified in the MIME standard "type/subtype"
   notation. For example, text/plain, text/html, image/gif, etc. In
   addition, the mailcap format includes two formats for wildcards, one
   using the special "*"subtype, the other is the implicit wild, where you
   only include the major type. For example, image/*, or video will match
   all image types and video types, respectively.

   The view command is a Unix command for viewing the type specified.
   There are two different types of commands supported. The default is to
   send the body of the MIME message to the command on stdin. You can
   change this behavior by using %s as a parameter to your view command.
   This will cause NeoMutt to save the body of the MIME message to a
   temporary file, and then call the view command with the %s replaced by
   the name of the temporary file. In both cases, NeoMutt will turn over
   the terminal to the view program until the program quits, at which time
   NeoMutt will remove the temporary file if it exists. This means that
   mailcap does not work out of the box with programs which detach
   themselves from the terminal right after starting, like open on Mac OS
   X. In order to nevertheless use these programs with mailcap, you
   probably need custom shell scripts.

   So, in the simplest form, you can send a text/plain message to the
   external pager more on standard input:
text/plain; more

   Or, you could send the message as a file:
text/plain; more %s

   Perhaps you would like to use lynx to interactively view a text/html
   message:
text/html; lynx %s

   In this case, lynx does not support viewing a file from standard input,
   so you must use the %s syntax.

Note

   Some older versions of lynx contain a bug where they will check the
   mailcap file for a viewer for text/html. They will find the line which
   calls lynx, and run it. This causes lynx to continuously spawn itself
   to view the object.

   On the other hand, maybe you don't want to use lynx interactively, you
   just want to have it convert the text/html to text/plain, then you can
   use:
text/html; lynx -dump %s | more

   Perhaps you wish to use lynx to view text/html files, and a pager on
   all other text formats, then you would use the following:
text/html; lynx %s
text/*; more

3.2. Secure Use of Mailcap

   The interpretation of shell meta-characters embedded in MIME parameters
   can lead to security problems in general. NeoMutt tries to quote
   parameters in expansion of %s syntaxes properly, and avoids risky
   characters by substituting them, see the $mailcap_sanitize variable.

   Although NeoMutt's procedures to invoke programs with mailcap seem to
   be safe, there are other applications parsing mailcap, maybe taking
   less care of it. Therefore you should pay attention to the following
   rules:

   Keep the %-expandos away from shell quoting.Don't quote them with
   single or double quotes. NeoMutt does this for you, the right way, as
   should any other program which interprets mailcap. Don't put them into
   backtick expansions. Be highly careful with evil statements, and avoid
   them if possible at all. Trying to fix broken behavior with quotes
   introduces new leaks -- there is no alternative to correct quoting in
   the first place.

   If you have to use the %-expandos' values in context where you need
   quoting or backtick expansions, put that value into a shell variable
   and reference the shell variable where necessary, as in the following
   example (using $charset inside the backtick expansion is safe, since it
   is not itself subject to any further expansion):
text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
        && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1

3.3. Advanced Mailcap Usage

3.3.1. Optional Fields

   In addition to the required content-type and view command fields, you
   can add semi-colon ";"separated fields to set flags and other options.
   NeoMutt recognizes the following optional fields:

   copiousoutput
          This flag tells NeoMutt that the command passes possibly large
          amounts of text on standard output. This causes NeoMutt to
          invoke a pager (either the internal pager or the external pager
          defined by the pager variable) on the output of the view
          command. Without this flag, NeoMutt assumes that the command is
          interactive. One could use this to replace the pipe to more in
          the lynx -dump example in the Basic section:

text/html; lynx -dump %s ; copiousoutput

          This will cause lynx to format the text/html output as
          text/plain and NeoMutt will use your standard pager to display
          the results.

          NeoMutt will set the COLUMNS environment variable to the width
          of the pager. Some programs make use of this environment
          variable automatically. Others provide a command line argument
          that can use this to set the output width:

text/html; lynx -dump -width ${COLUMNS:-80} %s; copiousoutput

          Note that when using the built-in pager, only entries with this
          flag will be considered a handler for a MIME type -- all other
          entries will be ignored.

   needsterminal
          NeoMutt uses this flag when viewing attachments with auto_view ,
          in order to decide whether it should honor the setting of the
          $wait_key variable or not. When an attachment is viewed using an
          interactive program, and the corresponding mailcap entry has a
          needsterminal flag, NeoMutt will use $wait_key and the exit
          status of the program to decide if it will ask you to press a
          key after the external program has exited. In all other
          situations it will not prompt you for a key.

   compose=<command>
          This flag specifies the command to use to create a new
          attachment of a specific MIME type. NeoMutt supports this from
          the compose menu.

   composetyped=<command>
          This flag specifies the command to use to create a new
          attachment of a specific MIME type. This command differs from
          the compose command in that NeoMutt will expect standard MIME
          headers on the data. This can be used to specify parameters,
          filename, description, etc. for a new attachment. NeoMutt
          supports this from the compose menu.

   print=<command>
          This flag specifies the command to use to print a specific MIME
          type. NeoMutt supports this from the attachment and compose
          menus.

   edit=<command>
          This flag specifies the command to use to edit a specific MIME
          type. NeoMutt supports this from the compose menu, and also uses
          it to compose new attachments. NeoMutt will default to the
          defined $editor for text attachments.

   nametemplate=<template>
          This field specifies the format for the file denoted by %s in
          the command fields. Certain programs will require a certain file
          extension, for instance, to correctly view a file. For instance,
          lynx will only interpret a file as text/html if the file ends in
          .html. So, you would specify lynx as a text/html viewer with a
          line in the mailcap file like:

text/html; lynx %s; nametemplate=%s.html

   test=<command>
          This field specifies a command to run to test whether this
          mailcap entry should be used. The command is defined with the
          command expansion rules defined in the next section. If the
          command returns 0, then the test passed, and NeoMutt uses this
          entry. If the command returns non-zero, then the test failed,
          and NeoMutt continues searching for the right entry. Note that
          the content-type must match before NeoMutt performs the test.
          For example:

text/html; firefox -remote 'openURL(%s)' ; test=RunningX
text/html; lynx %s

          In this example, NeoMutt will run the program RunningX which
          will return 0 if the X Window manager is running, and non-zero
          if it isn't. If RunningX returns 0, then NeoMutt will run
          firefox to display the text/html object. If RunningX doesn't
          return 0, then NeoMutt will go on to the next entry and use lynx
          to display the text/html object.

3.3.2. Search Order

   When searching for an entry in the mailcap file, NeoMutt will search
   for the most useful entry for its purpose. For instance, if you are
   attempting to print an image/gif, and you have the following entries in
   your mailcap file, NeoMutt will search for an entry with the print
   command:
image/*;        xv %s
image/gif;      ; print= anytopnm %s | pnmtops | lpr; \
                nametemplate=%s.gif

   NeoMutt will skip the image/*entry and use the image/gif entry with the
   print command.

   In addition, you can use this with auto_view to denote two commands for
   viewing an attachment, one to be viewed automatically, the other to be
   viewed interactively from the attachment menu using the
   <view-mailcap>function (bound to "m" by default). In addition, you can
   then use the test feature to determine which viewer to use
   interactively depending on your environment.
text/html;      firefox -remote 'openURL(%s)' ; test=RunningX
text/html;      lynx %s; nametemplate=%s.html
text/html;      lynx -dump %s; nametemplate=%s.html; copiousoutput

   For auto_view , NeoMutt will choose the third entry because of the
   copiousoutput tag. For interactive viewing, NeoMutt will run the
   program RunningX to determine if it should use the first entry. If the
   program returns non-zero, NeoMutt will use the second entry for
   interactive viewing. The last entry is for inline display in the pager
   and the <view-attach>function in the attachment menu.

   Entries with the copiousoutput tag should always be specified as the
   last one per type. For non-interactive use, the last entry will then
   actually be the first matching one with the tag set. For
   non-interactive use, only copiousoutput-tagged entries are considered.
   For interactive use, NeoMutt ignores this tag and treats all entries
   equally. Therefore, if not specified last, all following entries
   without this tag would never be considered for <view-attach>because the
   copiousoutput before them matched already.

3.3.3. Command Expansion

   The various commands defined in the mailcap files are passed to the
   /bin/sh shell using the system(3)function. Before the command is passed
   to /bin/sh -c, it is parsed to expand various special parameters with
   information from NeoMutt. The keywords NeoMutt expands are:

   %s
          As seen in the basic mailcap section, this variable is expanded
          to a filename specified by the calling program. This file
          contains the body of the message to view/print/edit or where the
          composing program should place the results of composition. In
          addition, the use of this keyword causes NeoMutt to not pass the
          body of the message to the view/print/edit program on stdin.

   %t
          NeoMutt will expand %t to the text representation of the content
          type of the message in the same form as the first parameter of
          the mailcap definition line, i.e. text/html or image/gif.

   %{<parameter>}
          NeoMutt will expand this to the value of the specified parameter
          from the Content-Type: line of the mail message. For instance,
          if your mail message contains:

Content-Type: text/plain; charset=iso-8859-1

          then NeoMutt will expand %{charset}to "iso-8859-1". The default
          metamail mailcap file uses this feature to test the charset to
          spawn an xterm using the right charset to view the message.

   \%
          This will be replaced by a literal %.

   NeoMutt does not currently support the %F and %n keywords specified in
   RFC 1524. The main purpose of these parameters is for multipart
   messages, which is handled internally by NeoMutt.

3.4. Example Mailcap Files

   This mailcap file is fairly simple and standard:
# I'm always running X :)
video/*;        xanim %s > /dev/null
image/*;        xv %s > /dev/null
# I'm always running firefox (if my computer had more memory, maybe)
text/html;      firefox -remote 'openURL(%s)'

   This mailcap file shows quite a number of examples:
# Use xanim to view all videos   Xanim produces a header on startup,
# send that to /dev/null so I don't see it
video/*;        xanim %s > /dev/null
# Send html to a running firefox by remote
text/html;      firefox -remote 'openURL(%s)'; test=RunningFirefox
# If I'm not running firefox but I am running X, start firefox on the
# object
text/html;      firefox %s; test=RunningX
# Else use lynx to view it as text
text/html;      lynx %s
# This version would convert the text/html to text/plain
text/html;      lynx -dump %s; copiousoutput
# I use enscript to print text in two columns to a page
text/*;         more %s; print=enscript -2Gr %s
# Firefox adds a flag to tell itself to view jpegs internally
image/jpeg;xv %s; x-mozilla-flags=internal
# Use xv to view images if I'm running X
# In addition, this uses the \ to extend the line and set my editor
# for images
image/*;xv %s; test=RunningX; \
        edit=xpaint %s
# Convert images to text using the netpbm tools
image/*;  (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
pbmtoascii -1x2 ) 2>&1 ; copiousoutput
# Send excel spreadsheets to my NT box
application/ms-excel; open.pl %s

4. MIME Autoview

   Usage:

   auto_view mimetype [ mimetype ...]
   unauto_view { * | mimetype ... }

   In addition to explicitly telling NeoMutt to view an attachment with
   the MIME viewer defined in the mailcap file from the attachments menu,
   NeoMutt has support for automatically viewing MIME attachments while in
   the pager.

   For this to work, you must define a viewer in the mailcap file which
   uses the copiousoutput option to denote that it is non-interactive.
   Usually, you also use the entry to convert the attachment to a text
   representation which you can view in the pager.

   You then use the auto_view configuration command to list the
   content-types that you wish to view automatically. For instance, if you
   set it to:
auto_view text/html application/x-gunzip \
  application/postscript image/gif application/x-tar-gz

   ...NeoMutt would try to find corresponding entries for rendering
   attachments of these types as text. A corresponding mailcap could look
   like:
text/html;      lynx -dump %s; copiousoutput; nametemplate=%s.html
image/*;        anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | \
                pgmtopbm | pbmtoascii ; copiousoutput
application/x-gunzip;   gzcat; copiousoutput
application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
application/postscript; ps2ascii %s; copiousoutput

   unauto_view can be used to remove previous entries from the auto_view
   list. This can be used with message-hook to autoview messages based on
   size, etc. " unauto_view*"will remove all previous entries.

5. MIME Multipart/Alternative

   The multipart/alternative container type only has child MIME parts
   which represent the same content in an alternative way. This is often
   used to send HTML messages which contain an alternative plain text
   representation.

   NeoMutt has some heuristics for determining which attachment of a
   multipart/alternative type to display:
    1. First, NeoMutt will check the alternative_order list to determine
       if one of the available types is preferred. It consists of a number
       of MIME types in order, including support for implicit and explicit
       wildcards. For example:
alternative_order text/enriched text/plain text \
  application/postscript image/*

    2. Next, NeoMutt will check if any of the types have a defined
       auto_view , and use that.
    3. Failing that, NeoMutt will look for any text type.
    4. As a last attempt, NeoMutt will look for any type it knows how to
       handle.

   To remove a MIME type from the alternative_order list, use the
   unalternative_order command.

6. Attachment Searching and Counting

   If you ever lose track of attachments in your mailboxes, NeoMutt's
   attachment-counting and -searching support might be for you. You can
   make your message index display the number of qualifying attachments in
   each message, or search for messages by attachment count. You also can
   configure what kinds of attachments qualify for this feature with the
   attachments and unattachments commands.

   In order to provide this information, NeoMutt needs to fully MIME-parse
   all messages affected first. This can slow down operation especially
   for remote mail folders such as IMAP because all messages have to be
   downloaded first regardless whether the user really wants to view them
   or not though using Section 7.2, "Body Caching"usually means to
   download the message just once.

   The syntax is:

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

   disposition is the attachment's Content-Disposition type -- either
   inline or attachment. You can abbreviate this to I or A.

   Disposition is prefixed by either a "+"symbol or a "-"symbol. If it's a
   "+", you're saying that you want to allow this disposition and MIME
   type to qualify. If it's a "-", you're saying that this disposition and
   MIME type is an exception to previous "+"rules. There are examples
   below of how this is useful.

   mime-type is the MIME type of the attachment you want the command to
   affect. A MIME type is always of the format major/minor, where major
   describes the broad category of document you're looking at, and minor
   describes the specific type within that category. The major part of
   mime-type must be literal text (or the special token " * "), but the
   minor part may be a regular expression. (Therefore, " */.* "matches any
   MIME type.)

   The MIME types you give to the attachments directive are a kind of
   pattern. When you use the attachments directive, the patterns you
   specify are added to a list. When you use unattachments, the pattern is
   removed from the list. The patterns are not expanded and matched to
   specific MIME types at this time -- they're just text in a list.
   They're only matched when actually evaluating a message.

   Some examples might help to illustrate. The examples that are not
   commented out define the default configuration of the lists.

   Example 5.2. Attachment counting

# Removing a pattern from a list removes that pattern literally. It
# does not remove any type matching the pattern.

#
#  attachments   +A */.*
#  attachments   +A image/jpeg
#  unattachments +A */.*
#
# This leaves "attached" image/jpeg files on the allowed attachments
# list. It does not remove all items, as you might expect, because the
# second */.* is not a matching expression at this time.

#
# Remember: "unattachments" only undoes what "attachments" has done!

# It does not trigger any matching on actual messages.

# Qualify any MIME part with an "attachment" disposition, EXCEPT for
# text/x-vcard and application/pgp parts. (PGP parts are already known
# to NeoMutt, and can be searched for with ~g, ~G, and ~k.)
#
# I've added x-pkcs7 to this, since it functions (for S/MIME)
# analogously to PGP signature attachments. S/MIME isn't supported
# in a stock NeoMutt build, but we can still treat it specially here.

#

attachments   +A */.*
attachments   -A text/x-vcard application/pgp.*
attachments   -A application/x-pkcs7-.*

# Discount all MIME parts with an "inline" disposition, unless they're
# text/plain. (Why inline a text/plain part unless it's external to the
# message flow?)

attachments   +I text/plain

# These two lines make NeoMutt qualify MIME containers.  (So, for example,
# a message/rfc822 forward will count as an attachment.)  The first
# line is unnecessary if you already have "attach-allow */.*", of
# course.  These are off by default!  The MIME elements contained
# within a message/* or multipart/* are still examined, even if the
# containers themselves don't qualify.

#attachments  +A message/.* multipart/.*
#attachments  +I message/.* multipart/.*

## You probably don't really care to know about deleted attachments.
attachments   -A message/external-body
attachments   -I message/external-body

   Entering the command " attachments?"as a command will list your current
   settings in neomuttrc format, so that it can be pasted elsewhere.

7. MIME Lookup

   Usage:

   mime_lookup mimetype [ mimetype ...]
   unmime_lookup { * | mimetype ... }

   NeoMutt's mime_lookup list specifies a list of MIME types that should
   not be treated according to their mailcap entry. This option is
   designed to deal with binary types such as application/octet-stream.
   When an attachment's MIME type is listed in mime_lookup, then the
   extension of the filename will be compared to the list of extensions in
   the mime.types file. The MIME type associated with this extension will
   then be used to process the attachment according to the rules in the
   mailcap file and according to any other configuration options (such as
   auto_view) specified. Common usage would be:
mime_lookup application/octet-stream application/X-Lotus-Manuscript

   In addition, the unmime_lookup command may be used to disable this
   feature for any particular MIME type if it had been set, for example,
   in a global .neomuttrc.

Chapter 6. Optional Features

   Table of Contents

   1. General Notes

        1.1. Enabling/Disabling Features
        1.2. URL Syntax

   2. SSL/TLS Support
   3. POP3 Support
   4. IMAP Support

        4.1. The IMAP Folder Browser
        4.2. Authentication

   5. SMTP Support
   6. Managing Multiple Accounts
   7. Local Caching

        7.1. Header Caching
        7.2. Body Caching
        7.3. Cache Directories
        7.4. Maintenance

   8. Sending Anonymous Messages via Mixmaster
   9. Attach Headers Color Feature

        9.1. Support
        9.2. Introduction
        9.3. Usage
        9.4. neomuttrc
        9.5. See Also
        9.6. Known Bugs
        9.7. Credits

   10. Compose to Sender Feature

        10.1. Support
        10.2. Introduction
        10.3. Functions
        10.4. neomuttrc
        10.5. Known Bugs
        10.6. Credits

   11. Compressed Folders Feature

        11.1. Support
        11.2. Introduction
        11.3. Commands
        11.4. neomuttrc
        11.5. See Also
        11.6. Credits

   12. Conditional Dates Feature

        12.1. Support
        12.2. Introduction
        12.3. Variables
        12.4. neomuttrc
        12.5. See Also
        12.6. Known Bugs
        12.7. Credits

   13. Encrypt-to-Self Feature

        13.1. Support
        13.2. Introduction
        13.3. Variables
        13.4. neomuttrc
        13.5. Known Bugs
        13.6. Credits

   14. Fmemopen Feature

        14.1. Support
        14.2. Introduction
        14.3. See Also
        14.4. Known Bugs
        14.5. Credits

   15. Forgotten Attachment Feature

        15.1. Support
        15.2. Introduction
        15.3. Variables
        15.4. neomuttrc
        15.5. See Also
        15.6. Known Bugs
        15.7. Credits

   16. Global Hooks

        16.1. Introduction
        16.2. Commands
        16.3. neomuttrc
        16.4. See Also
        16.5. Known Bugs
        16.6. Credits

   17. Ifdef Feature

        17.1. Support
        17.2. Introduction
        17.3. Commands
        17.4. neomuttrc
        17.5. Known Bugs
        17.6. Credits

   18. Index Color Feature

        18.1. Support
        18.2. Introduction
        18.3. Colors
        18.4. neomuttrc
        18.5. See Also
        18.6. Known Bugs
        18.7. Credits

   19. Initials Expando Feature

        19.1. Support
        19.2. Introduction
        19.3. Variables
        19.4. neomuttrc
        19.5. See Also
        19.6. Known Bugs
        19.7. Credits

   20. Kyoto Cabinet Feature

        20.1. Support
        20.2. Introduction
        20.3. See Also
        20.4. Known Bugs
        20.5. Credits

   21. Limit Current Thread Feature

        21.1. Support
        21.2. Introduction
        21.3. Functions
        21.4. neomuttrc
        21.5. Known Bugs
        21.6. Credits

   22. LMDB Feature

        22.1. Support
        22.2. Introduction
        22.3. See Also
        22.4. Known Bugs
        22.5. Credits

   23. Multiple FCC Feature

        23.1. Support
        23.2. Introduction
        23.3. See Also
        23.4. Known Bugs
        23.5. Credits

   24. Nested If Feature

        24.1. Support
        24.2. Introduction
        24.3. Variables
        24.4. neomuttrc
        24.5. See Also
        24.6. Known Bugs
        24.7. Credits

   25. New Mail Feature

        25.1. Support
        25.2. Introduction
        25.3. Variables
        25.4. neomuttrc
        25.5. See Also
        25.6. Known Bugs
        25.7. Credits

   26. NNTP Feature

        26.1. Support
        26.2. Introduction
        26.3. Variables
        26.4. Functions
        26.5. neomuttrc
        26.6. Known Bugs
        26.7. Credits

   27. Custom backend based Tags Feature

        27.1. Support
        27.2. Introduction
        27.3. Variables
        27.4. Functions
        27.5. Commands
        27.6. Colors
        27.7. neomuttrc
        27.8. Credits

   28. Notmuch Feature

        28.1. Support
        28.2. Introduction
        28.3. Using Notmuch
        28.4. Variables
        28.5. Functions
        28.6. Commands
        28.7. Colors
        28.8. neomuttrc
        28.9. See Also
        28.10. Known Bugs
        28.11. Credits

   29. Progress Bar Feature

        29.1. Support
        29.2. Introduction
        29.3. Colors
        29.4. neomuttrc
        29.5. See Also
        29.6. Known Bugs
        29.7. Credits

   30. Quasi-Delete Feature

        30.1. Support
        30.2. Introduction
        30.3. Functions
        30.4. neomuttrc
        30.5. See Also
        30.6. Known Bugs
        30.7. Credits

   31. Reply With X-Original-To Feature

        31.1. Support
        31.2. Introduction
        31.3. Variables
        31.4. neomuttrc
        31.5. Credits

   32. Sensible Browser Feature

        32.1. Support
        32.2. Introduction
        32.3. See Also
        32.4. Known Bugs
        32.5. Credits

   33. Sidebar Feature

        33.1. Support
        33.2. Introduction
        33.3. Variables
        33.4. Functions
        33.5. Commands
        33.6. Colors
        33.7. Sort
        33.8. neomuttrc
        33.9. See Also
        33.10. Known Bugs
        33.11. Credits

   34. Skip Quoted Feature

        34.1. Support
        34.2. Introduction
        34.3. Variables
        34.4. neomuttrc
        34.5. Known Bugs
        34.6. Credits

   35. Status Color Feature

        35.1. Support
        35.2. Introduction
        35.3. Commands
        35.4. Colors
        35.5. neomuttrc
        35.6. See Also
        35.7. Known Bugs
        35.8. Credits

   36. TLS-SNI Feature

        36.1. Support
        36.2. Introduction
        36.3. Known Bugs
        36.4. Credits

   37. Trash Folder Feature

        37.1. Support
        37.2. Introduction
        37.3. Variables
        37.4. Functions
        37.5. neomuttrc
        37.6. See Also
        37.7. Known Bugs
        37.8. Credits

1. General Notes

1.1. Enabling/Disabling Features

   NeoMutt supports several of optional features which can be enabled or
   disabled at compile-time by giving the configure script certain
   arguments. These are listed in the "Optional features" section of the
   configure --help output.

   Which features are enabled or disabled can later be determined from the
   output of neomutt -v. If a compile option starts with "+"it is enabled
   and disabled if prefixed with "-". For example, if NeoMutt was compiled
   using GnuTLS for encrypted communication instead of OpenSSL, neomutt -v
   would contain:
-openssl +gnutls

1.2. URL Syntax

   NeoMutt optionally supports the IMAP, POP3 and SMTP protocols which
   require to access servers using URLs. The canonical syntax for
   specifying URLs in NeoMutt is (an item enclosed in []means it is
   optional and may be omitted):
proto[s]://[username[:password]@]server[:port][/path]

   proto is the communication protocol: imap for IMAP, pop for POP3 and
   smtp for SMTP. If "s" for "secure communication" is appended, NeoMutt
   will attempt to establish an encrypted communication using SSL or TLS.

   Since all protocols supported by NeoMutt support/require
   authentication, login credentials may be specified in the URL. This has
   the advantage that multiple IMAP, POP3 or SMTP servers may be specified
   (which isn't possible using, for example, $imap_user). The username may
   contain the "@"symbol being used by many mail systems as part of the
   login name. The special characters "/"( %2F), ":"( %3A) and "%"( %25)
   have to be URL-encoded in usernames using the %-notation.

   A password can be given, too but is not recommended if the URL is
   specified in a configuration file on disk.

   If no port number is given, NeoMutt will use the system's default for
   the given protocol (usually consulting /etc/services).

   The optional path is only relevant for IMAP and ignored elsewhere.

   Example 6.1. URLs
pops://host/
imaps://user@host/INBOX/Sent
smtp://user@host:587/

2. SSL/TLS Support

   If NeoMutt is compiled with IMAP, POP3 and/or SMTP support, it can also
   be compiled with support for SSL or TLS using either OpenSSL or GnuTLS
   ( by running the configure script with the --enable-ssl=...option for
   OpenSSL or --enable-gnutls=...for GnuTLS). NeoMutt can then attempt to
   encrypt communication with remote servers if these protocols are
   suffixed with "s" for "secure communication".

3. POP3 Support

   NeoMutt has POP3 support and has the ability to work with mailboxes
   located on a remote POP3 server and fetch mail for local browsing.

   Remote POP3 servers can be accessed using URLs with the pop protocol
   for unencrypted and pops for encrypted communication, see Section 1.2,
   "URL Syntax"for details.

   Polling for new mail is more expensive over POP3 than locally. For this
   reason the frequency at which NeoMutt will check for mail remotely can
   be controlled by the $pop_checkinterval variable, which defaults to
   every 60 seconds.

   POP is read-only which doesn't allow for some features like editing
   messages or changing flags. However, using Section 7.1, "Header
   Caching"and Section 7.2, "Body Caching"NeoMutt simulates the
   new/old/read flags as well as flagged and replied. NeoMutt applies some
   logic on top of remote messages but cannot change them so that
   modifications of flags are lost when messages are downloaded from the
   POP server (either by NeoMutt or other tools).

   Another way to access your POP3 mail is the <fetch-mail>function
   (default: G). It allows to connect to $pop_host, fetch all your new
   mail and place it in the local $spoolfile. After this point, NeoMutt
   runs exactly as if the mail had always been local.

Note

   If you only need to fetch all messages to a local mailbox you should
   consider using a specialized program, such as fetchmail(1),
   getmail(1)or similar.

4. IMAP Support

   NeoMutt has IMAP support and has the ability to work with folders
   located on a remote IMAP server.

   You can access the remote inbox by selecting the folder by its URL (see
   Section 1.2, "URL Syntax"for details) using the imap or imaps protocol.
   Alternatively, a pine-compatible notation is also supported, i.e.
   {[username@]imapserver[:port][/ssl]}path/to/folder

   Note that not all servers use "/"as the hierarchy separator. NeoMutt
   should correctly notice which separator is being used by the server and
   convert paths accordingly.

   When browsing folders on an IMAP server, you can toggle whether to look
   at only the folders you are subscribed to, or all folders with the
   toggle-subscribed command. See also the $imap_list_subscribed variable.

   Polling for new mail on an IMAP server can cause noticeable delays. So,
   you'll want to carefully tune the $mail_check and $timeout variables.
   Reasonable values are:
set mail_check=90
set timeout=15

   with relatively good results even over slow modem lines.

Note

   Note that if you are using mbox as the mail store on UW servers prior
   to v12.250, the server has been reported to disconnect a client if
   another client selects the same folder.

4.1. The IMAP Folder Browser

   As of version 1.2, NeoMutt supports browsing mailboxes on an IMAP
   server. This is mostly the same as the local file browser, with the
   following differences:
     * In lieu of file permissions, NeoMutt displays the string "IMAP",
       possibly followed by the symbol "+", indicating that the entry
       contains both messages and subfolders. On Cyrus-like servers
       folders will often contain both messages and subfolders.
     * For the case where an entry can contain both messages and
       subfolders, the selection key (bound to enter by default) will
       choose to descend into the subfolder view. If you wish to view the
       messages in that folder, you must use view-file instead (bound to
       space by default).
     * You can create, delete and rename mailboxes with the
       <create-mailbox>, <delete-mailbox>, and <rename-mailbox>commands
       (default bindings: C, d and r, respectively). You may also
       <subscribe>and <unsubscribe>to mailboxes (normally these are bound
       to s and u, respectively).

4.2. Authentication

   NeoMutt supports four authentication methods with IMAP servers: SASL,
   GSSAPI, CRAM-MD5, and LOGIN. There is also support for the
   pseudo-protocol ANONYMOUS, which allows you to log in to a public IMAP
   server without having an account. To use ANONYMOUS, simply make your
   username blank or "anonymous".

   SASL is a special super-authenticator, which selects among several
   protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the
   most secure method available on your host and the server. Using some of
   these methods (including DIGEST-MD5 and possibly GSSAPI), your entire
   session will be encrypted and invisible to those teeming network
   snoops. It is the best option if you have it. To use it, you must have
   the Cyrus SASL library installed on your system and compile NeoMutt
   with the --with-sasl flag.

   NeoMutt will try whichever methods are compiled in and available on the
   server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5,
   LOGIN.

   There are a few variables which control authentication:
     * $imap_user- controls the username under which you request
       authentication on the IMAP server, for all authenticators. This is
       overridden by an explicit username in the mailbox path (i.e. by
       using a mailbox name of the form {user@host}).
     * $imap_pass- a password which you may preset, used by all
       authentication methods where a password is needed.
     * $imap_authenticators- a colon-delimited list of IMAP authentication
       methods to try, in the order you wish to try them. If specified,
       this overrides NeoMutt's default (attempt everything, in the order
       listed above).

5. SMTP Support

   Besides supporting traditional mail delivery through a
   sendmail-compatible program, NeoMutt supports delivery through SMTP.

   If the configuration variable $smtp_url is set, NeoMutt will contact
   the given SMTP server to deliver messages; if it is unset, NeoMutt will
   use the program specified by $sendmail.

   For details on the URL syntax, please see Section 1.2, "URL Syntax".

   The built-in SMTP support supports encryption (the smtps protocol using
   SSL or TLS) as well as SMTP authentication using SASL. The
   authentication mechanisms for SASL are specified in
   $smtp_authenticators defaulting to an empty list which makes NeoMutt
   try all available methods from most-secure to least-secure.

6. Managing Multiple Accounts

   Usage:

   account-hook regex command

   If you happen to have accounts on multiple IMAP, POP and/or SMTP
   servers, you may find managing all the authentication settings
   inconvenient and error-prone. The account-hook command may help. This
   hook works like folder-hook but is invoked whenever NeoMutt needs to
   access a remote mailbox (including inside the folder browser), not just
   when you open the mailbox. This includes (for example) polling for new
   mail, storing Fcc messages and saving messages to a folder. As a
   consequence, account-hook should only be used to set connection-related
   settings such as passwords or tunnel commands but not settings such as
   sender address or name (because in general it should be considered
   unpredictable which account-hook was last used).

   Some examples:
account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'

   To manage multiple accounts with, for example, different values of
   $record or sender addresses, folder-hook has to be be used together
   with the mailboxes command.

   Example 6.2. Managing multiple accounts
mailboxes imap://user@host1/INBOX
folder-hook imap://user@host1/ 'set folder=imap://host1/ ; set record=+INBOX/Sen
t'
mailboxes imap://user@host2/INBOX
folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sen
t'

   In example Example 6.2, "Managing multiple accounts"the folders are
   defined using mailboxes so NeoMutt polls them for new mail. Each
   folder-hook triggers when one mailbox below each IMAP account is opened
   and sets $folder to the account's root folder. Next, it sets $record to
   the INBOX/Sent folder below the newly set $folder. Please notice that
   the value the "+" mailbox shortcut refers to depends on the current
   value of $folder and therefore has to be set separately per account.
   Setting other values like $from or $signature is analogous to setting
   $record.

7. Local Caching

   NeoMutt contains two types of local caching: (1)the so-called "header
   caching" and (2)the so-called "body caching" which are both described
   in this section.

   Header caching is optional as it depends on external libraries, body
   caching is always enabled if NeoMutt is compiled with POP and/or IMAP
   support as these use it (body caching requires no external library).

7.1. Header Caching

   NeoMutt provides optional support for caching message headers for the
   following types of folders: IMAP, POP, Maildir and MH. Header caching
   greatly speeds up opening large folders because for remote folders,
   headers usually only need to be downloaded once. For Maildir and MH,
   reading the headers from a single file is much faster than looking at
   possibly thousands of single files (since Maildir and MH use one file
   per message.)

   Header caching can be enabled by configuring one of the database
   backends. One of tokyocabinet, kyotocabinet, qdbm, gdbm, lmdb or bdb.

   If enabled, $header_cache can be used to either point to a file or a
   directory. If set to point to a file, one database file for all folders
   will be used (which may result in lower performance), but one file per
   folder if it points to a directory.

   Additionally, $header_cache_backend can be used to specify which
   backend to use. The list of available backends can be specified at
   configure time with a set of --with-<backend> options. Currently, the
   following backends are supported: tokyocabinet, kyotocabinet, qdbm,
   gdbm, bdb, lmdb.

7.2. Body Caching

   Both cache methods can be combined using the same directory for storage
   (and for IMAP/POP even provide meaningful file names) which simplifies
   manual maintenance tasks.

   In addition to caching message headers only, NeoMutt can also cache
   whole message bodies. This results in faster display of messages for
   POP and IMAP folders because messages usually have to be downloaded
   only once.

   For configuration, the variable $message_cachedir must point to a
   directory. There, NeoMutt will create a hierarchy of subdirectories
   named like the account and mailbox path the cache is for.

7.3. Cache Directories

   For using both, header and body caching, $header_cache and
   $message_cachedir can be safely set to the same value.

   In a header or body cache directory, NeoMutt creates a directory
   hierarchy named like: proto:user@hostname where proto is either "pop"
   or "imap."Within there, for each folder, NeoMutt stores messages in
   single files and header caches in files with the ".hcache" extension.
   All files can be removed as needed if the consumed disk space becomes
   an issue as NeoMutt will silently fetch missing items again. Pathnames
   are always stored in UTF-8 encoding.

   For Maildir and MH, the header cache files are named after the MD5
   checksum of the path.

7.4. Maintenance

   NeoMutt does not (yet) support maintenance features for header cache
   database files so that files have to be removed in case they grow too
   big. It depends on the database library used for header caching whether
   disk space freed by removing messages is re-used.

   For body caches, NeoMutt can keep the local cache in sync with the
   remote mailbox if the $message_cache_clean variable is set. Cleaning
   means to remove messages from the cache which are no longer present in
   the mailbox which only happens when other mail clients or instances of
   NeoMutt using a different body cache location delete messages (NeoMutt
   itself removes deleted messages from the cache when syncing a mailbox).
   As cleaning can take a noticeable amount of time, it should not be set
   in general but only occasionally.

8. Sending Anonymous Messages via Mixmaster

   You may also have compiled NeoMutt to co-operate with Mixmaster, an
   anonymous remailer. Mixmaster permits you to send your messages
   anonymously using a chain of remailers. Mixmaster support in NeoMutt is
   for mixmaster version 2.04 or later.

   To use it, you'll have to obey certain restrictions. Most important,
   you cannot use the Cc and Bcc headers. To tell NeoMutt to use
   mixmaster, you have to select a remailer chain, using the mix function
   on the compose menu.

   The chain selection screen is divided into two parts. In the (larger)
   upper part, you get a list of remailers you may use. In the lower part,
   you see the currently selected chain of remailers.

   You can navigate in the chain using the <chain-prev>and
   <chain-next>functions, which are by default bound to the left and right
   arrows and to the h and l keys (think vi keyboard bindings). To insert
   a remailer at the current chain position, use the <insert>function. To
   append a remailer behind the current chain position, use
   <select-entry>or <append>. You can also delete entries from the chain,
   using the corresponding function. Finally, to abandon your changes,
   leave the menu, or <accept>them pressing (by default) the Return key.

   Note that different remailers do have different capabilities, indicated
   in the %c entry of the remailer menu lines (see $mix_entry_format).
   Most important is the "middleman" capability, indicated by a capital
   "M": This means that the remailer in question cannot be used as the
   final element of a chain, but will only forward messages to other
   mixmaster remailers. For details on the other capabilities, please have
   a look at the mixmaster documentation.

9. Attach Headers Color Feature

Color attachment headers using regex, just like mail bodies

9.1. Support

   Since:NeoMutt 2016-09-10

   Dependencies:None

9.2. Introduction

   This feature allows specifying regexes to color attachment headers just
   like the mail body would. The headers are the parts colored by the
   attachment color. Coloring them is useful to highlight the results of
   GPGME's signature checks or simply the mimetype or size of the
   attachment. Only the part matched by the regex is colored.

9.3. Usage

   The attach_headers color should be used just like the body color.
color attach_headers foreground background pattern

9.4. neomuttrc

# Example NeoMutt config file for the attach-headers-color feature.

# Color if the attachment is autoviewed
color   attach_headers     brightgreen     default        "Autoview"
# Color only the brackets around the headers
color   attach_headers     brightyellow    default        "^\\[--"
color   attach_headers     brightyellow    default        "--]$"
# Color the mime type and the size
color   attach_headers     green           default        "Type: [a-z]+/[a-z0-9\
-]+"
color   attach_headers     green           default        "Size: [0-9\.]+[KM]"
# Color GPGME signature checks
color   attach_headers     brightgreen     default        "Good signature from.*
"
color   attach_headers     brightred       default        "Bad signature from.*"
color   attach_headers     brightred       default        "BAD signature from.*"
color   attach_headers     brightred       default        "Note: This key has ex
pired!"
color   attach_headers     brightmagenta   default        "Problem signature fro
m.*"
color   attach_headers     brightmagenta   default        "WARNING: This key is
not certified with a trusted signature!"
color   attach_headers     brightmagenta   default        "         There is no
indication that the signature belongs to the owner."
color   attach_headers     brightmagenta   default        "can't handle these mu
ltiple signatures"
color   attach_headers     brightmagenta   default        "signature verificatio
n suppressed"
color   attach_headers     brightmagenta   default        "invalid node with pac
ket of type"

        # vim: syntax=neomuttrc

9.5. See Also

     * Color command
     * Regular Expressions

9.6. Known Bugs

   None

9.7. Credits

     * Guillaume Brogi <gui-gui@netcourrier.com>

10. Compose to Sender Feature

Send new mail to the sender of the current mail

10.1. Support

   Since:NeoMutt 2016-10-02

   Dependencies:None

10.2. Introduction

   The compose-to-sender feature adds a new command to start composing a
   new email to the sender of the current message. This is not a reply,
   but a new, separate, message.

   It works on tagged messages too, sending one email to all of the
   senders of the tagged messages.

10.3. Functions

   compose-to-sender adds the following function to NeoMutt. By default,
   it is not bound to a key.

   Table 6.1. compose-to-sender Functions
   Menus Function Description
   index,pager <compose-to-sender> compose a new email to the sender of
   the current email

10.4. neomuttrc

# Example NeoMutt config file for the compose-to-sender feature.

# --------------------------------------------------------------------------
# FUNCTIONS - shown with an example mapping
# --------------------------------------------------------------------------
# Compose a new email (not a reply) to the sender
bind index,pager @ compose-to-sender

        # vim: syntax=neomuttrc

10.5. Known Bugs

   None

10.6. Credits

     * Brian Medley
     * Guillaume Brogi <gui-gui@netcourrier.com>

11. Compressed Folders Feature

Read from/write to compressed mailboxes

11.1. Support

   Since:NeoMutt 2016-05-30

   Dependencies:None

11.2. Introduction

   The Compressed Folder feature allows NeoMutt to read mailbox files that
   are compressed. But it isn't limited to compressed files. It works well
   with encrypted files, too. In fact, if you can create a program/script
   to convert to and from your format, then NeoMutt can read it.

   The feature adds three hooks to NeoMutt: open-hook, close-hook and
   append-hook. They define commands to: uncompress a file; compress a
   file; append messages to an already compressed file.

   There are some examples of both compressed and encrypted files, later.
   For now, the documentation will just concentrate on compressed files.

11.3. Commands

   open-hook pattern shell-command
   close-hook pattern shell-command
   append-hook pattern shell-command

   The shell-command must contain two placeholders for filenames: %f and
   %t. These represent "from" and "to" filenames. These placeholders
   should be placed inside single-quotes to prevent unintended shell
   expansions.

   If you need the exact string "%f" or "%t" in your command, simply
   double up the "%"character, e.g. "%%f" or "%%t".

   Table 6.2. Not all Hooks are Required
   Open Close Append Effect Useful if
   Open - - Folder is readonly The folder is just a backup
   Open Close - Folder is read/write, but the entire folder must be
   written if anything is changed Your compression format doesn't support
   appending
   Open Close Append Folder is read/write and emails can be efficiently
   added to the end Your compression format supports appending
   Open - Append Folder is readonly, but can be appended to You want to
   store emails, but never change them

Note

   The command:
     * should return a non-zero exit status on failure
     * should not delete any files

11.3.1. Read from compressed mailbox

open-hook regex shell-command

   If NeoMutt is unable to open a file, it then looks for open-hook that
   matches the filename.

   If your compression program doesn't have a well-defined extension, then
   you can use .as the regex.

11.3.1.1. Example of open-hook

open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'"

     * NeoMutt finds a file, "example.gz", that it can't read
     * NeoMutt has an open-hook whose regex matches the filename: \.gz$
     * NeoMutt uses the command gzip -cd to create a temporary file that
       it can read

11.3.2. Write to a compressed mailbox

close-hook regex shell-command

   When NeoMutt has finished with a compressed mail folder, it will look
   for a matching close-hook to recompress the file. This hook is
   optional.

Note

   If the folder has not been modified, the close-hook will not be called.

11.3.2.1. Example of close-hook

close-hook '\.gz$' "gzip --stdout '%t' > '%f'"

     * NeoMutt has finished with a folder, "example.gz", that it opened
       with open-hook
     * The folder has been modified
     * NeoMutt has a close-hook whose regex matches the filename: \.gz$
     * NeoMutt uses the command gzip -c to create a new compressed file

Note

   The close-hook can also include extra options, e.g. compression level:
   --best

11.3.3. Append to a compressed mailbox

append-hook regex shell-command

   When NeoMutt wants to append an email to a compressed mail folder, it
   will look for a matching append-hook. This hook is optional.

   Using the append-hook will save time, but NeoMutt won't be able to
   determine the type of the mail folder inside the compressed file.

   NeoMutt will assume the type to be that of the $mbox_type variable.
   NeoMutt also uses this type for temporary files.

   NeoMutt will only use the append-hook for existing files. The
   close-hook will be used for empty, or missing files.

Note

   If your command writes to stdout, it is vital that you use >>in the
   "append-hook". If not, data will be lost.

11.3.3.1. Example of append-hook

append-hook '\.gz$' "gzip --stdout '%t' >> '%f'"

     * NeoMutt wants to append an email to a folder, "example.gz", that it
       opened with open-hook
     * NeoMutt has an append-hook whose regex matches the filename: \.gz$
     * NeoMutt knows the mailbox type from the $mbox variable
     * NeoMutt uses the command gzip -c to append to an existing
       compressed file

Note

   The append-hook can also include extra options, e.g. compression level:
   --best

11.3.4. Empty Files

   NeoMutt assumes that an empty file is not compressed. In this
   situation, unset $save_empty, so that the compressed file will be
   removed if you delete all of the messages.

11.3.5. Security

   Encrypted files are decrypted into temporary files which are stored in
   the $tmpdir directory. This could be a security risk.

11.4. neomuttrc

# Example NeoMutt config file for the compress feature.

# This feature adds three hooks to NeoMutt which allow it to
# work with compressed, or encrypted, mailboxes.

# The hooks are of the form:
#       open-hook   regex "shell-command"
#       close-hook  regex "shell-command"
#       append-hook regex "shell-command"
# The 'append-hook' is optional.

# Handler for gzip compressed mailboxes
open-hook   '\.gz$' "gzip --stdout --decompress '%f' >  '%t'"
close-hook  '\.gz$' "gzip --stdout              '%t' >  '%f'"
append-hook '\.gz$' "gzip --stdout              '%t' >> '%f'"
# Handler for bzip2 compressed mailboxes
open-hook   '\.bz2$' "bzip2 --stdout --decompress '%f' >  '%t'"
close-hook  '\.bz2$' "bzip2 --stdout              '%t' >  '%f'"
append-hook '\.bz2$' "bzip2 --stdout              '%t' >> '%f'"
# Handler for xz compressed mailboxes
open-hook   '\.xz$' "xz --stdout --decompress '%f' >  '%t'"
close-hook  '\.xz$' "xz --stdout              '%t' >  '%f'"
append-hook '\.xz$' "xz --stdout              '%t' >> '%f'"
# Handler for pgp encrypted mailboxes
# PGP does not support appending to an encrypted file
open-hook   '\.pgp$' "pgp -f < '%f' > '%t'"
close-hook  '\.pgp$' "pgp -fe YourPgpUserIdOrKeyId < '%t' > '%f'"
# Handler for gpg encrypted mailboxes
# gpg does not support appending to an encrypted file
open-hook   '\.gpg$' "gpg --decrypt < '%f' > '%t'"
close-hook  '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' > '%
f'"

        # vim: syntax=neomuttrc

11.5. See Also

     * Regular Expressions
     * $tmpdir
     * $mbox_type
     * $save_empty
     * folder-hook

11.6. Credits

     * Roland Rosenfeld <roland@spinnaker.de>
     * Alain Penders <Alain@Finale-Dev.com>
     * Christoph "Myon" Berg <myon@debian.org>
     * Evgeni Golov <evgeni@debian.org>
     * Richard Russon <rich@flatcap.org>

12. Conditional Dates Feature

Use rules to choose date format

12.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:
          nested-if feature

12.2. Introduction

   The "Conditional Dates" feature allows you to construct $index_format
   expressions based on the age of the email.

   NeoMutt's default $index_format displays email dates in the form:
   abbreviated-month day-of-month -- "Jan 14".

   The format is configurable but only per-mailbox. This feature allows
   you to configure the display depending on the age of the email.

   Table 6.3. Potential Formatting Scheme
      Email Sent     Format Example
   Today             %H:%M  13:23
   This Month        %a %d  Thu 17
   This Year         %b %d  Dec 10
   Older than 1 Year %m/%y  06/14

   For an explanation of the date formatting strings, see strftime(3).

   By carefully picking your formats, the dates can remain unambiguous and
   compact.

   NeoMutt's conditional format strings have the form: (whitespace
   introduced for clarity)
%? TEST ? TRUE & FALSE ?

   The examples below use the test "%["-- the date of the message in the
   local timezone. They will also work with "%("-- the local time that the
   message arrived.

   The date tests are of the form:
%[nX? TRUE & FALSE ?

     * "n" is an optional count (defaults to 1 if missing)
     * "X" is the time period

   Table 6.4. Date Formatting Codes
   Letter Time Period
   y      Years
   m      Months
   w      Weeks
   d      Days
   H      Hours
   M      Minutes

   Table 6.5. Example Date Tests
   Test       Meaning
   %[y  This year
   %[1y This year
   %[6m In the last 6 months
   %[w  This week
   %[d  Today
   %[4H In the last 4 hours

12.2.1. Example 1

   We start with a one-condition test.

   Table 6.6. Example 1
   Test Date Range Format String  Example
   %[1m This month %[%b %d]      Dec 10
        Older      %[%Y-%m-%d]   2015-04-23

   The $index_format string would contain:
%?[1m?%[%b %d]&%[%Y-%m-%d]?

   Reparsed a little, for clarity, you can see the test condition and the
   two format strings.
%?[1m?        &           ?

      %[%b %d] %[%Y-%m-%d]

12.2.2. Example 2

   This example contains three test conditions and four date formats.

   Table 6.7. Example 2
   Test Date Range Format String Example
   %[d  Today      %[%H:%M ]     12:34
   %[m  This month %[%a %d]      Thu 12
   %[y  This year  %[%b %d]      Dec 10
        Older      %[%m/%y ]     06/15

   The $index_format string would contain:
%<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>&%[%b %d]>&%[%m/%y ]>

   Reparsed a little, for clarity, you can see the test conditions and the
   four format strings.
%<[y?                                       &%[%m/%y ]>  Older
     %<[m?                        &%[%b %d]>             This year
          %<[d?         &%[%a %d]>                       This month
               %[%H:%M ]                                 Today

   This a another view of the same example, with some whitespace for
   clarity.
%<[y? %<[m? %<[d? AAA & BBB > & CCC > & DDD >

   AAA = %[%H:%M ] BBB = %[%a %d] CCC = %[%b %d] DDD =
             %[%m/%y ]

12.3. Variables

   The "Conditional Dates" feature doesn't have any config of its own. It
   modifies the behavior of the format strings.

12.4. neomuttrc

# Example NeoMutt config file for the cond-date feature.

#
# The default index_format is:
#       '%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s'
#
# We replace the date field '%{%b %d}', giving:
set index_format='%4C %Z %<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>&%[%b %d]>&%[%m/%y ]>
 %-15.15L (%?l?%4l&%4c?) %s'
# Test  Date Range  Format String  Example
# --------------------------------------------
# %[d   Today       %[%H:%M ]      12:34
# %[m   This month  %[%a %d]       Thu 12
# %[y   This year   %[%b %d]       Dec 10
# -     Older       %[%m/%y ]      06/15
# vim: syntax=neomuttrc

12.5. See Also

     * $index_format
     * nested-if feature
     * strftime(3)

12.6. Known Bugs

   Date parsing doesn't quite do what you expect. "1w" doesn't mean the
   "in the last 7 days", but " this week". This doesn't match the normal
   NeoMutt behavior: for example ~d>1w means emails dated in the last 7
   days.

12.7. Credits

     * Aaron Schrab <aaron@schrab.com>
     * Eric Davis <edavis@insanum.com>
     * Richard Russon <rich@flatcap.org>

13. Encrypt-to-Self Feature

Save a self-encrypted copy of emails

13.1. Support

   Since:NeoMutt 2016-07-23

   Dependencies:None

13.2. Introduction

   Once you encrypt an email to someone you cannot read it. This is good
   for security, but bad for record-keeping. If you wanted to keep a copy
   of an encrypted email you could set $fcc_clear.

   A better option is to enable $smime_self_encrypt, then set
   $smime_default_key to your personal S/MIME key id.
set smime_self_encrypt = yes
set smime_default_key  = bb345e23.0

   Or, if you use PGP, $pgp_self_encrypt, then set $pgp_default_key to
   your personal PGP key id.
set pgp_self_encrypt = yes
set pgp_default_key  = A4AF18C5582473BD35A1E9CE78BB3D480042198E

   If you have different key for signing, then you can set $pgp_sign_as or
   $smime_sign_as respectively.

13.3. Variables

   Table 6.8. encrypt-self Variables
          Name         Type   Default
   pgp_default_key    string  (empty)
   pgp_self_encrypt   boolean yes
   pgp_sign_as        string  (empty)
   smime_default_key  string  (empty)
   smime_self_encrypt boolean yes
   smime_sign_as      string  (empty)

13.4. neomuttrc

# Example NeoMutt config file for the encrypt-to-self feature.

# --------------------------------------------------------------------------
# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
# Save a copy of outgoing email, encrypted to yourself
set pgp_self_encrypt = "yes"
set pgp_default_key = "PGP-KEY"
# set pgp_sign_as = "PGP-SIGNING-KEY"

# Save a copy of outgoing email, encrypted to yourself
set smime_self_encrypt = "yes"
set smime_default_key = "SMIME-KEY"
# set smime_sign_as = "SMIME-SIGNING-KEY"

# vim: syntax=neomuttrc

13.5. Known Bugs

   None

13.6. Credits

     * Omen Wild <omen@mandarb.com>
     * Richard Russon <rich@flatcap.org>
     * Guillaume Brogi <gui-gui@netcourrier.com>

14. Fmemopen Feature

Replace some temporary files with memory buffers

14.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:
          open_memstream(), fmemopen()from glibc

   This feature can be enabled by running configure with the option
   --enable-fmemopen

14.2. Introduction

   The "fmemopen" feature speeds up some searches.

   This feature changes a few places where NeoMutt creates temporary
   files. It replaces them with in-memory buffers. This should improve the
   performance when searching the header or body using the
   $thorough_search option.

   There are no user-configurable parts.

   This feature depends on open_memstream()and fmemopen(). They are
   provided by glibc. Without them, NeoMutt will simply create temporary
   files.

14.3. See Also

     * Compile-Time Features
     * fmemopen(3)

14.4. Known Bugs

   debian bug 834408

14.5. Credits

     * Julius Plenz <plenz@cis.fu-berlin.de>
     * Richard Russon <rich@flatcap.org>

15. Forgotten Attachment Feature

Alert user when (s)he forgets to attach a file to an outgoing email.

15.1. Support

   Since:NeoMutt 2016-09-10

   Dependencies:None

15.2. Introduction

   The "forgotten-attachment" feature provides a new setting for NeoMutt
   that alerts the user if the message body contains a certain keyword but
   there are no attachments added. This is meant to ensure that the user
   does not forget to attach a file after promising to do so in the mail.
   The attachment keyword will not be scanned in text matched by
   $quote_regex.

15.3. Variables

   Table 6.9. forgotten-attachment Variables
        Name             Type                       Default
   attach_keyword regular expression \\<(attach|attached|attachments?)\\>
   abort_noattach quadoption         no

15.4. neomuttrc

# Example NeoMutt config file for the forgotten-attachment feature.

# The 'forgotten-attachment' feature provides a new setting for NeoMutt that
# alerts the user if the message body contains a certain regular expression but
there are
# no attachments added. This is meant to ensure that the user does not forget
# to attach a file after promising to do so in the mail.

# Ask if the user wishes to abort sending if $attach_keyword is found in the
# body, but no attachments have been added
# It can be set to:
#    "yes"     : always abort
#    "ask-yes" : ask whether to abort
#    "no"      : send the mail
set abort_noattach = no
# Search for the following regular expression in the body of the email
# English: attach, attached, attachment, attachments
set attach_keyword = "\\<attach(|ed|ments?)\\>"
# Nederlands:
# set attach_keyword = "\\<(bijvoegen|bijgevoegd|bijlage|bijlagen)\\>"
# Deutsch:
# set attach_keyword = "\\<(anhaengen|angehaengt|anhang|anhaenge|haengt an)\\>"
# Franc,ais:
# set attach_keyword = "\\<(attache|attaches|attache|attachons|joint|jointe|join
ts|jointes|joins|joignons)\\>"
# vim: syntax=neomuttrc

15.5. See Also

     * The Attachment Menu
     * The Attachment Menu key mappings

15.6. Known Bugs

   None

15.7. Credits

     * Darshit Shah <darnir@gmail.com>
     * Richard Russon <rich@flatcap.org>
     * Johannes Weissl <jargon@molb.org>
     * Steven! Ragnaroek <steven@nuclearsandwich.com>

16. Global Hooks

Define actions to run globally within NeoMutt

16.1. Introduction

   These hooks are called when global events take place in NeoMutt.

   Run a command...
     * timeout-hook- periodically
     * startup-hook- when NeoMutt starts up, before opening the first
       mailbox
     * shutdown-hook- NeoMutt shuts down, before closing the last mailbox

16.1.1. Timeout Hook

Run a command periodically

   Since:NeoMutt 2016-08-08

   This feature implements a new hook that is called periodically when
   NeoMutt checks for new mail. This hook is called every $timeout
   seconds.

16.1.2. Startup Hook

Run a command when NeoMutt starts up, before opening the first mailbox

   Since:NeoMutt 2016-11-25

   This feature implements a new hook that is called when NeoMutt first
   starts up, but before opening the first mailbox. This is most likely to
   be useful to users of notmuch.

16.1.3. Shutdown Hook

Run a command when NeoMutt shuts down, before closing the last mailbox

   Since:NeoMutt 2016-11-25

   This feature implements a hook that is called when NeoMutt shuts down,
   but before closing the first mailbox. This is most likely to be useful
   to users of notmuch.

16.2. Commands

   timeout-hook NEOMUTT-COMMAND

   startup-hook NEOMUTT-COMMAND

   shutdown-hook NEOMUTT-COMMAND

16.3. neomuttrc

# Example NeoMutt config file for the global hooks feature.

# --------------------------------------------------------------------------
# COMMANDS - shown with an example argument
# --------------------------------------------------------------------------
# After $timeout seconds of inactivity, run this NeoMutt command
timeout-hook 'exec sync-mailbox'
# When NeoMutt first loads, run this NeoMutt command
startup-hook 'exec sync-mailbox'
# When NeoMutt quits, run this NeoMutt command
shutdown-hook 'exec sync-mailbox'

        # vim: syntax=neomuttrc

16.4. See Also

     * $timeout

16.5. Known Bugs

   None

16.6. Credits

     * Armin Wolfermann <armin@wolfermann.org>
     * Richard Russon <rich@flatcap.org>
     * Thomas Adam <thomas@xteddy.org>

17. Ifdef Feature

Conditional config options

17.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:None

17.2. Introduction

   The "ifdef" feature introduces three new commands to NeoMutt and allow
   you to share one config file between versions of NeoMutt that may have
   different features compiled in.
ifdef  symbol config-command [args...]  # If a symbol is defined
ifndef symbol config-command [args...]  # If a symbol is not defined
finish                                  # Finish reading the current file

   Here a symbol can be a $variable, <function>, command or compile-time
   symbol, such as "imap".

   A list of compile-time symbols can be seen in the output of the command
neomutt -v

   (in the "Compile options" section).

   finish is particularly useful when combined with ifndef. e.g.
# Sidebar config file
ifndef sidebar finish

17.3. Commands

   ifdef symbol "config-command [args]"
   ifndef symbol "config-command [args]"
   finish

17.4. neomuttrc

# Example NeoMutt config file for the ifdef feature.

# This feature introduces three useful commands which allow you to share
# one config file between versions of NeoMutt that may have different
# features compiled in.

#   ifdef  symbol config-command [args...]
#   ifndef symbol config-command [args...]
#   finish
# The 'ifdef' command tests whether NeoMutt understands the name of
# a variable, function, command or compile-time symbol.

# If it does, then it executes a config command.

# The 'ifndef' command tests whether a symbol does NOT exist.

# The 'finish' command tells NeoMutt to stop reading current config file.

# If the 'trash' variable exists, set it.
ifdef trash 'set trash=~/Mail/trash'
# If the 'tag-pattern' function exists, bind a key to it.
ifdef tag-pattern 'bind index <F6> tag-pattern'
# If the 'imap-fetch-mail' command exists, read my IMAP config.
ifdef imap-fetch-mail 'source ~/.neomutt/imap.rc'
# If the compile-time symbol 'sidebar' does not exist, then
# stop reading the current config file.
ifndef sidebar finish

        # vim: syntax=neomuttrc

17.5. Known Bugs

   None

17.6. Credits

     * Cedric Duval <cedricduval@free.fr>
     * Matteo F. Vescovi <mfvescovi@gmail.com>
     * Richard Russon <rich@flatcap.org>

18. Index Color Feature

Custom rules for theming the email index

18.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:
          status-color feature

18.2. Introduction

   The "index-color" feature allows you to specify colors for individual
   parts of the email index. e.g. Subject, Author, Flags.

   First choose which part of the index you'd like to color. Then, if
   needed, pick a pattern to match.

   Note: The pattern does not have to refer to the object you wish to
   color. e.g.
color index_author red default "~sneomutt"

   The author appears red when the subject (~s) contains "neomutt".

18.3. Colors

   All the colors default to default, i.e. unset.

   The index objects can be themed using the color command. Some objects
   require a pattern.
color index-object foreground background
color index-object foreground background pattern

   Table 6.10. Index Colors
        Object     Pattern                  Highlights
   index           yes     Entire index line
   index_author    yes     Author name, %A %a %F %L %n
   index_collapsed no      Number of messages in a collapsed thread, %M
   index_date      no      Date field
   index_flags     yes     Message flags, %S %Z
   index_label     no      Message label, %y %Y
   index_number    no      Message number, %C
   index_size      no      Message size, %c %l
   index_subject   yes     Subject, %s

18.4. neomuttrc

# Example NeoMutt config file for the index-color feature.

# Entire index line
color index white black '.*'
# Author name, %A %a %F %L %n
# Give the author column a dark grey background
color index_author default color234 '.*'
# Highlight a particular from (~f)
color index_author brightyellow color234 '~fRay Charles'
# Message flags, %S %Z
# Highlight the flags for flagged (~F) emails
color index_flags default red '~F'
# Subject, %s
# Look for a particular subject (~s)
color index_subject brightcyan default '~s\(closes #[0-9]+\)'
# Number of messages in a collapsed thread, %M
color index_collapsed default brightblue
# Date field
color index_date green default
# Message label, %y %Y
color index_label default brightgreen
# Message number, %C
color index_number red default
# Message size, %c %l
color index_size cyan default

        # vim: syntax=neomuttrc

18.5. See Also

     * Regular Expressions
     * Patterns
     * $index_format
     * Color command
     * Status-Color feature

18.6. Known Bugs

   None

18.7. Credits

     * Christian Aichinger <Greek0@gmx.net>
     * Christoph "Myon" Berg <myon@debian.org>
     * Elimar Riesebieter <riesebie@lxtec.de>
     * Eric Davis <edavis@insanum.com>
     * Vladimir Marek <Vladimir.Marek@oracle.com>
     * Richard Russon <rich@flatcap.org>

19. Initials Expando Feature

Expando for author's initials

19.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:None

19.2. Introduction

   The "initials" feature adds an expando (%I) for an author's initials.

   The index panel displays a list of emails. Its layout is controlled by
   the $index_format variable. Using this expando saves space in the index
   panel. This can be useful if you are regularly working with a small set
   of people.

19.3. Variables

   This feature has no config of its own. It adds an expando which can be
   used in the $index_format variable.

19.4. neomuttrc

# Example NeoMutt config file for the initials feature.

# The 'initials' feature has no config of its own.

# It adds an expando for an author's initials,
# which can be used in the 'index_format' variable.

# The default 'index_format' is:
set index_format='%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s'
# Where %L represents the author/recipient
# This might look like:
#       1   + Nov 17 David Bowie   Changesbowie    ( 689)
#       2   ! Nov 17 Stevie Nicks  Rumours         ( 555)
#       3   + Nov 16 Jimi Hendrix  Voodoo Child    ( 263)
#       4   + Nov 16 Debbie Harry  Parallel Lines  ( 540)
# Using the %I expando:
set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s'
# This might look like:
#       1   + Nov 17 DB Changesbowie    ( 689)
#       2   ! Nov 17 SN Rumours         ( 555)
#       3   + Nov 16 JH Voodoo Child    ( 263)
#       4   + Nov 16 DH Parallel Lines  ( 540)
# vim: syntax=neomuttrc

19.5. See Also

     * $index_format
     * index-color feature
     * folder-hook

19.6. Known Bugs

   None

19.7. Credits

     * Vsevolod Volkov <vvv@mutt.org.ua>
     * Richard Russon <rich@flatcap.org>

20. Kyoto Cabinet Feature

Kyoto Cabinet backend for the header cache

20.1. Support

   Since:NeoMutt 2016-10-02

   Dependencies:
          Kyoto Cabinet libraries

   To check if NeoMutt supports Kyoto Cabinet, look for
     * "kyoto" in the NeoMutt version.
     * "+hcache" in the compile options
     * "hcache backend: kyotocabinet" in the NeoMutt version

20.2. Introduction

   This feature adds support for using Kyoto Cabinet, the successor to
   Tokyo Cabinet, as a storage backend for NeoMutt's header cache
   (hcache). It is enabled at configure time with the
   --with-kyotocabinet=<path>switch.

20.3. See Also

     * Local Caching
     * Kyoto Cabinet

20.4. Known Bugs

   None

20.5. Credits

     * Clemens Lang <neverpanic@gmail.com>

21. Limit Current Thread Feature

Focus on one Email Thread

21.1. Support

   Since:NeoMutt 2016-03-28

   Dependencies:None

21.2. Introduction

   This feature adds a new way of using the Limit Command. The
   <limit-current-thread>function restricts the view to just the current
   thread. Setting the limit (the l key) to "all" will restore the full
   email list.

21.3. Functions

   Limit-current-thread adds the following function to NeoMutt. By
   default, it is not bound to a key.

   Table 6.11. Limit-Current-Thread Functions
   Menus        Function                Description
   index <limit-current-thread> Limit view to current thread

21.4. neomuttrc

# Example NeoMutt config file for the limit-current-thread feature.

# Limit view to current thread
bind index <esc>L limit-current-thread

        # vim: syntax=neomuttrc

21.5. Known Bugs

   None

21.6. Credits

     * David Sterba <dsterba@suse.cz>
     * Richard Russon <rich@flatcap.org>

22. LMDB Feature

LMDB backend for the header cache

22.1. Support

   Since:NeoMutt 2016-07-23

   Dependencies:None

22.2. Introduction

   This feature adds support for using LMDB as a storage backend for
   NeoMutt's header cache (hcache). It is enabled at configure time with
   the --with-lmdb=<path>switch.

Note

   It is not recommended to store the lmdb database on a shared drive.

22.3. See Also

     * Local Caching

22.4. Known Bugs

   None

22.5. Credits

     * Pietro Cerutti <gahr@gahr.ch>
     * Jan-Piet Mens <jp@mens.de>
     * Clemens Lang <neverpanic@gmail.com>

23. Multiple FCC Feature

Save multiple copies of outgoing mail

23.1. Support

   Since:NeoMutt 2016-08-08

   Dependencies:None

23.2. Introduction

   This feature allows the user to save outgoing emails in multiple
   folders.

   Folders should be listed separated by commas, but no spaces.

   The "fcc" field of an email can be set in two ways:
     * The <edit-fcc> command in the compose menu (default key: "f")
     * Creating a fcc-hook in your .neomuttrc

23.3. See Also

     * $record
     * fcc-hook

23.4. Known Bugs

   None

23.5. Credits

     * Omen Wild <omen@mandarb.com>
     * Richard Russon <rich@flatcap.org>

24. Nested If Feature

Allow complex nested conditions in format strings

24.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:None

24.2. Introduction

   NeoMutt's format strings can contain embedded if-then-else conditions.
   They are of the form:
%?VAR?TRUE&FALSE?

   If the variable "VAR" has a value greater than zero, print the "TRUE"
   string, otherwise print the "FALSE" string.

   e.g. %?S?Size: %S&Empty?

   Which can be read as:

   if (%S > 0) { print "Size: %S" } else { print "Empty" }

   These conditions are useful, but in NeoMutt they cannot be nested
   within one another. This feature uses the notation %<VAR?TRUE&FALSE>and
   allows them to be nested.

   The %<...>notation was used to format the current local time. but
   that's not really very useful since NeoMutt has no means of refreshing
   the screen periodically.

   A simple nested condition might be: (Some whitespace has been
   introduced for clarity)
%<x? %<y? XY & X > & %<y? Y & NONE > >  Conditions
     %<y? XY & X >                      x>0
          XY                            x>0,y>0
               X                        x>0,y=0

%<x? %<y? XY & X > & %<y? Y & NONE > >  Conditions
                     %<y? Y & NONE >    x=0
                          Y             x=0,y>0
                              NONE      x=0,y=0

   Equivalent to:

   if (x > 0) {
     if (y > 0) {
       print 'XY'
     } else {
       print 'X'
     }
   } else {
     if (y > 0) {
       print 'Y'
     } else {
       print 'NONE'
     }
   }

   Examples:
set index_format='%4C %Z %{%b %d} %-25.25n %s%> %<M?%M Msgs &%<l?%l Lines&%c Byt
es>>'

   if a thread is folded display the number of messages (%M)
   else if we know how many lines in the message display lines in message
   (%l)
   else display the size of the message in bytes (%c)
set index_format='%4C %Z %{%b %d} %-25.25n %<M?[%M] %s&%s%* %<l?%l&%c>>'

   if a thread is folded display the number of messages (%M) and the subje
   ct (%s)
   else if we know how many lines are in the message display subject (%s)
   and the lines in message (%l)
   else display the subject (%s) and the size of the message in bytes (%c)

Note

   If you wish to use angle brackets < > in a nested condition, then it's
   necessary to escape them, e.g.
set index_format='%<M?\<%M\>&%s>'

24.3. Variables

   The "nested-if" feature doesn't have any config of its own. It modifies
   the behavior of the format strings.

24.4. neomuttrc

# Example NeoMutt config file for the nested-if feature.

# This feature uses the format: '%<VAR?TRUE&FALSE>' for conditional
# format strings that can be nested.

# Example 1
# if a thread is folded
#       display the number of messages (%M)
# else if we know how many lines in the message
#       display lines in message (%l)
# else display the size of the message in bytes (%c)
set index_format='%4C %Z %{%b %d} %-25.25n %s%> %<M?%M Msgs &%<l?%l Lines&%c Byt
es>>'
# Example 2
# if a thread is folded
#       display the number of messages (%M)
#       display the subject (%s)
# else if we know how many lines in the message
#       display lines in message (%l)
# else
#       display the size of the message in bytes (%c)
set index_format='%4C %Z %{%b %d} %-25.25n %<M?[%M] %s&%s%* %<l?%l&%c>>'

        # vim: syntax=neomuttrc

24.5. See Also

     * cond-date feature
     * $index_format
     * $status_format

24.6. Known Bugs

   This feature is hard to understand

24.7. Credits

     * David Champion <dgc@uchicago.edu>
     * Richard Russon <rich@flatcap.org>
     * Aleksa Sarai <cyphar@cyphar.com>

25. New Mail Feature

Execute a command upon the receipt of new mail.

25.1. Support

   Since:NeoMutt 2016-07-23

   Dependencies:None

25.2. Introduction

   This feature enables the new_mail_command setting, which can be used to
   execute a custom script (e.g. a notification handler) upon receiving a
   new mail.

   The command string can contain expandos, such as %n for the number of
   new messages. For a complete list, see: $status_format.

Note

   When the notification is sent, the folder of the new mail is no longer
   known. This is a limitation of NeoMutt. The `%f` expando will show the
   open folder.

   For example in Linux you can use (most distributions already provide
   notify-send):
set new_mail_command="notify-send --icon='/home/santiago/Pictures/neomutt.png' '
New Email' '%n new messages, %u unread.' &"

   And in OS X you will need to install a command line interface for
   Notification Center, for example terminal-notifier:
set new_mail_command="terminal-notifier -title '%v' -subtitle 'New Mail' -messag
e '%n new messages, %u unread.' -activate 'com.apple.Terminal'"

25.3. Variables

   Table 6.12. New Mail Command Variables
         Name        Type  Default
   new_mail_command string (empty)

25.4. neomuttrc

# Example NeoMutt config file for the new-mail feature.

# --------------------------------------------------------------------------
# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
# Set the command you want NeoMutt to execute upon the receipt of a new email
set new_mail_command = ""
# Linux example:
# set new_command="notify-send --icon='/home/santiago/Pictures/neomutt.png' 'New
 Email in %f' '%n new messages, %u unread.' &"
# OS X example:
# set new_mail_command="terminal-notifier -title '%v' -subtitle 'New Mail in %f'
 -message '%n new messages, %u unread.' -activate 'com.apple.Terminal'"
# --------------------------------------------------------------------------
# vim: syntax=neomuttrc

25.5. See Also

     * folder-hook

25.6. Known Bugs

   None

25.7. Credits

     * Yoshiki Vazquez-Baeza <yoshiki@ucsd.edu>
     * Santiago Torres-Arias <santiago@nyu.edu>
     * Richard Russon <rich@flatcap.org>

26. NNTP Feature

Talk to a Usenet news server

26.1. Support

   Since:NeoMutt 2016-05-30

   Dependencies:None

26.2. Introduction

   Reading news via NNTP

   NeoMutt can read from a news server using NNTP.

   The default news server can be obtained from the $NNTPSERVER
   environment variable or from the /etc/nntpserver file. Like in other
   news readers, information about the subscribed newsgroups is saved in
   the file specified by the $newsrc variable. You can open a newsgroup
   with the function <change-newsgroup>

   The variable $news_cache_dir can be used to point to a directory.
   NeoMutt will create a hierarchy of subdirectories named like the
   account and newsgroup the cache is for. The hierarchy is also used to
   store header cache if NeoMutt was compiled with header cache support.

26.3. Variables

   Table 6.13. NNTP Variables
            Name          Type            Default
   ask_follow_up         boolean no
   ask_x_comment_to      boolean no
   catchup_newsgroup     quad    ask-yes
   followup_to_poster    quad    ask-yes
   group_index_format    string  %4C %M%N %5s %-45.45f %d
   inews                 string  (empty)
   mime_subject          boolean yes
   newsgroups_charset    string  utf-8
   newsrc                string  ~/.newsrc
   news_cache_dir        string  ~/.neomutt
   news_server           string  (empty)
   nntp_authenticators   string  (empty)
   nntp_context          number  1000
   nntp_listgroup        boolean yes
   nntp_load_description boolean yes
   nntp_pass             string  (empty)
   nntp_poll             number  60
   nntp_user             string  (empty)
   post_moderated        quad    ask-yes
   save_unsubscribed     boolean no
   show_new_news         boolean yes
   show_only_unread      boolean no
   x_comment_to          boolean no

26.4. Functions

   NNTP adds the following functions to NeoMutt. By default, none of them
   are bound to keys.

   Table 6.14. NNTP Functions
   Menus Function Description
   browser,index <catchup> mark all articles in newsgroup as read
   index,pager <change-newsgroup> open a different newsgroup
   compose <edit-followup-to> edit the Followup-To field
   compose <edit-newsgroups> edit the newsgroups list
   compose <edit-x-comment-to> edit the X-Comment-To field
   attach,index,pager <followup-message> followup to newsgroup
   index,pager <post-message> post message to newsgroup
   browser <reload-active> load list of all newsgroups from NNTP server
   browser <subscribe> subscribe to current mbox (IMAP/NNTP only)
   browser <subscribe-pattern> subscribe to newsgroups matching a pattern
   browser <uncatchup> mark all articles in newsgroup as unread
   browser <unsubscribe> unsubscribe from current mbox (IMAP/NNTP only)
   browser <unsubscribe-pattern> unsubscribe from newsgroups matching a
   pattern
   index,pager <change-newsgroup-readonly> open a different newsgroup in
   read only mode
   attach,index,pager <forward-to-group> forward to newsgroup
   index <get-children> get all children of the current message
   index <get-parent> get parent of the current message
   index <reconstruct-thread> reconstruct thread containing current
   message
   index <get-message> get message with Message-Id

26.5. neomuttrc

# Example NeoMutt config file for the nntp feature.

# --------------------------------------------------------------------------
# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
set ask_follow_up = no
set ask_x_comment_to = no
set catchup_newsgroup = ask-yes
set followup_to_poster = ask-yes
set group_index_format = '%4C %M%N %5s  %-45.45f %d'
set inews = ''
set mime_subject = yes
set newsgroups_charset = utf-8
set newsrc = '~/.newsrc'
set news_cache_dir = '~/.neomutt'
set news_server = ''
set nntp_authenticators = ''
set nntp_context = 1000
set nntp_listgroup = yes
set nntp_load_description = yes
set nntp_pass = ''
set nntp_poll = 60
set nntp_user = ''
set post_moderated = ask-yes
set save_unsubscribed = no
set show_new_news = yes
set show_only_unread = no
set x_comment_to = no
# --------------------------------------------------------------------------
# FUNCTIONS - shown with an example mapping
# --------------------------------------------------------------------------
# mark all articles in newsgroup as read
bind browser,index y catchup
# open a different newsgroup
bind index,pager i change-newsgroup
# edit the Followup-To field
bind compose o edit-followup-to
# edit the newsgroups list
bind compose N edit-newsgroups
# edit the X-Comment-To field
bind compose x edit-x-comment-to
# followup to newsgroup
bind attach,index,pager F followup-message
# post message to newsgroup
bind index,pager P post-message
# load list of all newsgroups from NNTP server
bind browser g reload-active
# subscribe to current mbox (IMAP/NNTP only)
bind browser s subscribe
# subscribe to newsgroups matching a pattern
bind browser S subscribe-pattern
# mark all articles in newsgroup as unread
bind browser Y uncatchup
# unsubscribe from current mbox (IMAP/NNTP only)
bind browser u unsubscribe
# unsubscribe from newsgroups matching a pattern
bind browser U unsubscribe-pattern
# open a different newsgroup in read only mode
bind index,pager \ei change-newsgroup-readonly
# forward to newsgroup
bind attach,index,pager \eF forward-to-group
# get all children of the current message
# bind index ??? get-children
# get parent of the current message
bind index \eG get-parent
# reconstruct thread containing current message
# bind index ??? reconstruct-thread
# get message with Message-Id
bind index \CG get-message
# --------------------------------------------------------------------------
# vim: syntax=neomuttrc

26.6. Known Bugs

   None

26.7. Credits

     * Vsevolod Volkov <vvv@mutt.org.ua>
     * Felix von Leitner <leitner@fefe.de>
     * Richard Russon <rich@flatcap.org>

27. Custom backend based Tags Feature

Implements Notmuch tags and Imap keywords

27.1. Support

   Since:NeoMutt 2017-10-16

   Dependencies:
     * quasi-delete feature
     * index-color feature

27.2. Introduction

   Some backends allow to index and tags mail without storing the tags
   within the mail envelope. Two backends are currently implementing this
   feature. Notmuch handles them natively and IMAP stores them in custom
   IMAP keywords.

27.3. Variables

   Table 6.15. Custom tags Variables
       Name     Type  Default
   hidden_tags string
   unread,draft,flagged,passed,replied,attachment,signed,encrypted

27.4. Functions

   Notmuch adds the following functions to NeoMutt. By default, none of
   them are bound to keys.

   Table 6.16. Notmuch/IMAP Functions
   Menus Function Description
   index,pager <modify-labels> add, remove, or toggle tags: IMAP: edit the
   tags list Notmuch: [+]<tag> to add, -<tag> to remove, !<tag> to
   toggle(notmuch) tags. Note: Tab completion of tag names is available
   index,pager <modify-labels-then-hide> add, remove, or toggle tags IMAP:
   edit the tags list Notmuch: [+]<tag> to add, -<tag> to remove, !<tag>
   to toggle labels and then hide or unhide the message by changing the
   "quasi-deleted" to match if it would be shown when requerying. Normal
   redisplay rules apply here, so the user must call <sync-mailbox> for
   the changes to be displayed. Note: Tab completion of tag names is
   available.

27.5. Commands

   tag-transforms tag transformed-string { tag transformed-string ...}
   tag-formats tag format-string { tag format-string ...}

27.6. Colors

   Adds these to index-color feature:

   Table 6.17. Index Colors
     Object   Pattern                  Highlights
   index_tag  yes     an individual message tag, %G, uses tag name
   index_tags no      the transformed message tags, %g or %J

27.7. neomuttrc

# Example NeoMutt config file for the custom tags feature.

# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
# This variable specifies private notmuch tags which should not be printed
# on screen (index, pager).
set nm_hidden_tags = "unread,draft,flagged,passed,replied,attachment,signed,encr
ypted"
# --------------------------------------------------------------------------
# FUNCTIONS - shown with an example mapping
# --------------------------------------------------------------------------
# modify (notmuch/imap) tags
bind index,pager \` modify-labels
# modify (notmuch/imap) tag non-interactively.
bind index,pager tt "<modify-labels>!todo\n" "Toggle the 'todo' tag"
# modify labels and then hide message
# bind index,pager ??? modify-labels-then-hide
# --------------------------------------------------------------------------
# COMMANDS - shown with an example
# --------------------------------------------------------------------------
# Replace some tags with icons
# tag-transforms tag transformed-string { tag transformed-string ...}
# tag-transforms "inbox"   "i"   \
#                "unread"  "u"   \
#                "replied" ">u "  \
#                "sent"    "-> "  \
#                "todo"    "T"   \
#                "deleted" "DEL" \
#                "invites" "CAL"

# The formats must start with 'G' and the entire sequence is case sensitive.
# tag-formats tag format-string { tag format-string ...}
# tag-formats "inbox"   "GI" \
#              "unread"  "GU" \
#              "replied" "GR" \
#              "sent"    "GS" \
#              "todo"    "Gt" \
#              "deleted" "GD" \
#              "invites" "Gi"

# Now instead of using '%g' or '%J' in your $index_format, which lists all tags
# in a non-deterministic order, you can something like the following which puts
# a transformed tag name in a specific spot on the index line:
# set index_format='%4C %S %[%y.%m.%d] %-18.18n %?GU?%GU& ? %?GR?%GR& ? %?GI?%GI
& ? %s'

# The %G formatting sequence may display all tags including tags hidden by
# nm_hidden_tags.
#
# --------------------------------------------------------------------------
# COLORS - some unpleasant examples are given
# --------------------------------------------------------------------------
# These symbols are added to the index-color feature:
# an individual message tag, %G, uses tag name
# this symbol uses a pattern
color index_tag red white "inbox"
# the transformed message tags, %g
# this symbol does not use a pattern
color index_tags green default
# --------------------------------------------------------------------------
# vim: syntax=neomuttrc

27.8. Credits

     * Mehdi Abaakouk <sileht@sileht.net>
     * Richard Russon <rich@flatcap.org>
     * Bernard 'Guyzmo' Pratz <guyzmo+github+pub@m0g.net>

28. Notmuch Feature

Email search engine

28.1. Support

   Since:NeoMutt 2016-03-17

   Dependencies:
     * quasi-delete feature
     * index-color feature
     * Notmuch libraries

28.2. Introduction

   Notmuch is an email fulltext indexing and tagging engine.
     * For more information, see: https://notmuchmail.org/
     * More examples: https://notmuchmail.org/mutttips/

28.3. Using Notmuch

28.3.1. Folders URI

   notmuch://[<path>][?<item>=<name>[& ...]]

   The <path> is an absolute path to the directory where the notmuch
   database is found as returned by "notmuch config get database.path"
   command. Note that the <path> should NOT include .notmuch directory
   name.

   If the "<path>" is not defined then $nm_default_uri or $folder is used,
   for example:
set nm_default_uri = "notmuch:///home/foo/maildir"
virtual-mailboxes "My INBOX" "notmuch://?query=tag:inbox"

28.3.2. Items

   query=<string>

   See SEARCH SYNTAX in notmuch man page. Don't forget to use operators (
   "and"/ "or") in your queries.

   Note that proper URI should not contain blank space and all "bad" chars
   should be encoded, for example

   tag:AAA and tag:BBB--encoding-> tag:AAA%20and%20tag:BBB

   but NeoMutt config file parser is smart enough to accept space in
   quoted strings. It means that you can use

   notmuch:///foo?query=tag:AAA and tag:BBB

   in your config files to keep things readable.

   For more details about Xapian queries, see:
   https://xapian.org/docs/queryparser.html

   limit=<number>

   Restricts number of messages/threads in the result. The default limit
   is nm_db_limit.

   type=<threads|messages>

   Reads all matching messages or whole-threads. The default is 'messages'
   or nm_query_type.

28.3.3. Format String for the Notmuch Browser

   Default:

               %2C %?n?%4n/& ?%4m %f

   This variable allows you to customize the browser display to your
   personal taste. This string is similar to $index_format, but has its
   own set of printf(3)-like sequences:
   %C  current file number
   %f  folder name (description)
   %m  number of messages in the mailbox *
   %n  number of unread messages in the mailbox *
   %N  N if mailbox has new mail, blank otherwise
   %>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.

   * = can be optionally printed if nonzero

28.4. Variables

   Table 6.18. Notmuch Variables
          Name        Type     Default
   nm_db_limit       number  0
   nm_default_uri    string  (empty)
   nm_exclude_tags   string  (empty)
   nm_open_timeout   number  5
   nm_query_type     string  messages
   nm_record         boolean no
   nm_record_tags    string  (empty)
   nm_unread_tag     string  unread
   vfolder_format    string  %6n(%6N) %f
   virtual_spoolfile boolean no

   More variables about tags configuration can be found in Custom backend
   Tags Feature

28.5. Functions

   Notmuch adds the following functions to NeoMutt. By default, none of
   them are bound to keys.

   Table 6.19. Notmuch Functions
   Menus Function Description
   index,pager <change-vfolder> switch to another virtual folder, a new
   folder maybe be specified by vfolder description (see
   virtual-mailboxes) or URI. the default is next vfolder with unread
   messages
   index,pager <entire-thread> read entire thread of the current message
   index,pager <sidebar-toggle-virtual> toggle between mailboxes and
   virtual mailboxes
   index,pager <vfolder-from-query> generate virtual folder from notmuch
   search query. Note: TAB completion of 'tag:' names is available.
   index,pager <vfolder-window-forward> generate virtual folder by moving
   the query's time window forward
   index,pager <vfolder-window-backward> generate virtual folder by moving
   the query's time window backward

   More functions about tags can be found in Custom backend Tags Feature

28.6. Commands

   virtual-mailboxes description notmuch-URI { description notmuch-URI
   ...}
   unvirtual-mailboxes { * | mailbox ... }

   More commands about tags can be found in Custom backend Tags Feature

28.7. Colors

   See Custom backend Tags colors

28.8. neomuttrc

# Example NeoMutt config file for the notmuch feature.

# --------------------------------------------------------------------------
# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
# This variable specifies notmuch query limit.
set nm_db_limit = 0
# This variable specifies the default Notmuch database in format:
# notmuch://<absolute path>
set nm_default_uri = ""
# The messages tagged with these tags are excluded and not loaded
# from notmuch DB to NeoMutt unless specified explicitly.
set nm_exclude_tags = ""
# This option specifies timeout for Notmuch database. Default is 5 seconds.
set nm_open_timeout = 5
# This variable specifies notmuch query type, supported types: 'threads' and
# 'messages'.
set nm_query_type = messages
# Add messages stored to the NeoMutt record (see $record in the NeoMutt docs) al
so to notmuch DB. If you reply to an email then the new email inherits tags from
 the original email.

set nm_record = no
# Tags that should be removed or added to the to the messages stored in the NeoM
utt record.

example:
set record = "~/sent-mails"
set nm_record = yes
set nm_record_tags = "-inbox,archive,me"

set nm_record_tags = ""
# This variable specifies notmuch tag which is used for unread messages.
set nm_unread_tag = unread
# This variable allows you to customize the file browser display for virtual
# folders to your personal taste.
# %C   current folder number
# %f   folder name (description)
# %m   number of messages in the mailbox *
# %n   number of unread messages in the mailbox *
# %N   N if mailbox has new mail, blank otherwise
# %>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

set vfolder_format = "%6n(%6N) %f"
# When set, NeoMutt will use the first virtual mailbox (see virtual-mailboxes)
# as a spoolfile.
set virtual_spoolfile = no
# setup time window preferences
# first setup the duration, and then the time unit of that duration
# when set to 0 (the default) the search window feature is disabled
set nm_query_window_duration=2
set nm_query_window_timebase="week" # or "hour", "day", "week", "month", "year"
# --------------------------------------------------------------------------
# FUNCTIONS - shown with an example mapping
# --------------------------------------------------------------------------
# open a different virtual folder
bind index,pager X change-vfolder
# read entire thread of the current message
bind index,pager + entire-thread
# generate virtual folder from query
bind index,pager \eX vfolder-from-query
# generate virtual folder from query with time window
bind index,pager < vfolder-window-backward
bind index,pager > vfolder-window-forward
# toggle between mailboxes and virtual mailboxes
# bind index,pager ??? sidebar-toggle-virtual
# --------------------------------------------------------------------------
# COMMANDS - shown with an example
# --------------------------------------------------------------------------
# virtual-mailboxes description notmuch-URI { description notmuch-URI ...}
# virtual-mailboxes "Climbing" "notmuch://?query=climbing"
# unvirtual-mailboxes { * | mailbox ...}
#
# --------------------------------------------------------------------------
# vim: syntax=neomuttrc

28.9. See Also

     * Compile-Time Features

28.10. Known Bugs

   None

28.11. Credits

     * Karel Zak <kzak@redhat.com>
     * Chris Mason <clm@fb.com>
     * Christoph Rissner <cri@visotech.at>
     * David Riebenbauer <davrieb@liegesta.at>
     * David Sterba <dsterba@suse.cz>
     * David Wilson <dw@botanicus.net>
     * Don Zickus <dzickus@redhat.com>
     * Eric Davis <edavis@insanum.com>
     * Jan Synacek <jsynacek@redhat.com>
     * Jeremiah C. Foster <jeremiah@jeremiahfoster.com>
     * Josh Poimboeuf <jpoimboe@redhat.com>
     * Kirill A. Shutemov <kirill@shutemov.name>
     * Luke Macken <lmacken@redhat.com>
     * Mantas Mikulenas <grawity@gmail.com>
     * Patrick Brisbin <pbrisbin@gmail.com>
     * Philippe Le Brouster <plb@nebkha.net>
     * Raghavendra D Prabhu <rprabhu@wnohang.net>
     * Sami Farin <hvtaifwkbgefbaei@gmail.com>
     * Stefan Assmann <sassmann@kpanic.de>
     * Stefan Kuhn <p_regius@gmx.ch>
     * Tim Stoakes <tim@stoakes.net>
     * Vladimir Marek <Vladimir.Marek@oracle.com>
     * Victor Manuel Jaquez Leal <vjaquez@igalia.com>
     * Richard Russon <rich@flatcap.org>
     * Bernard 'Guyzmo' Pratz <guyzmo+github+pub@m0g.net>

29. Progress Bar Feature

Show a visual progress bar on slow operations

29.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:None

29.2. Introduction

   The "progress" feature shows a visual progress bar on slow tasks, such
   as indexing a large folder over the net.

29.3. Colors

   Table 6.20. Progress Colors
     Name   Default Color     Description
   progress default       Visual progress bar

29.4. neomuttrc

# Example NeoMutt config file for the progress feature.

# The 'progress' feature provides clear visual feedback for
# slow tasks, such as indexing a large folder over the net.

# Set the color of the progress bar
# White text on a red background
color progress white red

        # vim: syntax=neomuttrc

29.5. See Also

     * Color command

29.6. Known Bugs

   None

29.7. Credits

     * Rocco Rutte <pdmef@gmx.net>
     * Vincent Lefevre <vincent@vinc17.org>
     * Stefan Kuhn <wuodan@hispeed.ch>
     * Karel Zak <kzak@redhat.com>
     * Richard Russon <rich@flatcap.org>

30. Quasi-Delete Feature

Mark emails that should be hidden, but not deleted

30.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:None

30.2. Introduction

   The "quasi-delete" function marks an email that should be hidden from
   the index, but NOT deleted. The email will disappear from the index
   when <sync-mailbox> is called.

   On its own, this feature isn't very useful. It forms a useful part of
   the notmuch plugin.

30.3. Functions

   Table 6.21. Quasi-Delete Functions
   Menus Default Key Function Description
   index,pager (none) <quasi-delete> delete from NeoMutt, don't touch on
   disk

30.4. neomuttrc

# Example NeoMutt config file for the quasi-delete feature.

# The 'quasi-delete' function marks an email that should be hidden
# from the index, but NOT deleted.
bind index,pager Q quasi-delete

        # vim: syntax=neomuttrc

30.5. See Also

     * notmuch feature

30.6. Known Bugs

   None

30.7. Credits

     * Karel Zak <kzak@redhat.com>
     * Richard Russon <rich@flatcap.org>

31. Reply With X-Original-To Feature

Direct reply to email using X-Original-To header

31.1. Support

   Since:NeoMutt 2016-09-10

   Dependencies:None

31.2. Introduction

   Adds a reply_with_xorig for NeoMutt configuration files. If enabled,
   allows to reply to an email using the email address in the first
   X-Original-To: header of a mail as the From: header of the answer.

31.3. Variables

   Table 6.22. Reply With X-Original-To Variables
         Name        Type   Default
   reply_with_xorig Boolean no

31.4. neomuttrc

# Example NeoMutt config file for the reply-with-xorig feature.

# --------------------------------------------------------------------------
# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
# Use X-Original-To header to reply when reverse is disabled or no alternate
# is found.
set reply_with_xorig = "yes"

        # vim: syntax=neomuttrc

31.5. Credits

     * Pierre-Elliott Becue <becue@crans.org>

32. Sensible Browser Feature

Make the file browser behave

32.1. Support

   Since:NeoMutt 2016-09-10

   Dependencies:None

32.2. Introduction

   The "sensible browser" is a set of small changes to NeoMutt's mailbox
   browser which make the browser behave in a more predictable way.

   The behavior is divided into two use cases: Fixed Order; Variable
   Order.

32.2.1. A Fixed Order of Mailboxes

   This is for users who like their mailboxes in a fixed order, e.g.
   alphabetical, or unsorted (in the order of the config file).
# Fixed order
set sort_browser="alpha"
set sort_browser="unsorted"

   When you first start the browser, e.g. c?your current mailbox will be
   highlighted.

   When you navigate to a parent mailbox ( "..") your old mailbox will be
   highlighted.

   ".."will always be listed at the top, however the rest of the list is
   sorted.

32.2.2. A Variable Order of Mailboxes

   This is for users who like their mailboxes sorted by a characteristic
   that changes, e.g. count of new mail, or the size of mailbox.
# Variable order
set sort_browser="reverse-count"
set sort_browser="reverse-size"

   When you first start the browser, e.g. c?the highlight will be on the
   first mailbox, e.g. the one with the most new mail.

   When you navigate to a parent mailbox ( "..") your old mailbox will be
   highlighted.

   ".."will always be listed at the top, however the rest of the list is
   sorted.

32.3. See Also

     * $folder_format

32.4. Known Bugs

   None

32.5. Credits

     * Pierre-Elliott Becue <becue@crans.org>
     * Haakon Riiser <haakon.riiser@fys.uio.no>
     * Richard Russon <rich@flatcap.org>

33. Sidebar Feature

Overview of mailboxes

33.1. Support

   Since:NeoMutt 2016-09-10, NeoMutt 1.7.0

   Dependencies:None

33.2. Introduction

   The Sidebar shows a list of all your mailboxes. The list can be turned
   on and off, it can be themed and the list style can be configured.

   This part of the manual is a reference guide. If you want a simple
   introduction with examples see the Sidebar Howto. If you just want to
   get started, you could use the sample Sidebar neomuttrc.

33.3. Variables

   Table 6.23. Sidebar Variables
             Name           Type      Default
   sidebar_delim_chars     string  /.
   sidebar_divider_char    string  |
   sidebar_folder_indent   boolean no
   sidebar_format          string  %B%* %n
   sidebar_indent_string   string    (two spaces)
   sidebar_new_mail_only   boolean no
   sidebar_next_new_wrap   boolean no
   sidebar_on_right        boolean no
   sidebar_short_path      boolean no
   sidebar_component_depth number  0
   sidebar_sort_method     enum    unsorted
   sidebar_visible         boolean no
   sidebar_width           number  20

   For more details, and examples, about the $sidebar_format, see the
   Sidebar Intro.

33.4. Functions

   Sidebar adds the following functions to NeoMutt. By default, none of
   them are bound to keys.

   Table 6.24. Sidebar Functions
   Menus Function Description
   index,pager <sidebar-next> Move the highlight to next mailbox
   index,pager <sidebar-next-new> Move the highlight to next mailbox with
   new mail
   index,pager <sidebar-open> Open highlighted mailbox
   index,pager <sidebar-page-down> Scroll the Sidebar down 1 page
   index,pager <sidebar-page-up> Scroll the Sidebar up 1 page
   index,pager <sidebar-prev> Move the highlight to previous mailbox
   index,pager <sidebar-prev-new> Move the highlight to previous mailbox
   with new mail
   index,pager <sidebar-toggle-visible> Make the Sidebar (in)visible

33.5. Commands

   sidebar_whitelist mailbox [ mailbox ...]
   unsidebar_whitelist { * | mailbox ... }

   This command specifies mailboxes that will always be displayed in the
   sidebar, even if $sidebar_new_mail_only is set and the mailbox does not
   contain new mail.

   The "unsidebar_whitelist" command is used to remove a mailbox from the
   list of whitelisted mailboxes. Use "unsidebar_whitelist *"to remove all
   mailboxes.

33.6. Colors

   Table 6.25. Sidebar Colors
   Name Default Color Description
   sidebar_divider default The dividing line between the Sidebar and the
   Index/Pager panels
   sidebar_flagged default Mailboxes containing flagged mail
   sidebar_highlight underline Cursor to select a mailbox
   sidebar_indicator neomutt indicator The mailbox open in the Index panel
   sidebar_new default Mailboxes containing new mail
   sidebar_ordinary default Mailboxes that have no new/flagged mails, etc.
   sidebar_spoolfile default Mailbox that receives incoming mail

   If the sidebar_indicator color isn't set, then the default NeoMutt
   indicator color will be used (the color used in the index panel).

33.7. Sort

   Table 6.26. Sidebar Sort
     Sort            Description
   alpha    Alphabetically by path
   count    Total number of messages
   flagged  Number of flagged messages
   name     Alphabetically by path
   new      Number of unread messages
   path     Alphabetically by path
   unread   Number of unread messages
   unsorted Order of the mailboxes command

33.8. neomuttrc

# Example NeoMutt config file for the sidebar feature.

# --------------------------------------------------------------------------
# VARIABLES - shown with their default values
# --------------------------------------------------------------------------
# Should the Sidebar be shown?
set sidebar_visible = no
# How wide should the Sidebar be in screen columns?

# Note: Some characters, e.g. Chinese, take up two columns each.
set sidebar_width = 20
# Should the mailbox paths be abbreviated?
set sidebar_short_path = no
# Number of top-level mailbox path subdirectories to truncate for display
set sidebar_component_depth = 0
# When abbreviating mailbox path names, use any of these characters as path
# separators.  Only the part after the last separators will be shown.
# For file folders '/' is good.  For IMAP folders, often '.' is useful.
set sidebar_delim_chars = '/.'
# If the mailbox path is abbreviated, should it be indented?
set sidebar_folder_indent = no
# Indent mailbox paths with this string.
set sidebar_indent_string = '  '
# Make the Sidebar only display mailboxes that contain new, or flagged,
# mail.
set sidebar_new_mail_only = no
# Any mailboxes that are whitelisted will always be visible, even if the
# sidebar_new_mail_only option is enabled.
sidebar_whitelist '/home/user/mailbox1'
sidebar_whitelist '/home/user/mailbox2'
# When searching for mailboxes containing new mail, should the search wrap
# around when it reaches the end of the list?
set sidebar_next_new_wrap = no
# Show the Sidebar on the right-hand side of the screen
set sidebar_on_right = no
# The character to use as the divider between the Sidebar and the other NeoMutt
# panels.
set sidebar_divider_char = '|'
# Enable extended buffy mode to calculate total, new, and flagged
# message counts for each mailbox.
set mail_check_stats
# Display the Sidebar mailboxes using this format string.
set sidebar_format = '%B%?F? [%F]?%* %?N?%N/?%S'
# Sort the mailboxes in the Sidebar using this method:
#       count    - total number of messages
#       flagged  - number of flagged messages
#       new      - number of new messages
#       path     - mailbox path
#       unsorted - do not sort the mailboxes
set sidebar_sort_method = 'unsorted'
# --------------------------------------------------------------------------
# FUNCTIONS - shown with an example mapping
# --------------------------------------------------------------------------
# Move the highlight to the previous mailbox
bind index,pager \Cp sidebar-prev
# Move the highlight to the next mailbox
bind index,pager \Cn sidebar-next
# Open the highlighted mailbox
bind index,pager \Co sidebar-open
# Move the highlight to the previous page
# This is useful if you have a LOT of mailboxes.
bind index,pager <F3> sidebar-page-up
# Move the highlight to the next page
# This is useful if you have a LOT of mailboxes.
bind index,pager <F4> sidebar-page-down
# Move the highlight to the previous mailbox containing new, or flagged,
# mail.
bind index,pager <F5> sidebar-prev-new
# Move the highlight to the next mailbox containing new, or flagged, mail.
bind index,pager <F6> sidebar-next-new
# Toggle the visibility of the Sidebar.
bind index,pager B sidebar-toggle-visible
# --------------------------------------------------------------------------
# COLORS - some unpleasant examples are given
# --------------------------------------------------------------------------
# Note: All color operations are of the form:
#       color OBJECT FOREGROUND BACKGROUND
# Color of the current, open, mailbox
# Note: This is a general NeoMutt option which colors all selected items.
color indicator cyan black
# Color of the highlighted, but not open, mailbox.
color sidebar_highlight black color8
# Color of the divider separating the Sidebar from NeoMutt panels
color sidebar_divider color8 black
# Color to give mailboxes containing flagged mail
color sidebar_flagged red black
# Color to give mailboxes containing new mail
color sidebar_new green black
# Color to give mailboxes containing no new/flagged mail, etc.
color sidebar_ordinary color245 default
# --------------------------------------------------------------------------
# vim: syntax=neomuttrc

33.9. See Also

     * Regular Expressions
     * Patterns
     * Color command
     * notmuch feature

33.10. Known Bugs

   None

33.11. Credits

     * Justin Hibbits <jrh29@po.cwru.edu>
     * Thomer M. Gil <mutt@thomer.com>
     * David Sterba <dsterba@suse.cz>
     * Evgeni Golov <evgeni@debian.org>
     * Fabian Groffen <grobian@gentoo.org>
     * Jason DeTiberus <jdetiber@redhat.com>
     * Stefan Assmann <sassmann@kpanic.de>
     * Steve Kemp <steve@steve.org.uk>
     * Terry Chan <tchan@lunar-linux.org>
     * Tyler Earnest <tylere@rne.st>
     * Richard Russon <rich@flatcap.org>

34. Skip Quoted Feature

Leave some context visible

34.1. Support

   Since:NeoMutt 2016-03-28

   Dependencies:None

34.2. Introduction

   When viewing an email, the <skip-to-quoted>function (by default the S
   key) will scroll past any email headers or quoted text. Sometimes, a
   little context is useful.

   By setting the $skip_quoted_offset variable, you can select how much of
   the quoted text is left visible.

34.3. Variables

   Table 6.27. Skip-Quoted Variables
          Name         Type  Default
   skip_quoted_offset number 0

34.4. neomuttrc

# Example NeoMutt config file for the skip-quoted feature.

# The 'S' (skip-quoted) command scrolls the pager past the quoted text (usually
# indented with '> '.  Setting 'skip_quoted_offset' leaves some lines of quoted
# text on screen for context.

# Show three quoted lines before the reply
set skip_quoted_offset = 3

        # vim: syntax=neomuttrc

34.5. Known Bugs

   None

34.6. Credits

     * David Sterba <dsterba@suse.cz>
     * Richard Russon <rich@flatcap.org>

35. Status Color Feature

Custom rules for theming the status bar

35.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:None

35.2. Introduction

   The "status-color" feature allows you to theme different parts of the
   status bar (also when it's used by the index).

   Unlike normal color commands, color status can now take up to 2 extra
   parameters (regex, num).

35.3. Commands

   color status foreground background [ regex [ num ]]

   With zero parameters, NeoMutt will set the default color for the entire
   status bar.

   With one parameter, NeoMutt will only color the parts matching the
   regex.

   With two parameters, NeoMutt will only color the num'th sub-match of
   the regex.

35.4. Colors

   Table 6.28. Status Colors
    Name  Default Color Description
   status reverse       Status bar

35.5. neomuttrc

# Example NeoMutt config file for the status-color feature.

# The 'status-color' feature allows you to theme different parts of
# the status bar (also when it's used by the index).

# For the examples below, set some defaults
set status_format='-%r-NeoMutt: %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)---'
set index_format='%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s'
set sort=threads
set sort_aux=last-date-received
# 'status color' can take up to 2 extra parameters
# color status foreground background [ regex [ num ]]
# 0 extra parameters
# Set the default color for the entire status line
color status blue white
# 1 extra parameter
# Set the color for a matching pattern
# color status foreground background regex
# Highlight New, Deleted, or Flagged emails
color status brightred white '(New|Del|Flag):[0-9]+'
# Highlight mailbox ordering if it's different from the default
# First, highlight anything (*/*)
color status brightred default '\([^)]+/[^)]+\)'
# Then override the color for one specific case
color status default   default '\(threads/last-date-received\)'
# 2 extra parameters
# Set the color for the nth submatch of a pattern
# color status foreground background regex num
# Highlight the contents of the []s but not the [] themselves
color status red default '\[([^]]+)\]' 1
# The '1' refers to the first regex submatch, which is the inner
# part in ()s
# Highlight the mailbox
color status brightwhite default 'NeoMutt: ([^ ]+)' 1
# Search for 'NeoMutt: ' but only highlight what comes after it
# vim: syntax=neomuttrc

35.6. See Also

     * Compile-Time Features
     * Regular Expressions
     * Patterns
     * index-color feature
     * Color command

35.7. Known Bugs

   None

35.8. Credits

     * David Sterba <dsterba@suse.cz>
     * Thomas Glanzmann <thomas@glanzmann.de>
     * Kirill A. Shutemov <kirill@shutemov.name>
     * Richard Russon <rich@flatcap.org>

36. TLS-SNI Feature

Negotiate with a server for a TLS/SSL certificate

36.1. Support

   Since:NeoMutt 2016-03-07

   Dependencies:
          OpenSSL

36.2. Introduction

   The "TLS-SNI" feature adds support for TLS virtual hosting. If your
   mail server doesn't support this everything will still work normally.

   TLS supports sending the expected server hostname during the handshake,
   via the SNI extension. This can be used to select a server certificate
   to issue to the client, permitting virtual-hosting without requiring
   multiple IP addresses.

   This has been tested against Exim 4.80, which optionally logs SNI and
   can perform vhosting.

   To verify TLS SNI support by a server, you can use:
openssl s_client -host <imap server> -port <port> -tls1 -servername <imap server
>

36.3. Known Bugs

   None

36.4. Credits

     * Jeremy Katz <katzj@linuxpower.org>
     * Phil Pennock <mutt-dev@spodhuis.demon.nl>
     * Richard Russon <rich@flatcap.org>

37. Trash Folder Feature

Automatically move deleted emails to a trash bin

37.1. Support

   Since:NeoMutt 2016-09-10, NeoMutt 1.7.0

   Dependencies:
          If IMAP is enabled, the trash folder will use it wisely

37.2. Introduction

   In NeoMutt, when you "delete" an email it is first marked deleted. The
   email isn't really gone until <sync-mailbox>is called. This happens
   when the user leaves the folder, or the function is called manually.

   After <sync-mailbox>has been called the email is gone forever.

   The $trash variable defines a folder in which to keep old emails. As
   before, first you mark emails for deletion. When <sync-mailbox> is
   called the emails are moved to the trash folder.

   The $trash path can be either a full directory, or be relative to the
   $folder variable, like the mailboxes command.

Note

   Emails deleted from the trash folder are gone forever.

37.3. Variables

   Table 6.29. Trash Variables
   Name   Type  Default
   trash string (none)

37.4. Functions

   Table 6.30. Trash Functions
   Menus Default Key Function Description
   index,pager (none) <purge-message> really delete the current entry,
   bypassing the trash folder

37.5. neomuttrc

# Example NeoMutt config file for the 'trash' feature.

# This feature defines a new 'trash' folder.

# When mail is deleted it will be moved to this folder.

# Folder in which to put deleted emails
set trash='+Trash'
set trash='/home/flatcap/Mail/Trash'
# The default delete key 'd' will move an email to the 'trash' folder
# Bind 'D' to REALLY delete an email
bind index D purge-message
# Note: Deleting emails from the 'trash' folder will REALLY delete them.

# vim: syntax=neomuttrc

37.6. See Also

     * folder-hook

37.7. Known Bugs

   None

37.8. Credits

     * Cedric Duval <cedricduval@free.fr>
     * Benjamin Kuperman <kuperman@acm.org>
     * Paul Miller <paul@voltar.org>
     * Richard Russon <rich@flatcap.org>

Chapter 7. Security Considerations

   Table of Contents

   1. Passwords
   2. Temporary Files
   3. Information Leaks

        3.1. Message-Id: headers
        3.2. mailto:-style Links

   4. External Applications

   First of all, NeoMutt contains no security holes included by intention
   but may contain unknown security holes. As a consequence, please run
   NeoMutt only with as few permissions as possible. Especially, do not
   run NeoMutt as the super user.

   When configuring NeoMutt, there're some points to note about secure
   setups so please read this chapter carefully.

1. Passwords

   Although NeoMutt can be told the various passwords for accounts, please
   never store passwords in configuration files. Besides the fact that the
   system's operator can always read them, you could forget to mask it out
   when reporting a bug or asking for help via a mailing list. Even worse,
   your mail including your password could be archived by internet search
   engines, mail-to-news gateways etc. It may already be too late before
   you notice your mistake.

2. Temporary Files

   NeoMutt uses many temporary files for viewing messages, verifying
   digital signatures, etc. As long as being used, these files are visible
   by other users and maybe even readable in case of misconfiguration.
   Also, a different location for these files may be desired which can be
   changed via the $tmpdir variable.

3. Information Leaks

3.1. Message-Id: headers

   Message-Id: headers contain a local part that is to be created in a
   unique fashion. In order to do so, NeoMutt will "leak" some information
   to the outside world when sending messages: the generation of this
   header includes a step counter which is increased (and rotated) with
   every message sent. In a longer running NeoMutt session, others can
   make assumptions about your mailing habits depending on the number of
   messages sent. If this is not desired, the header can be manually
   provided using $edit_headers(though not recommended).

3.2.  mailto:-style Links

   As NeoMutt be can be set up to be the mail client to handle
   mailto:style links in websites, there're security considerations, too.
   Arbitrary header fields can be embedded in these links which could
   override existing header fields or attach arbitrary files using the
   Attach: pseudoheader. This may be problematic if the $edit-headers
   variable is unset, i.e. the user doesn't want to see header fields
   while editing the message and doesn't pay enough attention to the
   compose menu's listing of attachments.

   For example, following a link like
mailto:joe@host?Attach=~/.gnupg/secring.gpg

   will send out the user's private gnupg keyring to joe@host if the user
   doesn't follow the information on screen carefully enough.

   To prevent these issues, NeoMutt by default only accepts the Subject
   and Body headers. Allowed headers can be adjusted with the mailto_allow
   and unmailto_allow commands.

4. External Applications

   NeoMutt in many places has to rely on external applications or for
   convenience supports mechanisms involving external applications.

   One of these is the mailcap mechanism as defined by RFC1524. Details
   about a secure use of the mailcap mechanisms is given in Section 3.2,
   "Secure Use of Mailcap".

   Besides the mailcap mechanism, NeoMutt uses a number of other external
   utilities for operation, for example to provide crypto support, in
   backtick expansion in configuration files or format string filters. The
   same security considerations apply for these as for tools involved via
   mailcap.

Chapter 8. Performance Tuning

   Table of Contents

   1. Reading and Writing Mailboxes
   2. Reading Messages from Remote Folders
   3. Searching and Limiting

1. Reading and Writing Mailboxes

   NeoMutt's performance when reading mailboxes can be improved in two
   ways:
    1. For remote folders (IMAP and POP) as well as folders using
       one-file-per message storage (Maildir and MH), NeoMutt's
       performance can be greatly improved using header caching. using a
       single database per folder.
    2. NeoMutt provides the $read_inc and $write_inc variables to specify
       at which rate to update progress counters. If these values are too
       low, NeoMutt may spend more time on updating the progress counter
       than it spends on actually reading/writing folders.
       For example, when opening a maildir folder with a few thousand
       messages, the default value for $read_inc may be too low. It can be
       tuned on on a folder-basis using folder-hooks:
# use very high $read_inc to speed up reading hcache'd maildirs
folder-hook . 'set read_inc=1000'
# use lower value for reading slower remote IMAP folders
folder-hook ^imap 'set read_inc=100'
# use even lower value for reading even slower remote POP folders
folder-hook ^pop 'set read_inc=1'

   These settings work on a per-message basis. However, as messages may
   greatly differ in size and certain operations are much faster than
   others, even per-folder settings of the increment variables may not be
   desirable as they produce either too few or too much progress updates.
   Thus, NeoMutt allows to limit the number of progress updates per second
   it'll actually send to the terminal using the $time_inc variable.

2. Reading Messages from Remote Folders

   Reading messages from remote folders such as IMAP an POP can be slow
   especially for large mailboxes since NeoMutt only caches a very limited
   number of recently viewed messages (usually 10) per session (so that it
   will be gone for the next session.)

   To improve performance and permanently cache whole messages, please
   refer to NeoMutt's so-called body caching for details.

3. Searching and Limiting

   When searching mailboxes either via a search or a limit action, for
   some patterns NeoMutt distinguishes between regular expression and
   string searches. For regular expressions, patterns are prefixed with
   "~"and with "="for string searches.

   Even though a regular expression search is fast, it's several times
   slower than a pure string search which is noticeable especially on
   large folders. As a consequence, a string search should be used instead
   of a regular expression search if the user already knows enough about
   the search pattern.

   For example, when limiting a large folder to all messages sent to or by
   an author, it's much faster to search for the initial part of an e-mail
   address via =Luser@instead of ~Luser@. This is especially true for
   searching message bodies since a larger amount of input has to be
   searched.

   As for regular expressions, a lower case string search pattern makes
   NeoMutt perform a case-insensitive search except for IMAP (because for
   IMAP NeoMutt performs server-side searches which don't support
   case-insensitivity).

Chapter 9. Reference

   Table of Contents

   1. Command-Line Options
   2. Configuration Commands
   3. Configuration Variables

        3.1. abort_noattach
        3.2. abort_nosubject
        3.3. abort_unmodified
        3.4. alias_file
        3.5. alias_format
        3.6. allow_8bit
        3.7. allow_ansi
        3.8. arrow_cursor
        3.9. ascii_chars
        3.10. askbcc
        3.11. askcc
        3.12. ask_follow_up
        3.13. ask_x_comment_to
        3.14. assumed_charset
        3.15. attach_charset
        3.16. attach_format
        3.17. attach_keyword
        3.18. attach_sep
        3.19. attach_split
        3.20. attribution
        3.21. attribution_locale
        3.22. auto_tag
        3.23. autoedit
        3.24. beep
        3.25. beep_new
        3.26. bounce
        3.27. bounce_delivered
        3.28. braille_friendly
        3.29. catchup_newsgroup
        3.30. certificate_file
        3.31. change_folder_next
        3.32. charset
        3.33. check_mbox_size
        3.34. check_new
        3.35. collapse_unread
        3.36. collapse_flagged
        3.37. compose_format
        3.38. config_charset
        3.39. confirmappend
        3.40. confirmcreate
        3.41. connect_timeout
        3.42. content_type
        3.43. copy
        3.44. crypt_autoencrypt
        3.45. crypt_autopgp
        3.46. crypt_autosign
        3.47. crypt_autosmime
        3.48. crypt_confirmhook
        3.49. crypt_opportunistic_encrypt
        3.50. crypt_replyencrypt
        3.51. crypt_replysign
        3.52. crypt_replysignencrypted
        3.53. crypt_timestamp
        3.54. crypt_use_gpgme
        3.55. crypt_use_pka
        3.56. crypt_verify_sig
        3.57. date_format
        3.58. debug_level
        3.59. debug_file
        3.60. default_hook
        3.61. delete
        3.62. delete_untag
        3.63. digest_collapse
        3.64. display_filter
        3.65. dsn_notify
        3.66. dsn_return
        3.67. duplicate_threads
        3.68. edit_headers
        3.69. editor
        3.70. empty_subject
        3.71. encode_from
        3.72. entropy_file
        3.73. envelope_from_address
        3.74. escape
        3.75. fast_reply
        3.76. fcc_attach
        3.77. fcc_clear
        3.78. flag_safe
        3.79. folder
        3.80. folder_format
        3.81. followup_to
        3.82. followup_to_poster
        3.83. force_name
        3.84. forward_attribution_intro
        3.85. forward_attribution_trailer
        3.86. forward_decode
        3.87. forward_decrypt
        3.88. forward_edit
        3.89. forward_format
        3.90. forward_quote
        3.91. forward_references
        3.92. from
        3.93. from_chars
        3.94. gecos_mask
        3.95. group_index_format
        3.96. hdrs
        3.97. header
        3.98. header_cache
        3.99. header_cache_backend
        3.100. header_cache_compress
        3.101. header_color_partial
        3.102. help
        3.103. hidden_host
        3.104. hide_limited
        3.105. hide_missing
        3.106. hide_thread_subject
        3.107. hide_top_limited
        3.108. hide_top_missing
        3.109. history
        3.110. history_file
        3.111. history_remove_dups
        3.112. honor_disposition
        3.113. honor_followup_to
        3.114. hostname
        3.115. idn_decode
        3.116. idn_encode
        3.117. ignore_list_reply_to
        3.118. show_multipart_alternative
        3.119. imap_authenticators
        3.120. imap_check_subscribed
        3.121. imap_delim_chars
        3.122. imap_headers
        3.123. imap_idle
        3.124. imap_keepalive
        3.125. imap_list_subscribed
        3.126. imap_login
        3.127. imap_pass
        3.128. imap_passive
        3.129. imap_peek
        3.130. imap_pipeline_depth
        3.131. imap_poll_timeout
        3.132. imap_servernoise
        3.133. imap_user
        3.134. implicit_autoview
        3.135. include
        3.136. include_onlyfirst
        3.137. indent_string
        3.138. index_format
        3.139. inews
        3.140. ispell
        3.141. keep_flagged
        3.142. mail_check
        3.143. mail_check_recent
        3.144. mail_check_stats
        3.145. mail_check_stats_interval
        3.146. mailcap_path
        3.147. mailcap_sanitize
        3.148. maildir_header_cache_verify
        3.149. maildir_trash
        3.150. maildir_check_cur
        3.151. mark_macro_prefix
        3.152. mark_old
        3.153. markers
        3.154. mask
        3.155. mbox
        3.156. mbox_type
        3.157. menu_context
        3.158. menu_move_off
        3.159. menu_scroll
        3.160. message_cache_clean
        3.161. message_cachedir
        3.162. message_format
        3.163. meta_key
        3.164. metoo
        3.165. mh_purge
        3.166. mh_seq_flagged
        3.167. mh_seq_replied
        3.168. mh_seq_unseen
        3.169. mime_forward
        3.170. mime_forward_decode
        3.171. mime_forward_rest
        3.172. mime_subject
        3.173. mime_type_query_command
        3.174. mime_type_query_first
        3.175. move
        3.176. narrow_tree
        3.177. net_inc
        3.178. new_mail_command
        3.179. news_cache_dir
        3.180. news_server
        3.181. newsgroups_charset
        3.182. newsrc
        3.183. nntp_authenticators
        3.184. nntp_context
        3.185. nntp_listgroup
        3.186. nntp_load_description
        3.187. nntp_user
        3.188. nntp_pass
        3.189. nntp_poll
        3.190. pager
        3.191. hidden_tags
        3.192. pager_context
        3.193. pager_format
        3.194. pager_index_lines
        3.195. pager_stop
        3.196. pgp_auto_decode
        3.197. pgp_autoinline
        3.198. pgp_check_exit
        3.199. pgp_clearsign_command
        3.200. pgp_decode_command
        3.201. pgp_decrypt_command
        3.202. pgp_decryption_okay
        3.203. pgp_default_key
        3.204. pgp_encrypt_only_command
        3.205. pgp_encrypt_sign_command
        3.206. pgp_entry_format
        3.207. pgp_export_command
        3.208. pgp_getkeys_command
        3.209. pgp_good_sign
        3.210. pgp_ignore_subkeys
        3.211. pgp_import_command
        3.212. pgp_list_pubring_command
        3.213. pgp_list_secring_command
        3.214. pgp_long_ids
        3.215. pgp_mime_auto
        3.216. pgp_replyinline
        3.217. pgp_retainable_sigs
        3.218. pgp_self_encrypt
        3.219. pgp_show_unusable
        3.220. pgp_sign_as
        3.221. pgp_sign_command
        3.222. pgp_sort_keys
        3.223. pgp_strict_enc
        3.224. pgp_timeout
        3.225. pgp_use_gpg_agent
        3.226. pgp_verify_command
        3.227. pgp_verify_key_command
        3.228. pipe_decode
        3.229. pipe_sep
        3.230. pipe_split
        3.231. pop_auth_try_all
        3.232. pop_authenticators
        3.233. pop_checkinterval
        3.234. pop_delete
        3.235. pop_host
        3.236. pop_last
        3.237. pop_pass
        3.238. pop_reconnect
        3.239. pop_user
        3.240. post_indent_string
        3.241. post_moderated
        3.242. postpone
        3.243. postponed
        3.244. postpone_encrypt
        3.245. postpone_encrypt_as
        3.246. preconnect
        3.247. print
        3.248. print_command
        3.249. print_decode
        3.250. print_split
        3.251. prompt_after
        3.252. query_command
        3.253. query_format
        3.254. quit
        3.255. quote_regex
        3.256. read_inc
        3.257. read_only
        3.258. realname
        3.259. recall
        3.260. record
        3.261. reflow_space_quotes
        3.262. reflow_text
        3.263. reflow_wrap
        3.264. reply_regex
        3.265. reply_self
        3.266. reply_to
        3.267. reply_with_xorig
        3.268. resolve
        3.269. resume_draft_files
        3.270. resume_edited_draft_files
        3.271. reverse_alias
        3.272. reverse_name
        3.273. reverse_realname
        3.274. rfc2047_parameters
        3.275. save_address
        3.276. save_empty
        3.277. save_history
        3.278. save_name
        3.279. score
        3.280. score_threshold_delete
        3.281. score_threshold_flag
        3.282. score_threshold_read
        3.283. search_context
        3.284. send_charset
        3.285. sendmail
        3.286. sendmail_wait
        3.287. shell
        3.288. save_unsubscribed
        3.289. show_new_news
        3.290. show_only_unread
        3.291. sidebar_delim_chars
        3.292. sidebar_divider_char
        3.293. sidebar_folder_indent
        3.294. sidebar_format
        3.295. sidebar_indent_string
        3.296. sidebar_new_mail_only
        3.297. sidebar_next_new_wrap
        3.298. sidebar_on_right
        3.299. sidebar_short_path
        3.300. sidebar_sort_method
        3.301. sidebar_component_depth
        3.302. sidebar_visible
        3.303. sidebar_width
        3.304. sig_dashes
        3.305. sig_on_top
        3.306. signature
        3.307. simple_search
        3.308. skip_quoted_offset
        3.309. sleep_time
        3.310. smart_wrap
        3.311. smileys
        3.312. smime_ask_cert_label
        3.313. smime_ca_location
        3.314. smime_certificates
        3.315. smime_decrypt_command
        3.316. smime_decrypt_use_default_key
        3.317. smime_default_key
        3.318. smime_encrypt_command
        3.319. smime_encrypt_with
        3.320. smime_get_cert_command
        3.321. smime_get_cert_email_command
        3.322. smime_get_signer_cert_command
        3.323. smime_import_cert_command
        3.324. smime_is_default
        3.325. smime_keys
        3.326. smime_pk7out_command
        3.327. smime_self_encrypt
        3.328. smime_sign_as
        3.329. smime_sign_command
        3.330. smime_sign_digest_alg
        3.331. smime_timeout
        3.332. smime_verify_command
        3.333. smime_verify_opaque_command
        3.334. smtp_authenticators
        3.335. smtp_pass
        3.336. smtp_url
        3.337. sort
        3.338. sort_alias
        3.339. sort_aux
        3.340. sort_browser
        3.341. sort_re
        3.342. spam_separator
        3.343. spoolfile
        3.344. ssl_client_cert
        3.345. ssl_force_tls
        3.346. ssl_starttls
        3.347. ssl_use_sslv2
        3.348. ssl_use_sslv3
        3.349. ssl_use_tlsv1
        3.350. ssl_use_tlsv1_1
        3.351. ssl_use_tlsv1_2
        3.352. ssl_usesystemcerts
        3.353. ssl_verify_dates
        3.354. ssl_verify_host
        3.355. ssl_verify_partial_chains
        3.356. ssl_ciphers
        3.357. status_chars
        3.358. status_format
        3.359. status_on_top
        3.360. strict_threads
        3.361. suspend
        3.362. text_flowed
        3.363. thorough_search
        3.364. thread_received
        3.365. tilde
        3.366. time_inc
        3.367. timeout
        3.368. tmpdir
        3.369. to_chars
        3.370. flag_chars
        3.371. trash
        3.372. ts_icon_format
        3.373. ts_enabled
        3.374. ts_status_format
        3.375. tunnel
        3.376. uncollapse_jump
        3.377. uncollapse_new
        3.378. use_8bitmime
        3.379. use_domain
        3.380. use_envelope_from
        3.381. use_from
        3.382. use_ipv6
        3.383. user_agent
        3.384. visual
        3.385. wait_key
        3.386. weed
        3.387. wrap
        3.388. wrap_headers
        3.389. wrap_search
        3.390. write_bcc
        3.391. write_inc
        3.392. x_comment_to
        3.393. collapse_all

   4. Functions

        4.1. Generic Menu
        4.2. Index Menu
        4.3. Pager Menu
        4.4. Alias Menu
        4.5. Query Menu
        4.6. Attachment Menu
        4.7. Compose Menu
        4.8. Postpone Menu
        4.9. Browser Menu
        4.10. Pgp Menu
        4.11. Editor Menu

1. Command-Line Options

   Running neomutt with no arguments will make NeoMutt 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 9.1. Command line options
   Option Description
   -A expand an alias
   -a attach a file to a message
   -b specify a blind carbon-copy (BCC) address
   -c specify a carbon-copy (Cc) address
   -d log debugging output to ~/.neomuttdebug0 if NeoMutt was compiled
   with +debug; it can range from 1-5 and affects verbosity (a value of 2
   is recommended)
   -D print the value of all NeoMutt variables to stdout
   -D -S like -D but hide the value of sensitive variables
   -E edit the draft (-H) or include (-i) file
   -e specify a config command to be run after initialization files are
   read
   -f specify a mailbox to load
   -F specify an alternate file to read initialization commands
   -h print help on command line options
   -H specify a draft file from which to read a header and body
   -i specify a file to include in a message composition
   -m specify a default mailbox type
   -n do not read the system neomuttrc
   -p recall a postponed message
   -Q query a configuration variable
   -R open mailbox in read-only mode
   -s specify a subject (enclose in quotes if it contains spaces)
   -v show version number and compile-time definitions
   -x simulate the mailx(1) compose mode
   -y show a menu containing the files specified by the mailboxes command
   -z exit immediately if there are no messages in the mailbox
   -Z open the first folder with new message, exit immediately if none

   To read messages in a mailbox

   neomutt [ -nz ] [ -F neomuttrc ] [ -m type ] [ -f mailbox ]

   To compose a new message

   neomutt [ -En ] [ -F neomuttrc ] [ -c address ] [ -Hi filename ] [ -s
   subject ] [ -a file [...]--] address | mailto_url ...

   NeoMutt also supports a "batch" mode to send prepared messages. Simply
   redirect input from the file you wish to send. For example,
neomutt -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".

   An include file passed with -i will be used as the body of the message.
   When combined with -E, the include file will be directly edited during
   message composition. The file will be modified regardless of whether
   the message is sent or aborted.

   A draft file passed with -H will be used as the initial header and body
   for the message. Multipart messages can be used as a draft file. When
   combined with -E, the draft file will be updated to the final state of
   the message after composition, regardless of whether the message is
   sent, aborted, or even postponed. Note that if the message is sent
   encrypted or signed, the draft file will be saved that way too.

   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:
neomutt -a image.png -- some@one.org

   or
neomutt -a *.png -- some@one.org

Note

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

   In addition to accepting a list of email addresses, NeoMutt also
   accepts a URL with the mailto:schema as specified in RFC2368. This is
   useful when configuring a web browser to launch NeoMutt when clicking
   on mailto links.
neomutt mailto:some@one.org?subject=test&cc=other@one.org

2. Configuration Commands

   The following are the commands understood by NeoMutt:
     * account-hook regex command
     * alias [ -group name ...] key address [ address ...]
       unalias [ -group name ...] { * | key ... }
     * alternates [ -group name ...] regex [ regex ...]
       unalternates [ -group name ...] { * | regex ... }
     * alternative_order mimetype [ mimetype ...]
       unalternative_order { * | mimetype ... }
     * attachments { + | - }disposition mime-type
       unattachments { + | - }disposition mime-type
     * append-hook pattern shell-command
     * auto_view mimetype [ mimetype ...]
       unauto_view { * | mimetype ... }
     * bind map key function
     * charset-hook alias charset
     * iconv-hook charset local-charset
     * close-hook pattern shell-command
     * color object foreground background
       color { header | body } foreground background regex
       color index foreground background pattern
       uncolor { index | header | body } { * | pattern ... }
     * open-hook pattern shell-command
     * crypt-hook regex keyid
     * exec function [ function ...]
     * fcc-hook [!]pattern mailbox
     * fcc-save-hook [!]pattern mailbox
     * folder-hook [!]regex command
     * group [ -group name ...] { -rx expr ... | -addr expr ... }
       ungroup [ -group name ...] { * | -rx expr ... | -addr expr ... }
     * hdr_order header [ header ...]
       unhdr_order { * | header ... }
     * ifdef item "config-command [args]"
     * ignore pattern [ pattern ...]
       unignore { * | pattern ... }
     * lists [ -group name ] regex [ regex ...]
       unlists [ -group name ...] { * | regex ... }
     * macro menu key sequence [ description ]
     * mailboxes mailbox [ mailbox ...]
       unmailboxes { * | mailbox ... }
     * mailto_allow { * | header-field ... }
       unmailto_allow { * | header-field ... }
     * mbox-hook [!]regex mailbox
     * message-hook [!]pattern command
     * mime_lookup mimetype [ mimetype ...]
       unmime_lookup { * | mimetype ... }
     * mono object attribute
       mono { header | body } attribute regex
       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 ...]
     * setenv [?]variable [ value ]
       unsetenv variable
     * sidebar_whitelist mailbox [ mailbox ...]
       unsidebar_whitelist { * | mailbox ... }
     * source filename
     * spam pattern format
       nospam { * | pattern }
     * subjectrx pattern replacement
       unsubjectrx { * | pattern }
     * subscribe [ -group name ...] regex [ regex ...]
       unsubscribe [ -group name ...] { * | regex ... }
     * unhook { * | hook-type }

3. Configuration Variables

3.1. abort_noattach

   Type: quadoption
   Default: no

   If set to yes, when composing messages containing the regular
   expression specified by attach_keyword and no attachments ** are given,
   composition will be aborted. If set to no, composing ** messages as
   such will never be aborted.

   Example:
set attach_keyword = "\\<attach(|ed|ments?)\\>"

3.2. 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 no, composing
   messages with no subject given at the subject prompt will never be
   aborted.

3.3. abort_unmodified

   Type: quadoption
   Default: yes

   If set to yes, composition will automatically abort after editing the
   message body if no changes are made to the file (this check only
   happens after the first edit of the file). When set to no, composition
   will never be aborted.

3.4. alias_file

   Type: path
   Default: "~/.neomuttrc"

   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: NeoMutt will not automatically source this file; you must
   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 neomuttrc file, or
   "~/.neomuttrc" if no user neomuttrc was found.

3.5. 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:
   %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.6. 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.7. allow_ansi

   Type: boolean
   Default: no

   Controls whether ANSI color codes in messages (and color tags in rich
   text messages) are to be interpreted. Messages containing these codes
   are rare, but if this option is set, their text will be colored
   accordingly. Note that this may override your color choices, and even
   present a security problem, since a message could include a line like
[-- PGP output follows ...

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

3.8. arrow_cursor

   Type: boolean
   Default: no

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

   Type: boolean
   Default: no

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

3.10. askbcc

   Type: boolean
   Default: no

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

3.11. askcc

   Type: boolean
   Default: no

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

3.12. ask_follow_up

   Type: boolean
   Default: no

   If set, NeoMutt will prompt you for follow-up groups before editing the
   body of an outgoing message.

3.13. ask_x_comment_to

   Type: boolean
   Default: no

   If set, NeoMutt will prompt you for x-comment-to field before editing
   the body of an outgoing message.

3.14. assumed_charset

   Type: string
   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".

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

   Type: string
   Default: (empty)

   This variable is a colon-separated list of character encoding schemes
   for text file attachments. NeoMutt 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: for Japanese users, "iso-2022-*" must be put at the head of the
   value as shown above if included.

3.16. 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(3)-style sequences are understood:
   %C Charset
   %c Requires charset conversion ("n" or "c")
   %D Deleted flag
   %d Description (if none, falls back to %F)
   %e MIME content-transfer-encoding
   %f Filename
   %F Filename in content-disposition header (if none, falls back to %f)
   %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 Graphic tree characters
   %t Tagged flag
   %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.17. attach_keyword

   Type: regular expression
   Default: "\<(attach|attached|attachments?)\>"

   If abort_noattach is not set to no, then the body of the message will
   be scanned for this regular expression, and if found, you will be
   prompted if there are no attachments.

3.18. attach_sep

   Type: string
   Default: "\n"

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

3.19. attach_split

   Type: boolean
   Default: yes

   If this variable is unset, when operating (saving, printing, piping,
   etc) on a list of tagged attachments, NeoMutt will concatenate the
   attachments and will operate on them as a single attachment. The
   $attach_sep separator is added after each attachment. When set, NeoMutt
   will operate on the attachments one by one.

3.20. attribution

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

   This is the string that will precede a message which has been included
   in a reply. For a full listing of defined printf(3)-like sequences see
   the section on $index_format.

3.21. attribution_locale

   Type: string
   Default: (empty)

   The locale used by strftime(3) to format dates in the attribution
   string. Legal values are the strings your system accepts for the locale
   environment variable $LC_TIME.

   This variable is to allow the attribution date format to be customized
   by recipient or folder using hooks. By default, NeoMutt will use your
   locale environment, so there is no need to set this except to override
   that default.

3.22. 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.23. autoedit

   Type: boolean
   Default: no

   When set along with $edit_headers, NeoMutt 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.

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

   Type: boolean
   Default: yes

   When this variable is set, NeoMutt will beep when an error occurs.

3.25. beep_new

   Type: boolean
   Default: no

   When this variable is set, NeoMutt will beep whenever it prints a
   message notifying you of new mail. This is independent of the setting
   of the $beep variable.

3.26. bounce

   Type: quadoption
   Default: ask-yes

   Controls whether you will be asked to confirm bouncing messages. If set
   to yes you don't get asked if you want to bounce a message. Setting
   this variable to no is not generally useful, and thus not recommended,
   because you are unable to bounce messages.

3.27. bounce_delivered

   Type: boolean
   Default: yes

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

3.28. braille_friendly

   Type: boolean
   Default: no

   When this variable is set, NeoMutt 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.29. catchup_newsgroup

   Type: quadoption
   Default: ask-yes

   If this variable is set, NeoMutt will mark all articles in newsgroup as
   read when you quit the newsgroup (catchup newsgroup).

3.30. 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=~/.neomutt/certificates

3.31. change_folder_next

   Type: boolean
   Default: no

   When this variable is set, the <change-folder> function mailbox
   suggestion will start at the next folder in your "mailboxes" list,
   instead of starting at the first folder in the list.

3.32. charset

   Type: string
   Default: (empty)

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

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

   Note: It should only be set in case NeoMutt isn't able to determine the
   character set used correctly.

3.33. check_mbox_size

   Type: boolean
   Default: no

   When this variable is set, NeoMutt 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 NeoMutt 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.34. check_new

   Type: boolean
   Default: yes

   Note: this option only affects maildir and MH style mailboxes.

   When set, NeoMutt will check for new mail delivered while the mailbox
   is open. Especially with MH mailboxes, this operation can take quite
   some time since it involves scanning the directory and checking each
   file to see if it has already been looked at. If this variable is
   unset, no check for new mail is performed while the mailbox is open.

3.35. collapse_unread

   Type: boolean
   Default: yes

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

3.36. collapse_flagged

   Type: boolean
   Default: yes

   When unset, NeoMutt will not collapse a thread if it contains any
   flagged messages.

3.37. compose_format

   Type: string
   Default: "-- NeoMutt: 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 NeoMutt version string

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

3.38. config_charset

   Type: string
   Default: (empty)

   When defined, NeoMutt will recode commands in rc files from this
   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.39. confirmappend

   Type: boolean
   Default: yes

   When set, NeoMutt will prompt for confirmation when appending messages
   to an existing mailbox.

3.40. confirmcreate

   Type: boolean
   Default: yes

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

3.41. connect_timeout

   Type: number
   Default: 30

   Causes NeoMutt 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 NeoMutt to wait indefinitely for
   the connection attempt to succeed.

3.42. content_type

   Type: string
   Default: "text/plain"

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

3.43. 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.44. crypt_autoencrypt

   Type: boolean
   Default: no

   Setting this variable will cause NeoMutt 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.45. crypt_autopgp

   Type: boolean
   Default: yes

   This variable controls whether or not NeoMutt may automatically enable
   PGP encryption/signing for messages. See also $crypt_autoencrypt,
   $crypt_replyencrypt, $crypt_autosign, $crypt_replysign and
   $smime_is_default.

3.46. crypt_autosign

   Type: boolean
   Default: no

   Setting this variable will cause NeoMutt 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.47. crypt_autosmime

   Type: boolean
   Default: yes

   This variable controls whether or not NeoMutt may automatically enable
   S/MIME encryption/signing for messages. See also $crypt_autoencrypt,
   $crypt_replyencrypt, $crypt_autosign, $crypt_replysign and
   $smime_is_default.

3.48. crypt_confirmhook

   Type: boolean
   Default: yes

   If set, then you will be prompted for confirmation of keys when using
   the crypt-hook command. If unset, no such confirmation prompt will be
   presented. This is generally considered unsafe, especially where typos
   are concerned.

3.49. crypt_opportunistic_encrypt

   Type: boolean
   Default: no

   Setting this variable will cause NeoMutt to automatically enable and
   disable encryption, based on whether all message recipient keys can be
   located by NeoMutt.

   When this option is enabled, NeoMutt will enable/disable encryption
   each time the TO, CC, and BCC lists are edited. If $edit_headers is
   set, NeoMutt will also do so each time the message is edited.

   While this is set, encryption can't be manually enabled/disabled. The
   pgp or smime menus provide a selection to temporarily disable this
   option for the current message.

   If $crypt_autoencrypt or $crypt_replyencrypt enable encryption for a
   message, this option will be disabled for that message. It can be
   manually re-enabled in the pgp or smime menus. (Crypto only)

3.50. crypt_replyencrypt

   Type: boolean
   Default: yes

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

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

3.53. crypt_timestamp

   Type: boolean
   Default: yes

   If set, NeoMutt 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.54. crypt_use_gpgme

   Type: boolean
   Default: no

   This variable controls the use of the GPGME-enabled crypto backends. If
   it is set and NeoMutt 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 .neomuttrc; it won't have any effect when
   used interactively.

   Note that the GPGME backend does not support creating old-style inline
   (traditional) PGP encrypted or signed messages (see $pgp_autoinline).

3.55. crypt_use_pka

   Type: boolean
   Default: no

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

3.56. 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.57. 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. 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.58. debug_level

   Type: number
   Default: 0

   The debug level. Note: to debug the early startup process (before the
   configuration is loaded), "-d" neomutt argument must be used.
   debug_level/debug_file are ignored until it's read from the
   configuration file.

3.59. debug_file

   Type: path
   Default: "~/.neomuttdebug"

   The location prefix of the debug file, 0 is append to the debug file
   Old debug files are renamed with the prefix 1, 2, 3 and 4. See
   "debug_level" for more detail.

3.60. 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 regex, instead of a matching pattern.
   The hooks are expanded when they are declared, so a hook will be
   interpreted according to the value of this variable at the time the
   hook is declared.

   The default value matches if the message is either from a user matching
   the regular expression given, or if it is from you (if the from address
   matches "alternates") and is to or cc'ed to a user matching the given
   regular expression.

3.61. 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.62. delete_untag

   Type: boolean
   Default: yes

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

   Type: boolean
   Default: yes

   If this option is set, NeoMutt'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.64. 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
   filtered message is read from the standard output.

   When preparing the message, NeoMutt inserts some escape sequences into
   the text. They are of the form: <esc>]9;XXX<bel> where "XXX" is a
   random 64-bit number.

   If these escape sequences interfere with your filter, they can be
   removed using a tool like ansifilter or sed 's/^\x1b]9;[0-9]\+\x7//'

   If they are removed, then PGP and MIME headers will no longer be
   coloured. This can be fixed by adding this to your config: color body
   magenta default '^\[-- .* --\]$'.

3.65. 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, failure, to
   request notification on transmission failure, delay, to be notified of
   message delays, success, to be notified of successful transmission.

   Example:
set dsn_notify="failure,delay"

   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, DSN support is auto-detected so that it
   depends on the server whether DSN will be used or not.

3.66. 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 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, DSN support is auto-detected so that it
   depends on the server whether DSN will be used or not.

3.67. duplicate_threads

   Type: boolean
   Default: yes

   This variable controls whether NeoMutt, 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 tree.

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

   Although the compose menu may have localized header labels, the labels
   passed to your editor will be standard RFC2822 headers, (e.g. To:, Cc:,
   Subject:). Headers added in your editor must also be RFC2822 headers,
   or one of the pseudo headers listed in "edit-header". NeoMutt will not
   understand localized header labels, just as it would not when parsing
   an actual email.

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

3.69. editor

   Type: path
   Default: (empty)

   This variable specifies which editor is used by NeoMutt. It defaults to
   the value of the $VISUAL, or $EDITOR, environment variable, or to the
   string "vi" if neither of those are set.

   The $editor string may contain a %s escape, which will be replaced by
   the name of the file to be edited. If the %s escape does not appear in
   $editor, a space and the name to be edited are appended.

   The resulting string is then executed by running
sh -c 'string'

   where string is the expansion of $editor described above.

3.70. empty_subject

   Type: string
   Default: "Re: your mail"

   This variable specifies the subject to be used when replying to an
   email with an empty subject. It defaults to "Re: your mail".

3.71. encode_from

   Type: boolean
   Default: no

   When set, NeoMutt will quoted-printable encode messages when 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.72. entropy_file

   Type: path
   Default: (empty)

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

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

   Type: string
   Default: "~"

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

3.75. fast_reply

   Type: boolean
   Default: no

   When set, the initial prompt for recipients and subject are skipped
   when replying to messages, and the initial prompt for subject is
   skipped when forwarding messages.

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

3.76. 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.77. fcc_clear

   Type: boolean
   Default: no

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

3.78. flag_safe

   Type: boolean
   Default: no

   If set, flagged messages cannot be deleted.

3.79. folder

   Type: path
   Default: "~/Mail"

   Specifies the default location of your mailboxes. A "+" or "=" at the
   beginning of a pathname will be expanded to the value of this variable.
   Note that if you change this variable (from the default) value you need
   to make sure that the assignment occurs before you use "+" or "=" for
   any other variables since expansion takes place when handling the
   "mailboxes" command.

3.80. folder_format

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

   This variable allows you to customize the file browser display to your
   personal taste. This string is similar to $index_format, but has its
   own set of printf(3)-like sequences:
   %C Current file number
   %d Date/time folder was last modified
   %D Date/time folder was last modified using $date_format.
   %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
   %m Number of messages in the mailbox *
   %n Number of unread messages in the mailbox *
   %N "N" if mailbox 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.

   * = can be optionally printed if nonzero

   %m, %n, and %N only work for monitored mailboxes. %m requires
   $mail_check_stats to be set. %n requires $mail_check_stats to be set
   (except for IMAP mailboxes).

3.81. followup_to

   Type: boolean
   Default: yes

   Controls whether or not the "Mail-Followup-To:" header field is
   generated when sending mail. When set, NeoMutt will generate this field
   when you are replying to a known mailing list, specified with 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 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.82. followup_to_poster

   Type: quadoption
   Default: ask-yes

   If this variable is set and the keyword "poster" is present in
   Followup-To header, follow-up to newsgroup function is not permitted.
   The message will be mailed to the submitter of the message via mail.

3.83. force_name

   Type: boolean
   Default: no

   This variable is similar to $save_name, except that NeoMutt 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.84. forward_attribution_intro

   Type: string
   Default: "----- Forwarded message from %f -----"

   This is the string that will precede a message which has been forwarded
   in the main body of a message (when $mime_forward is unset). For a full
   listing of defined printf(3)-like sequences see the section on
   $index_format. See also $attribution_locale.

3.85. forward_attribution_trailer

   Type: string
   Default: "----- End forwarded message -----"

   This is the string that will follow a message which has been forwarded
   in the main body of a message (when $mime_forward is unset). For a full
   listing of defined printf(3)-like sequences see the section on
   $index_format. See also $attribution_locale.

3.86. forward_decode

   Type: boolean
   Default: yes

   Controls the decoding of complex MIME messages into text/plain when
   forwarding a message. The message header is also RFC2047 decoded. This
   variable is only used, if $mime_forward is unset, otherwise
   $mime_forward_decode is used instead.

3.87. 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.88. 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.89. 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.90. 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.91. forward_references

   Type: boolean
   Default: no

   When set, forwarded messages set the "In-Reply-To:" and "References:"
   headers in the same way as normal replies would. Hence the forwarded
   message becomes part of the original thread instead of starting a new
   one.

3.92. 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.93. from_chars

   Type: string
   Default: (empty)

   Controls the character used to prefix the %F and %L fields in the
   index.
   Character Description
   1 Mail is written by you and has a To address, or has a known mailing
   list in the To address.
   2 Mail is written by you and has a Cc address, or has a known mailing
   list in the Cc address.
   3 Mail is written by you and has a Bcc address.
   4 All remaining cases.

   If this is empty or unset (default), the traditional long "To ", "Cc "
   and "Bcc " prefixes are used. If set but too short to include a
   character for a particular case, a single space will be prepended to
   the field. To prevent any prefix at all from being added in a
   particular case, use the special value CR (aka ^M) for the
   corresponding character.

   This slightly odd interface is necessitated by NeoMutt's handling of
   string variables; one cannot tell a variable that is unset from one
   that is set to the empty string.

3.94. gecos_mask

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

   A regular expression used by NeoMutt to parse the GECOS field of a
   password 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
   NeoMutt 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 NeoMutt will expand "Franklin" to "Franklin, Steve".

3.95. group_index_format

   Type: string
   Default: "%4C %M%N %5s  %-45.45f %d"

   This variable allows you to customize the newsgroup browser display to
   your personal taste. This string is similar to "index_format", but has
   its own set of printf()-like sequences:
   %C  Current newsgroup number
   %d  Description of newsgroup (becomes from server)
   %f  Newsgroup name
   %M  - if newsgroup not allowed for direct post (moderated for example)
   %N  N if newsgroup is new, u if unsubscribed, blank otherwise
   %n  Number of new articles in newsgroup
   %s  Number of unread articles in newsgroup
   %>X Right justify the rest of the string and pad with character "X"
   %|X Pad to the end of the line with character "X"

3.96. hdrs

   Type: boolean
   Default: yes

   When unset, the header fields normally added by the "my_hdr" command
   are not created. This variable must be unset before composing a new
   message or replying in order to take effect. If set, the user defined
   header fields are added to every new message.

3.97. header

   Type: boolean
   Default: no

   When set, this variable causes NeoMutt to include the header of the
   message you are replying to into the edit buffer. The $weed setting
   applies.

3.98. header_cache

   Type: path
   Default: (empty)

   This variable points to the header cache database. If pointing to a
   directory NeoMutt 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.99. header_cache_backend

   Type: -none-
   Default: 0

   This variable specifies the header cache backend.

3.100. header_cache_compress

   Type: boolean
   Default: yes

   When NeoMutt is compiled with qdbm, tokyocabinet or kyotocabinet 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 decompression can result in a
   slower opening of cached folder(s) which in general is still much
   faster than opening non header cached folders.

3.101. header_color_partial

   Type: boolean
   Default: no

   When set, color header regexes behave like color body regexes: color is
   applied to the exact text matched by the regex. When unset, color is
   applied to the entire header.

   One use of this option might be to apply color to just the header
   labels.

   See "color" for more details.

3.102. help

   Type: boolean
   Default: yes

   When set, help lines describing the bindings for the major functions
   provided by each menu are displayed on the first line of the screen.

   Note: The binding will not be displayed correctly if the function is
   bound to a sequence rather than a single keystroke. Also, the help line
   may not be updated if a binding is changed while NeoMutt is running.
   Since this variable is primarily aimed at new users, neither of these
   should present a major problem.

3.103. hidden_host

   Type: boolean
   Default: no

   When set, NeoMutt will skip the host name part of $hostname variable
   when adding the domain part to addresses. This variable does not affect
   the generation of Message-IDs, and it will not lead to the cut-off of
   first-level domains.

3.104. hide_limited

   Type: boolean
   Default: no

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

3.105. hide_missing

   Type: boolean
   Default: yes

   When set, NeoMutt will not show the presence of missing messages in the
   thread tree.

3.106. hide_thread_subject

   Type: boolean
   Default: yes

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

   Type: boolean
   Default: no

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

   Type: boolean
   Default: yes

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

   Type: number
   Default: 10

   This variable controls the size (in number of strings remembered) of
   the string history buffer per category. The buffer is cleared each time
   the variable is set.

3.110. history_file

   Type: path
   Default: "~/.mutthistory"

   The file in which NeoMutt will save its history.

   Also see $save_history.

3.111. history_remove_dups

   Type: boolean
   Default: no

   When set, all of the string history will be scanned for duplicates when
   a new entry is added. Duplicate entries in the $history_file will also
   be removed when it is periodically compacted.

3.112. honor_disposition

   Type: boolean
   Default: no

   When set, NeoMutt 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, NeoMutt will render all MIME parts it can properly transform
   to plain text.

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

   Type: string
   Default: (empty)

   Specifies the fully-qualified hostname of the system NeoMutt 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 Message-Id headers.

   Its value is determined at startup as follows: the node's hostname is
   first determined by the uname(3) function. The domain is then looked up
   using the gethostname(2) and getaddrinfo(3) functions. If those calls
   are unable to determine the domain, the full value returned by uname is
   used. Optionally, NeoMutt 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.115. idn_decode

   Type: boolean
   Default: yes

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

3.116. idn_encode

   Type: boolean
   Default: yes

   When set, NeoMutt will encode international domain names using IDN.
   Unset this if your SMTP server can handle newer (RFC6531) UTF-8 encoded
   domains. (IDN only)

3.117. ignore_list_reply_to

   Type: boolean
   Default: no

   Affects the behavior 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, NeoMutt 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 list.

3.118. show_multipart_alternative

   Type: string
   Default: (empty)

   When set to info, the multipart/alternative information is shown. When
   set to inline, all of the alternatives are displayed. When not set, the
   default behavior is to show only the chosen alternative.

3.119. imap_authenticators

   Type: string
   Default: (empty)

   This is a colon-delimited list of authentication methods NeoMutt may
   attempt to use to log in to an IMAP server, in the order NeoMutt should
   try them. Authentication methods are either "login" or the right side
   of an IMAP "AUTH=xxx" capability string, e.g. "digest-md5", "gssapi" or
   "cram-md5". This option is case-insensitive. If it's unset (the
   default) NeoMutt will try all available methods, in order from
   most-secure to least-secure.

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

   Note: NeoMutt will only fall back to other authentication methods if
   the previous methods are unavailable. If a method is available but
   authentication fails, NeoMutt will not connect to the IMAP server.

3.120. imap_check_subscribed

   Type: boolean
   Default: no

   When set, NeoMutt 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 just as if you had issued individual "mailboxes" commands.

3.121. 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.122. imap_headers

   Type: string
   Default: (empty)

   NeoMutt 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:", "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, 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.123. imap_idle

   Type: boolean
   Default: no

   When set, NeoMutt 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 NeoMutt's implementation.
   If your connection seems to freeze up periodically, try unsetting this.

3.124. imap_keepalive

   Type: number
   Default: 300

   This variable specifies the maximum amount of time in seconds that
   NeoMutt will wait before polling open IMAP connections, to prevent the
   server from closing them before NeoMutt has finished with them. The
   default is well within the RFC-specified minimum amount of time (30
   minutes) before a server is allowed to do this, but in practice the RFC
   does get violated every now and then. Reduce this number if you find
   yourself getting disconnected from your IMAP server due to inactivity.

3.125. 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.126. imap_login

   Type: string
   Default: (empty)

   Your login name on the IMAP server.

   This variable defaults to the value of $imap_user.

3.127. imap_pass

   Type: string
   Default: (empty)

   Specifies the password for your IMAP account. If unset, NeoMutt will
   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 neomuttrc even if
   you are the only one who can read the file.

3.128. imap_passive

   Type: boolean
   Default: yes

   When set, NeoMutt will not open new IMAP connections to check for new
   mail. NeoMutt 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 NeoMutt invocation, or if opening the connection
   is slow.

3.129. imap_peek

   Type: boolean
   Default: yes

   When set, NeoMutt 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.130. 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
   NeoMutt 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.131. imap_poll_timeout

   Type: number
   Default: 15

   This variable specifies the maximum amount of time in seconds that
   NeoMutt will wait for a response when polling IMAP connections for new
   mail, before timing out and closing the connection. Set to 0 to disable
   timing out.

3.132. imap_servernoise

   Type: boolean
   Default: yes

   When set, NeoMutt 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.133. 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.134. implicit_autoview

   Type: boolean
   Default: no

   If set to "yes", NeoMutt 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, NeoMutt will
   use the viewer defined in that entry to convert the body part to text
   form.

3.135. 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.136. include_onlyfirst

   Type: boolean
   Default: no

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

3.137. 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, 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(3)-style sequences.

3.138. index_format

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

   This variable allows you to customize the message index display to your
   personal taste.

   "Format strings" are similar to the strings used in the C function
   printf(3) to format output (see the man page for more details). For an
   explanation of the %? construct, see the status_format description. The
   following sequences are defined in NeoMutt:
   %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
   %g Newsgroup name (if compiled with NNTP support)
   %g Message labels (e.g. notmuch tags)
   %H Spam attribute(s) of this message
   %I Initials of author
   %i Message-id of the current message
   %K The list to which the letter was sent (if any; otherwise: empty)
   %l Number of lines in the message (does not work with maildir, Mh, and
   possibly IMAP folders)
   %L If an address in the "To:" or "Cc:" header field matches an address
   Defined by the users "subscribe" command, this displays "To
   <list-name>", otherwise the same as %F
   %m Total number of message in the mailbox
   %M Number of hidden messages if the thread is collapsed
   %N Message score
   %n Author's real name (or address if missing)
   %O Original save folder where NeoMutt would formerly have Stashed the
   message: list name or recipient name If not sent to a list
   %P Progress indicator for the built-in pager (how much of the file has
   been displayed)
   %q Newsgroup name (if compiled with NNTP support)
   %r Comma separated list of "To:" recipients
   %R Comma separated list of "Cc:" recipients
   %s Subject of the message
   %S Single character status of the message ("N"/"O"/"D"/"d"/"!"/"r"/"*")
   %t "To:" field (recipients)
   %T The appropriate character from the $to_chars string
   %u User (login) name of the author
   %v First name of the author, or the recipient if the message is from
   you
   %W Name of organization of author ("Organization:" field)
   %x "X-Comment-To:" field (if present and compiled with NNTP support)
   %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 A three character set of message status flags. The first character
   is new/read/replied flags ("n"/"o"/"r"/"O"/"N"). The second is deleted
   or encryption flags ("D"/"d"/"S"/"P"/"s"/"K"). The third is either
   tagged/flagged ("*"/"!"), or one of the characters Listed in $to_chars.
   %zs Message status flags
   %zc Message crypto flags
   %zt Message tag 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
   %>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

   Date format expressions can be constructed based on relative dates.
   Using the date formatting operators along with nested conditionals, the
   date format can be modified based on how old a message is. See the
   section on "Conditional Dates" for an explanation and examples
   "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.

3.139. inews

   Type: path
   Default: (empty)

   If set, specifies the program and arguments used to deliver news posted
   by NeoMutt. Otherwise, NeoMutt posts article using current connection
   to news server. The following printf-style sequence is understood:
   %a account url
   %p port
   %P port if specified
   %s news server name
   %S url schema
   %u username

   Example:
set inews="/usr/local/bin/inews -hS"

3.140. ispell

   Type: path
   Default: "ispell"

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

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

   Type: number
   Default: 5

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

3.143. mail_check_recent

   Type: boolean
   Default: yes

   When set, NeoMutt will only notify you about new mail that has been
   received since the last time you opened the mailbox. When unset,
   NeoMutt will notify you if any new mail exists in the mailbox,
   regardless of whether you have visited it recently.

   When $mark_old is set, NeoMutt does not consider the mailbox to contain
   new mail if only old messages exist.

3.144. mail_check_stats

   Type: boolean
   Default: no

   When set, NeoMutt will periodically calculate message statistics of a
   mailbox while polling for new mail. It will check for unread, flagged,
   and total message counts. Because this operation is more performance
   intensive, it defaults to unset, and has a separate option,
   $mail_check_stats_interval, to control how often to update these
   counts.

3.145. mail_check_stats_interval

   Type: number
   Default: 60

   When $mail_check_stats is set, this variable configures how often (in
   seconds) NeoMutt will update message counts.

3.146. mailcap_path

   Type: string
   Default: (empty)

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

3.147. mailcap_sanitize

   Type: boolean
   Default: yes

   If set, NeoMutt 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.148. maildir_header_cache_verify

   Type: boolean
   Default: yes

   Check for Maildir unaware programs other than NeoMutt having modified
   maildir 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.149. maildir_trash

   Type: boolean
   Default: no

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

   Type: boolean
   Default: no

   If set, NeoMutt will poll both the new and cur directories of a maildir
   folder for new messages. This might be useful if other programs
   interacting with the folder (e.g. dovecot) are moving new messages to
   the cur directory. Note that setting this option may slow down polling
   for new messages in large folders, since NeoMutt has to scan all cur
   messages.

3.151. mark_macro_prefix

   Type: string
   Default: "'"

   Prefix for macros created using mark-message. A new macro automatically
   generated with <mark-message>a will be composed from this prefix and
   the letter a.

3.152. mark_old

   Type: boolean
   Default: yes

   Controls whether or not NeoMutt marks new unread messages as old if you
   exit a mailbox without reading them. With this option set, the next
   time you start NeoMutt, the messages will show up with an "O" next to
   them in the index menu, indicating that they are old.

3.153. 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.154. mask

   Type: regular expression
   Default: "&Mask,UL!^\.[^.]"

   A regular expression used in the file browser, optionally preceded by
   the not operator "!". Only files whose names match this mask will be
   shown. The match is always case-sensitive.

3.155. mbox

   Type: path
   Default: "~/mbox"

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

   Also see the $move variable.

3.156. 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". This is overridden by the -m
   command-line option.

3.157. 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.158. 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.159. 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.160. message_cache_clean

   Type: boolean
   Default: no

   If set, NeoMutt 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.161. message_cachedir

   Type: path
   Default: (empty)

   Set this to a directory and NeoMutt 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, NeoMutt 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.162. 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.163. meta_key

   Type: boolean
   Default: no

   If set, forces NeoMutt 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.164. metoo

   Type: boolean
   Default: no

   If unset, NeoMutt will remove your address (see the "alternates"
   command) from the list of recipients when replying to a message.

3.165. mh_purge

   Type: boolean
   Default: no

   When unset, NeoMutt will mimic mh's behavior and rename deleted
   messages to ,<old file name> in mh folders instead of really deleting
   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.

   This option is similar to $maildir_trash for Maildir folders.

3.166. mh_seq_flagged

   Type: string
   Default: "flagged"

   The name of the MH sequence used for flagged messages.

3.167. mh_seq_replied

   Type: string
   Default: "replied"

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

3.168. mh_seq_unseen

   Type: string
   Default: "unseen"

   The name of the MH sequence used for unseen messages.

3.169. mime_forward

   Type: quadoption
   Default: no

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

   Also see $forward_decode and $mime_forward_decode.

3.170. 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.171. mime_forward_rest

   Type: quadoption
   Default: yes

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

   Type: boolean
   Default: yes

   If unset, 8-bit "subject:" line in article header will not be encoded
   according to RFC2047 to base64. This is useful when message is Usenet
   article, because MIME for news is nonstandard feature.

3.173. mime_type_query_command

   Type: string
   Default: (empty)

   This specifies a command to run, to determine the mime type of a new
   attachment when composing a message. Unless $mime_type_query_first is
   set, this will only be run if the attachment's extension is not found
   in the mime.types file.

   The string may contain a "%s", which will be substituted with the
   attachment filename. NeoMutt will add quotes around the string
   substituted for "%s" automatically according to shell quoting rules, so
   you should avoid adding your own. If no "%s" is found in the string,
   NeoMutt will append the attachment filename to the end of the string.

   The command should output a single line containing the attachment's
   mime type.

   Suggested values are "xdg-mime query filetype" or "file -bi".

3.174. mime_type_query_first

   Type: boolean
   Default: no

   When set, the $mime_type_query_command will be run before the
   mime.types lookup.

3.175. move

   Type: quadoption
   Default: no

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

3.176. narrow_tree

   Type: boolean
   Default: no

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

3.177. 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. If set to
   0, no progress messages will be displayed.

   See also $read_inc, $write_inc and $net_inc.

3.178. new_mail_command

   Type: path
   Default: "NULL"

   If set, NeoMutt will call this command after a new message is received.
   See the $status_format documentation for the values that can be
   formatted into this command.

3.179. news_cache_dir

   Type: path
   Default: "~/.neomutt"

   This variable pointing to directory where NeoMutt will save cached news
   articles and headers in. If unset, articles and headers will not be
   saved at all and will be reloaded from the server each time.

3.180. news_server

   Type: string
   Default: (empty)

   This variable specifies domain name or address of NNTP server. It
   defaults to the news server specified in the environment variable
   $NNTPSERVER or contained in the file /etc/nntpserver. You can also
   specify username and an alternative port for each news server, ie:

   [[s]news://][username[:password]@]server[:port]

3.181. newsgroups_charset

   Type: string
   Default: "utf-8"

   Character set of newsgroups descriptions.

3.182. newsrc

   Type: path
   Default: "~/.newsrc"

   The file, containing info about subscribed newsgroups - names and
   indexes of read articles. The following printf-style sequence is
   understood:
   %a Account url
   %p Port
   %P Port if specified
   %s News server name
   %S Url schema
   %u Username

3.183. nntp_authenticators

   Type: string
   Default: (empty)

   This is a colon-delimited list of authentication methods NeoMutt may
   attempt to use to log in to a news server, in the order NeoMutt should
   try them. Authentication methods are either "user" or any SASL
   mechanism, e.g. "digest-md5", "gssapi" or "cram-md5". This option is
   case-insensitive. If it's unset (the default) NeoMutt will try all
   available methods, in order from most-secure to least-secure.

   Example:
set nntp_authenticators="digest-md5:user"

   Note: NeoMutt will only fall back to other authentication methods if
   the previous methods are unavailable. If a method is available but
   authentication fails, NeoMutt will not connect to the IMAP server.

3.184. nntp_context

   Type: number
   Default: 1000

   This variable defines number of articles which will be in index when
   newsgroup entered. If active newsgroup have more articles than this
   number, oldest articles will be ignored. Also controls how many
   articles headers will be saved in cache when you quit newsgroup.

3.185. nntp_listgroup

   Type: boolean
   Default: yes

   This variable controls whether or not existence of each article is
   checked when newsgroup is entered.

3.186. nntp_load_description

   Type: boolean
   Default: yes

   This variable controls whether or not descriptions for each newsgroup
   must be loaded when newsgroup is added to list (first time list loading
   or new newsgroup adding).

3.187. nntp_user

   Type: string
   Default: (empty)

   Your login name on the NNTP server. If unset and NNTP server requires
   authentication, NeoMutt will prompt you for your account name when you
   connect to news server.

3.188. nntp_pass

   Type: string
   Default: (empty)

   Your password for NNTP account.

3.189. nntp_poll

   Type: number
   Default: 60

   The time in seconds until any operations on newsgroup except post new
   article will cause recheck for new news. If set to 0, NeoMutt will
   recheck newsgroup on each operation in index (stepping, read article,
   etc.).

3.190. pager

   Type: path
   Default: "builtin"

   This variable specifies which pager you would like to use to view
   messages. The value "builtin" means to use the built-in pager,
   otherwise this variable should specify the pathname of the external
   pager you would like to use.

   Using an external pager may have some disadvantages: Additional
   keystrokes are necessary because you can't call NeoMutt functions
   directly from the pager, and screen resizes cause lines longer than the
   screen width to be badly formatted in the help menu.

3.191. hidden_tags

   Type: string
   Default: "unread,draft,flagged,passed,replied,attachment,signed,encrypt
   ed"

   This variable specifies private notmuch/imap tags which should not be
   printed on screen.

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

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

3.194. pager_index_lines

   Type: number
   Default: 0

   Determines the number of lines of a mini-index which is shown when in
   the pager. The current message, unless near the top or bottom of the
   folder, will be roughly one third of the way down this mini-index,
   giving the reader the context of a few messages before and after the
   message. This is useful, for example, to determine how many messages
   remain to be read in the current thread. One of the lines is reserved
   for the status bar from the index, so a 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 many lines as it
   needs.

3.195. pager_stop

   Type: boolean
   Default: no

   When set, the internal-pager will not move to the next message when you
   are at the end of a message and invoke the <next-page> function.

3.196. pgp_auto_decode

   Type: boolean
   Default: no

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

3.197. pgp_autoinline

   Type: boolean
   Default: no

   This option controls whether NeoMutt generates old-style inline
   (traditional) PGP encrypted or signed messages under certain
   circumstances. This can be overridden by use of the pgp menu, when
   inline is not required. The GPGME backend does not support this option.

   Note that NeoMutt might automatically use PGP/MIME for messages which
   consist of more than a single MIME part. NeoMutt can be configured to
   ask before sending PGP/MIME messages when inline (traditional) would
   not work.

   Also see the $pgp_mime_auto variable.

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

3.198. pgp_check_exit

   Type: boolean
   Default: yes

   If set, NeoMutt 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.199. 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.200. 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 if set, otherwise the value of
   $pgp_default_key.
   %r One or more key IDs (or fingerprints if available).

   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.201. 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.202. pgp_decryption_okay

   Type: regular expression
   Default: (empty)

   If you assign text to this variable, then an encrypted PGP message is
   only considered successfully decrypted if the output from
   $pgp_decrypt_command contains the text. This is used to protect against
   a spoofed encrypted message, with multipart/encrypted headers but
   containing a block that is not actually encrypted. (e.g. simply signed
   and ascii armored text). (PGP only)

3.203. pgp_default_key

   Type: string
   Default: (empty)

   This is the default key-pair to use for PGP operations. It will be used
   for encryption (see $postpone_encrypt and $pgp_self_encrypt).

   It will also be used for signing unless $pgp_sign_as is set.

   The (now deprecated) pgp_self_encrypt_as is an alias for this variable,
   and should no longer be used. (PGP only)

3.204. 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.205. 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.206. 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:
   %a     Algorithm
   %c     Capabilities
   %f     Flags
   %k     Key id
   %l     Key length
   %n     Number
   %p     Protocol
   %t     Trust/validity of the key-uid association
   %u     User id
   %[<s>] Date of the key where <s> is an strftime(3) expression

   (PGP only)

3.207. 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.208. pgp_getkeys_command

   Type: string
   Default: (empty)

   This command is invoked whenever NeoMutt needs to fetch the public key
   associated with an email address. Of the sequences supported by
   $pgp_decode_command, %r is the only printf(3)-like sequence used with
   this format. Note that in this case, %r expands to the email address,
   not the public key ID (the key ID is unknown, which is why NeoMutt is
   invoking this command). (PGP only)

3.209. 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.210. pgp_ignore_subkeys

   Type: boolean
   Default: yes

   Setting this variable will cause NeoMutt 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.211. 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.212. 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
gpg --list-keys --with-colons --with-fingerprint

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

   Note: gpg's fixed-list-mode option should not be used. It produces a
   different date format which may result in NeoMutt showing incorrect key
   generation dates.

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

3.213. 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 --with-fingerprint

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

   Note: gpg's fixed-list-mode option should not be used. It produces a
   different date format which may result in NeoMutt showing incorrect key
   generation dates.

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

3.214. pgp_long_ids

   Type: boolean
   Default: yes

   If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs.
   NOTE: Internally, NeoMutt has transitioned to using fingerprints (or
   long key IDs as a fallback). This option now only controls the display
   of key IDs in the key selection menu and a few other places. (PGP only)

3.215. pgp_mime_auto

   Type: quadoption
   Default: ask-yes

   This option controls whether NeoMutt will prompt you for automatically
   sending a (signed/encrypted) message using PGP/MIME when inline
   (traditional) fails (for any reason).

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

3.216. pgp_replyinline

   Type: boolean
   Default: no

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

   Note that NeoMutt might automatically use PGP/MIME for messages which
   consist of more than a single MIME part. NeoMutt can be configured to
   ask before sending PGP/MIME messages when inline (traditional) would
   not work.

   Also see the $pgp_mime_auto variable.

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

3.217. 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.218. pgp_self_encrypt

   Type: boolean
   Default: yes

   When set, PGP encrypted messages will also be encrypted using the key
   in $pgp_default_key. (PGP only)

3.219. pgp_show_unusable

   Type: boolean
   Default: yes

   If set, NeoMutt 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.220. pgp_sign_as

   Type: string
   Default: (empty)

   If you have a different key pair to use for signing, you should set
   this to the signing key. Most people will only need to set
   $pgp_default_key. It is recommended that you use the keyid form to
   specify your key (e.g. 0x00112233). (PGP only)

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

3.222. 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.223. pgp_strict_enc

   Type: boolean
   Default: yes

   If set, NeoMutt 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.224. pgp_timeout

   Type: number
   Default: 300

   The number of seconds after which a cached passphrase will expire if
   not used. (PGP only)

3.225. pgp_use_gpg_agent

   Type: boolean
   Default: no

   If set, NeoMutt will use a possibly-running gpg-agent(1) process. Note
   that as of version 2.1, GnuPG no longer exports GPG_AGENT_INFO, so
   NeoMutt no longer verifies if the agent is running. (PGP only)

3.226. pgp_verify_command

   Type: string
   Default: (empty)

   This command is used to verify PGP signatures.

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

3.227. pgp_verify_key_command

   Type: string
   Default: (empty)

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

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

3.228. pipe_decode

   Type: boolean
   Default: no

   Used in connection with the <pipe-message> command. When unset, NeoMutt
   will pipe the messages without any preprocessing. When set, NeoMutt
   will weed headers and will attempt to decode the messages first.

3.229. 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.230. 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 NeoMutt will concatenate the messages and will pipe them all
   concatenated. When set, NeoMutt 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.231. pop_auth_try_all

   Type: boolean
   Default: yes

   If set, NeoMutt will try all available authentication methods. When
   unset, NeoMutt will only fall back to other authentication methods if
   the previous methods are unavailable. If a method is available but
   authentication fails, NeoMutt will not connect to the POP server.

3.232. pop_authenticators

   Type: string
   Default: (empty)

   This is a colon-delimited list of authentication methods NeoMutt may
   attempt to use to log in to an POP server, in the order NeoMutt should
   try them. Authentication methods are either "user", "apop" or any SASL
   mechanism, e.g. "digest-md5", "gssapi" or "cram-md5". This option is
   case-insensitive. If this option is unset (the default) NeoMutt will
   try all available methods, in order from most-secure to least-secure.

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

3.233. pop_checkinterval

   Type: number
   Default: 60

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

3.234. pop_delete

   Type: quadoption
   Default: ask-no

   If set, NeoMutt will delete successfully downloaded messages from the
   POP server when using the <fetch-mail> function. When unset, NeoMutt
   will download messages but also leave them on the POP server.

3.235. 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, i.e.:
[pop[s]://][username[:password]@]popserver[:port]

   where "[...]" denotes an optional part.

3.236. pop_last

   Type: boolean
   Default: no

   If this variable is set, NeoMutt will try to use the "LAST" POP command
   for retrieving only unread messages from the POP server when using the
   <fetch-mail> function.

3.237. pop_pass

   Type: string
   Default: (empty)

   Specifies the password for your POP account. If unset, NeoMutt 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 neomuttrc even if
   you are the only one who can read the file.

3.238. pop_reconnect

   Type: quadoption
   Default: ask-yes

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

3.239. 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.240. post_indent_string

   Type: string
   Default: (empty)

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

3.241. post_moderated

   Type: quadoption
   Default: ask-yes

   If set to yes, NeoMutt will post article to newsgroup that have not
   permissions to posting (e.g. moderated). Note: if news server does not
   support posting to that newsgroup or totally read-only, that posting
   will not have an effect.

3.242. 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.243. postponed

   Type: path
   Default: "~/postponed"

   NeoMutt allows you to indefinitely "postpone sending a message" which
   you are editing. When you choose to postpone a message, NeoMutt saves
   it in the mailbox specified by this variable.

   Also see the $postpone variable.

3.244. postpone_encrypt

   Type: boolean
   Default: no

   When set, postponed messages that are marked for encryption will be
   self-encrypted. NeoMutt will first try to encrypt using the value
   specified in $pgp_default_key or $smime_default_key. If those are not
   set, it will try the deprecated $postpone_encrypt_as. (Crypto only)

3.245. postpone_encrypt_as

   Type: string
   Default: (empty)

   This is a deprecated fall-back variable for $postpone_encrypt. Please
   use $pgp_default_key or $smime_default_key. (Crypto only)

3.246. preconnect

   Type: string
   Default: (empty)

   If set, a shell command to be executed if NeoMutt fails to establish a
   connection to the server. This is useful for setting up secure
   connections, e.g. with ssh(1). If the command returns a nonzero status,
   NeoMutt gives up opening the server. Example:
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".

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

3.247. print

   Type: quadoption
   Default: ask-no

   Controls whether or not NeoMutt really prints messages. This is set to
   "ask-no" by default, because some people accidentally hit "p" often.

3.248. print_command

   Type: path
   Default: "lpr"

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

3.249. 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 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.250. 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 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.251. prompt_after

   Type: boolean
   Default: yes

   If you use an external $pager, setting this variable will cause NeoMutt
   to prompt you for a command when the pager exits rather than returning
   to the index menu. If unset, NeoMutt will return to the index menu when
   the external pager exits.

3.252. query_command

   Type: path
   Default: (empty)

   This specifies the command NeoMutt will use to make external address
   queries. The string may contain a "%s", which will be substituted with
   the query string the user types. NeoMutt will add quotes around the
   string substituted for "%s" automatically according to shell quoting
   rules, so you should avoid adding your own. If no "%s" is found in the
   string, NeoMutt will append the user's query to the end of the string.
   See "query" for more information.

3.253. 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.254. quit

   Type: quadoption
   Default: yes

   This variable controls whether "quit" and "exit" actually quit from
   NeoMutt. 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.255. quote_regex

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

   Type: number
   Default: 10

   If set to a value greater than 0, NeoMutt 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 this
   many messages have been read or searched (e.g., if set to 25, NeoMutt
   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, $net_inc and $time_inc variables and the
   "tuning" section of the manual for performance considerations.

3.257. read_only

   Type: boolean
   Default: no

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

3.258. 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
   variable will not be used when the user has set a real name in the
   $from variable.

3.259. recall

   Type: quadoption
   Default: ask-yes

   Controls whether or not NeoMutt recalls postponed messages when
   composing a new message.

   Setting this variable to yes is not generally useful, and thus not
   recommended. Note that the <recall-message> function can be used to
   manually recall postponed messages.

   Also see $postponed variable.

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

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

3.261. reflow_space_quotes

   Type: boolean
   Default: yes

   This option controls how quotes from format=flowed messages are
   displayed in the pager and when replying (with $text_flowed unset).
   When set, this option adds spaces after each level of quote marks,
   turning ">>>foo" into "> > > foo".

   Note: If $reflow_text is unset, this option has no effect. Also, this
   option does not affect replies when $text_flowed is set.

3.262. reflow_text

   Type: boolean
   Default: yes

   When set, NeoMutt will reformat paragraphs in text/plain parts marked
   format=flowed. If unset, NeoMutt will display paragraphs unaltered from
   how they appear in the message body. See RFC3676 for details on the
   format=flowed format.

   Also see $reflow_wrap, and $wrap.

3.263. reflow_wrap

   Type: number
   Default: 78

   This variable controls the maximum paragraph width when reformatting
   text/plain parts when $reflow_text is set. When the value is 0,
   paragraphs will be wrapped at the terminal's right margin. A positive
   value sets the paragraph width relative to the left margin. A negative
   value set the paragraph width relative to the right margin.

   Also see $wrap.

3.264. reply_regex

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

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

3.265. reply_self

   Type: boolean
   Default: no

   If unset and you are replying to a message sent by you, NeoMutt will
   assume that you want to reply to the recipients of that message rather
   than to yourself.

   Also see the "alternates" command.

3.266. reply_to

   Type: quadoption
   Default: ask-yes

   If set, when replying to a message, NeoMutt 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.267. reply_with_xorig

   Type: boolean
   Default: no

   This variable provides a toggle. When active, the From: header will be
   extracted from the current mail's `X-Original-To:' header. This setting
   does not have precedence over "reverse_realname".

   Assuming `fast_reply' is disabled, this option will prompt the user
   with a prefilled From: header.

3.268. resolve

   Type: boolean
   Default: yes

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

   Type: boolean
   Default: no

   If set, draft files (specified by -H on the command line) are processed
   similarly to when resuming a postponed message. Recipients are not
   prompted for; send-hooks are not evaluated; no alias expansion takes
   place; user-defined headers and signatures are not added to the
   message.

3.270. resume_edited_draft_files

   Type: boolean
   Default: yes

   If set, draft files previously edited (via -E -H on the command line)
   will have $resume_draft_files automatically set when they are used as a
   draft file again.

   The first time a draft file is saved, NeoMutt will add a header,
   X-Mutt-Resume-Draft to the saved file. The next time the draft file is
   read in, if NeoMutt sees the header, it will set $resume_draft_files.

   This option is designed to prevent multiple signatures, user-defined
   headers, and other processing effects from being made multiple times to
   the draft file.

3.271. reverse_alias

   Type: boolean
   Default: no

   This variable controls whether or not NeoMutt 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.

3.272. 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 the
   reply messages is built using the address where you received the
   messages you are replying to if that address matches your "alternates".
   If the variable is unset, or the address that would be used doesn't
   match your "alternates", the From: line will use your address on the
   current machine.

   Also see the "alternates" command.

3.273. reverse_realname

   Type: boolean
   Default: yes

   This variable fine-tunes the behavior of the $reverse_name feature.
   When it is set, NeoMutt will use the address from incoming messages
   as-is, possibly including eventual real names. When it is unset,
   NeoMutt will override any such real names with the setting of the
   $realname variable.

3.274. rfc2047_parameters

   Type: boolean
   Default: no

   When this variable is set, NeoMutt will decode RFC2047-encoded MIME
   parameters. You want to set this variable when NeoMutt suggests you 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.

   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 that
   NeoMutt generates this kind of encoding. Instead, NeoMutt will
   unconditionally use the encoding specified in RFC2231.

3.275. save_address

   Type: boolean
   Default: no

   If set, NeoMutt 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.276. 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.

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

3.277. save_history

   Type: number
   Default: 0

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

3.278. 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 recipient
   address exists (this is done by searching for a mailbox in the $folder
   directory with the username part of the recipient address). If the
   mailbox exists, the outgoing message will be saved to that mailbox,
   otherwise the message is saved to the $record mailbox.

   Also see the $force_name variable.

3.279. 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 related are used.

3.280. 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
   NeoMutt. Since NeoMutt scores are always greater than or equal to zero,
   the default setting of this variable will never mark a message for
   deletion.

3.281. score_threshold_flag

   Type: number
   Default: 9999

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

3.282. 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 NeoMutt.
   Since NeoMutt scores are always greater than or equal to zero, the
   default setting of this variable will never mark a message read.

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

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

   A colon-delimited list of character sets for outgoing messages. NeoMutt
   will use the first character set into which the text can be converted
   exactly. If your $charset is not "iso-8859-1" and recipients may not
   understand "UTF-8", it is advisable to include in the list an
   appropriate widely used standard character set (such as "iso-8859-2",
   "koi8-r" or "iso-2022-jp") either instead of or after "iso-8859-1".

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

3.285. sendmail

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

   Specifies the program and arguments used to deliver mail sent by
   NeoMutt. NeoMutt expects that the specified program interprets
   additional arguments as recipient addresses. NeoMutt appends all
   recipients after adding a -- delimiter (if not already present).
   Additional flags, such as for $use_8bitmime, $use_envelope_from,
   $dsn_notify, or $dsn_return will be added before the delimiter.

3.286. sendmail_wait

   Type: number
   Default: 0

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

   NeoMutt 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

   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.287. 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.288. save_unsubscribed

   Type: boolean
   Default: no

   When set, info about unsubscribed newsgroups will be saved into
   "newsrc" file and into cache.

3.289. show_new_news

   Type: boolean
   Default: yes

   If set, news server will be asked for new newsgroups on entering the
   browser. Otherwise, it will be done only once for a news server. Also
   controls whether or not number of new articles of subscribed newsgroups
   will be then checked.

3.290. show_only_unread

   Type: boolean
   Default: no

   If set, only subscribed newsgroups that contain unread articles will be
   displayed in browser.

3.291. sidebar_delim_chars

   Type: string
   Default: "/."

   This contains the list of characters which you would like to treat as
   folder separators for displaying paths in the sidebar.

   Local mail is often arranged in directories: `dir1/dir2/mailbox'.
set sidebar_delim_chars='/'

   IMAP mailboxes are often named: `folder1.folder2.mailbox'.
set sidebar_delim_chars='.'

   See also: $sidebar_short_path, $sidebar_folder_indent,
   $sidebar_indent_string.

3.292. sidebar_divider_char

   Type: string
   Default: (empty)

   This specifies the characters to be drawn between the sidebar (when
   visible) and the other NeoMutt panels. ASCII and Unicode line-drawing
   characters are supported.

3.293. sidebar_folder_indent

   Type: boolean
   Default: no

   Set this to indent mailboxes in the sidebar.

   See also: $sidebar_short_path, $sidebar_indent_string,
   $sidebar_delim_chars.

3.294. sidebar_format

   Type: string
   Default: "%B%*  %n"

   This variable allows you to customize the sidebar display. This string
   is similar to $index_format, but has its own set of printf(3)-like
   sequences:
   %B Name of the mailbox
   %S * Size of mailbox (total number of messages)
   %N * Number of unread messages in the mailbox
   %n N if mailbox has new mail, blank otherwise
   %F * Number of Flagged messages in the mailbox
   %! "!" : one flagged message; "!!" : two flagged messages; "n!" : n
   flagged messages (for n > 2). Otherwise prints nothing.
   %d * @ Number of deleted messages
   %L * @ Number of messages after limiting
   %t * @ Number of tagged messages
   %>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

   * = Can be optionally printed if nonzero @ = Only applicable to the
   current folder

   In order to use %S, %N, %F, and %!, $mail_check_stats must be set. When
   thus set, a suggested value for this option is "%B%?F? [%F]?%*
   %?N?%N/?%S".

3.295. sidebar_indent_string

   Type: string
   Default: "  "

   This specifies the string that is used to indent mailboxes in the
   sidebar. It defaults to two spaces.

   See also: $sidebar_short_path, $sidebar_folder_indent,
   $sidebar_delim_chars.

3.296. sidebar_new_mail_only

   Type: boolean
   Default: no

   When set, the sidebar will only display mailboxes containing new, or
   flagged, mail.

   See also: sidebar_whitelist.

3.297. sidebar_next_new_wrap

   Type: boolean
   Default: no

   When set, the <sidebar-next-new> command will not stop and the end of
   the list of mailboxes, but wrap around to the beginning. The
   <sidebar-prev-new> command is similarly affected, wrapping around to
   the end of the list.

3.298. sidebar_on_right

   Type: boolean
   Default: no

   When set, the sidebar will appear on the right-hand side of the screen.

3.299. sidebar_short_path

   Type: boolean
   Default: no

   By default the sidebar will show the mailbox's path, relative to the
   $folder variable. Setting sidebar_shortpath=yes will shorten the names
   relative to the previous name. Here's an example:
   shortpath=no shortpath=yes shortpath=yes, folderindent=yes,
   indentstr=".."
   fruit fruit fruit
   fruit.apple apple ..apple
   fruit.banana banana ..banana
   fruit.cherry cherry ..cherry

   See also: $sidebar_delim_chars, $sidebar_folder_indent,
   $sidebar_indent_string, $sidebar_component_depth.

3.300. sidebar_sort_method

   Type: sort order
   Default: order

   Specifies how to sort entries in the file browser. By default, the
   entries are sorted alphabetically. Valid values:
     * alpha (alphabetically)
     * count (all message count)
     * flagged (flagged message count)
     * name (alphabetically)
     * new (unread message count)
     * path (alphabetically)
     * unread (unread message count)
     * unsorted

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

3.301. sidebar_component_depth

   Type: number
   Default: 0

   By default the sidebar will show the mailbox's path, relative to the
   $folder variable. This specifies the number of parent directories to
   hide from display in the sidebar. For example: If a maildir is normally
   displayed in the sidebar as dir1/dir2/dir3/maildir, setting
   sidebar_component_depth=2 will display it as dir3/maildir, having
   truncated the 2 highest directories.

   See also: $sidebar_short_path

3.302. sidebar_visible

   Type: boolean
   Default: no

   This specifies whether or not to show sidebar. The sidebar shows a list
   of all your mailboxes.

   See also: $sidebar_format, $sidebar_width

3.303. sidebar_width

   Type: number
   Default: 30

   This controls the width of the sidebar. It is measured in screen
   columns. For example: sidebar_width=20 could display 20 ASCII
   characters, or 10 Chinese characters.

3.304. sig_dashes

   Type: boolean
   Default: yes

   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, NeoMutt has the ability to
   highlight the signature in a different color in the built-in pager.

3.305. sig_on_top

   Type: boolean
   Default: no

   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.306. 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
   assumed that filename is a shell command and input should be read from
   its standard output.

3.307. simple_search

   Type: string
   Default: "~f %s | ~s %s"

   Specifies how NeoMutt should expand a simple search into a real search
   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,
   NeoMutt 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.308. skip_quoted_offset

   Type: number
   Default: 0

   Lines of quoted text that are displayed before the unquoted text after
   "skip to quoted" command (S)

3.309. 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 a value of zero for this option suppresses the pause.

3.310. 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.311. smileys

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

   The pager uses this variable to catch some common false positives of
   $quote_regex, 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.312. 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.313. 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.314. smime_certificates

   Type: path
   Default: (empty)

   Since for S/MIME there is no pubring/secring as with PGP, NeoMutt 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.315. 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
   %i Intermediate certificates
   %c One or more certificate IDs.
   %a The algorithm used for encryption.
   %d The message digest algorithm specified with $smime_sign_digest_alg.
   %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.316. smime_decrypt_use_default_key

   Type: boolean
   Default: yes

   If set (default) this tells NeoMutt to use the default key for
   decryption. Otherwise, if managing multiple certificate-key-pairs,
   NeoMutt 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.317. smime_default_key

   Type: string
   Default: (empty)

   This is the default key-pair to use for S/MIME operations, and must be
   set to the keyid (the hash-value that OpenSSL generates) to work
   properly.

   It will be used for encryption (see $postpone_encrypt and
   $smime_self_encrypt).

   It will be used for decryption unless $smime_decrypt_use_default_key is
   unset.

   It will also be used for signing unless $smime_sign_as is set.

   The (now deprecated) smime_self_encrypt_as is an alias for this
   variable, and should no longer be used. (S/MIME only)

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

   Encrypt the message to $smime_default_key too. (S/MIME only)

3.319. smime_encrypt_with

   Type: string
   Default: "aes256"

   This sets the algorithm that should be used for encryption. Valid
   choices are "aes128", "aes192", "aes256", "des", "des3", "rc2-40",
   "rc2-64", "rc2-128". (S/MIME only)

3.320. 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.321. 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.322. 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.323. 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. NOTE: %c and %k will default to
   $smime_sign_as if set, otherwise $smime_default_key. (S/MIME only)

3.324. smime_is_default

   Type: boolean
   Default: no

   The default behavior of NeoMutt 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
   NeoMutt 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.325. smime_keys

   Type: path
   Default: (empty)

   Since for S/MIME there is no pubring/secring as with PGP, NeoMutt 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.326. 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.327. smime_self_encrypt

   Type: boolean
   Default: yes

   When set, S/MIME encrypted messages will also be encrypted using the
   certificate in $smime_default_key. (S/MIME only)

3.328. smime_sign_as

   Type: string
   Default: (empty)

   If you have a separate key to use for signing, you should set this to
   the signing key. Most people will only need to set $smime_default_key.
   (S/MIME only)

3.329. 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.330. smime_sign_digest_alg

   Type: string
   Default: "sha256"

   This sets the algorithm that should be used for the signature message
   digest. Valid choices are "md5", "sha1", "sha224", "sha256", "sha384",
   "sha512". (S/MIME only)

3.331. smime_timeout

   Type: number
   Default: 300

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

3.332. 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.333. 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.334. smtp_authenticators

   Type: string
   Default: (empty)

   This is a colon-delimited list of authentication methods NeoMutt may
   attempt to use to log in to an SMTP server, in the order NeoMutt should
   try them. Authentication methods are any SASL mechanism, e.g. "plain",
   "digest-md5", "gssapi" or "cram-md5". This option is case-insensitive.
   If it is "unset" (the default) NeoMutt will try all available methods,
   in order from most-secure to least-secure. Support for the "plain"
   mechanism is bundled; other mechanisms are provided by an external SASL
   library (look for +USE_SASL in the output of neomutt -v).

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

3.335. smtp_pass

   Type: string
   Default: (empty)

   Specifies the password for your SMTP account. If unset, NeoMutt will
   prompt you for your password when you first send mail via SMTP. See
   $smtp_url to configure NeoMutt 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 neomuttrc even if
   you are the only one who can read the file.

3.336. 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, e.g.:
smtp[s]://[user[:pass]@]host[:port]

   where "[...]" denotes an optional part. Setting this variable overrides
   the value of the $sendmail variable.

3.337. sort

   Type: sort order
   Default: date

   Specifies how to sort messages in the "index" menu. Valid values are:
     * date or date-sent
     * date-received
     * from
     * mailbox-order (unsorted)
     * score
     * size
     * spam
     * subject
     * threads
     * to

   You may optionally use the "reverse-" prefix to specify reverse sorting
   order.

   Example:
set sort=reverse-date-sent

3.338. sort_alias

   Type: sort order
   Default: alias

   Specifies how the entries in the "alias" menu are sorted. The following
   are legal values:
     * address (sort alphabetically by email address)
     * alias (sort alphabetically by alias name)
     * unsorted (leave in order specified in .neomuttrc)

3.339. 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, NeoMutt will just use "date-sent"). You can
   also specify the "last-" prefix in addition to the "reverse-" prefix,
   but "last-" must come after "reverse-". The "last-" prefix causes
   messages to be sorted against its siblings by which has the last
   descendant, using the rest of $sort_aux as an ordering. For instance,
set sort_aux=last-date-received

   would mean that if a new message is received in a thread, that thread
   becomes the last one displayed (or the first, if you have "set
   sort=reverse-threads".)

   Note: For reversed $sort order $sort_aux is reversed again (which is
   not the right thing to do, but kept to not break any existing
   configuration setting).

3.340. 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)
     * count (all message count)
     * date
     * desc (description)
     * new (new message count)
     * size
     * unsorted

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

3.341. sort_re

   Type: boolean
   Default: yes

   This variable is only useful when sorting by mailboxes in sidebar. By
   default, entries are unsorted. Valid values:
     * count (all message count)
     * desc (virtual mailbox description)
     * new (new message count)
     * path
     * unsorted

3.342. 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.343. spoolfile

   Type: path
   Default: (empty)

   If your spool mailbox is in a non-default place where NeoMutt cannot
   find it, you can specify its location with this variable. NeoMutt will
   initially set this variable to the value of the environment variable
   $MAIL or $MAILDIR if either is defined.

3.344. ssl_client_cert

   Type: path
   Default: (empty)

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

3.345. ssl_force_tls

   Type: boolean
   Default: no

   If this variable is set, NeoMutt 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.346. ssl_starttls

   Type: quadoption
   Default: yes

   If set (the default), NeoMutt will attempt to use STARTTLS on servers
   advertising the capability. When unset, NeoMutt will not attempt to use
   STARTTLS regardless of the server's capabilities.

3.347. ssl_use_sslv2

   Type: boolean
   Default: no

   This variable specifies whether to attempt to use SSLv2 in the SSL
   authentication process. Note that SSLv2 and SSLv3 are now considered
   fundamentally insecure and are no longer recommended. (OpenSSL only)

3.348. ssl_use_sslv3

   Type: boolean
   Default: no

   This variable specifies whether to attempt to use SSLv3 in the SSL
   authentication process. Note that SSLv2 and SSLv3 are now considered
   fundamentally insecure and are no longer recommended.

3.349. ssl_use_tlsv1

   Type: boolean
   Default: yes

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

3.350. ssl_use_tlsv1_1

   Type: boolean
   Default: yes

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

3.351. ssl_use_tlsv1_2

   Type: boolean
   Default: yes

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

3.352. ssl_usesystemcerts

   Type: boolean
   Default: yes

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

3.353. ssl_verify_dates

   Type: boolean
   Default: yes

   If set (the default), NeoMutt 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.354. ssl_verify_host

   Type: boolean
   Default: yes

   If set (the default), NeoMutt 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.355. ssl_verify_partial_chains

   Type: boolean
   Default: no

   This option should not be changed from the default unless you
   understand what you are doing.

   Setting this variable to yes will permit verifying partial
   certification chains, i. e. a certificate chain where not the root, but
   an intermediate certificate CA, or the host certificate, are marked
   trusted (in $certificate_file), without marking the root signing CA as
   trusted.

   (OpenSSL 1.0.2b and newer only).

3.356. ssl_ciphers

   Type: string
   Default: (empty)

   Contains a colon-separated list of ciphers to use when using SSL. For
   OpenSSL, see ciphers(1) for the syntax of the string.

   For GnuTLS, this option will be used in place of "NORMAL" at the start
   of the priority string. See gnutls_priority_init(3) for the syntax and
   more details. (Note: GnuTLS version 2.1.7 or higher is required.)

3.357. status_chars

   Type: string
   Default: "-*%A"

   Controls the characters used by the "%r" indicator in $status_format.
   Character Default Description
   1 - Mailbox is unchanged
   2 * Mailbox has been changed and needs to be resynchronized
   3 % Mailbox is read-only, or will not be written when exiting. (You can
   toggle whether to write changes to a mailbox with the <toggle-write>
   operation, bound by default to "%")
   4 A Folder opened in attach-message mode. (Certain operations like
   composing a new mail, replying, forwarding, etc. are not permitted in
   this mode)

3.358. status_format

   Type: string
   Default: "-%r-NeoMutt: %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
   %R Number of read messages *
   %s Current sorting mode ($sort)
   %S Current aux sorting method ($sort_aux)
   %t Number of tagged messages *
   %u Number of unread messages *
   %v NeoMutt 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

   Some of the above sequences can be used to optionally print a string if
   their value is nonzero. For example, you may only want to see the
   number of flagged messages if such messages exist, since zero is not
   particularly meaningful. To optionally print a string based upon one of
   the above sequences, the following construct is used:

   %?<sequence_char>?<optional_string>?

   where sequence_char is a character from the table above, and
   optional_string is the string you would like printed if sequence_char
   is nonzero. optional_string may contain other sequences as well as
   normal text, but you may not nest optional strings.

   Here is an example illustrating how to optionally print the number of
   new messages in a mailbox:

   %?n?%n new messages.?

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

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

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

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

   If you prefix the sequence character with a colon (":") character,
   NeoMutt 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.359. 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. If $help is set,
   too it'll be placed at the bottom.

3.360. 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 default,
   messages with the same subject are grouped together in "pseudo
   threads.". This may not always be desirable, such as in a personal
   mailbox where you might have several unrelated messages with the
   subjects like "hi" which will get grouped together. See also $sort_re
   for a less drastic way of controlling this behavior.

3.361. suspend

   Type: boolean
   Default: yes

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

3.362. text_flowed

   Type: boolean
   Default: no

   When set, NeoMutt 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 features, you'll need support in
   your editor.

   Note that $indent_string is ignored when this option is set.

3.363. thorough_search

   Type: boolean
   Default: yes

   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.

   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 NeoMutt 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.364. thread_received

   Type: boolean
   Default: no

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

3.365. tilde

   Type: boolean
   Default: no

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

3.366. time_inc

   Type: number
   Default: 0

   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 apart. This can improve
   throughput on systems with slow terminals, or when running NeoMutt on a
   remote system.

   Also see the "tuning" section of the manual for performance
   considerations.

3.367. timeout

   Type: number
   Default: 600

   When NeoMutt is waiting for user input either idling in menus or in an
   interactive prompt, NeoMutt would block until input is present.
   Depending on the context, this would prevent certain operations from
   working, like checking for new mail or keeping an IMAP connection
   alive.

   This variable controls how many seconds NeoMutt will at most wait until
   it aborts waiting for input, performs these operations and continues to
   wait for input.

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

3.368. tmpdir

   Type: path
   Default: (empty)

   This variable allows you to specify where NeoMutt 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.369. to_chars

   Type: string
   Default: " +TCFL"

   Controls the character used to indicate mail addressed to you.
   Character Default Description
   1 <space> The mail is not addressed to your address.
   2 + You are the only recipient of the message.
   3 T Your address appears in the "To:" header field, but you are not the
   only recipient of the message.
   4 C Your address is specified in the "Cc:" header field, but you are
   not the only recipient.
   5 F Indicates the mail that was sent by you.
   6 L Indicates the mail was sent to a mailing-list you subscribe to.

3.370. flag_chars

   Type: string
   Default: "*!DdrONon- "

   Controls the characters used in several flags.
   Character Default Description
   1         *       The mail is tagged.
   2         !       The mail is flagged as important.
   3         D       The mail is marked for deletion.
   4         d       The mail has attachments marked for deletion.
   5         r       The mail has been replied to.
   6         O       The mail is Old (Unread but seen).
   7         N       The mail is New (Unread but not seen).
   8         o       The mail thread is Old (Unread but seen).
   9         n       The mail thread is New (Unread but not seen).
   10        -       The mail is read - %S expando.
   11        <space> The mail is read - %Z expando.

3.371. trash

   Type: path
   Default: (empty)

   If set, this variable specifies the path of the trash folder where the
   mails marked for deletion will be moved, instead of being irremediably
   purged.

   NOTE: When you delete a message in the trash folder, it is really
   deleted, so that you have a way to clean the trash.

3.372. ts_icon_format

   Type: string
   Default: "M%?n?AIL&ail?"

   Controls the format of the icon title, as long as "$ts_enabled" is set.
   This string is identical in formatting to the one used by
   "$status_format".

3.373. ts_enabled

   Type: boolean
   Default: no

   Controls whether NeoMutt tries to set the terminal status line and icon
   name. Most terminal emulators emulate the status line in the window
   title.

3.374. ts_status_format

   Type: string
   Default: "NeoMutt with %?m?%m messages&no messages?%?n? [%n NEW]?"

   Controls the format of the terminal status line (or window title),
   provided that "$ts_enabled" has been set. This string is identical in
   formatting to the one used by "$status_format".

3.375. tunnel

   Type: string
   Default: (empty)

   Setting this variable will cause NeoMutt 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/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.

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

3.376. uncollapse_jump

   Type: boolean
   Default: no

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

3.377. uncollapse_new

   Type: boolean
   Default: yes

   When set, NeoMutt will automatically uncollapse any collapsed thread
   that receives a new message. When unset, collapsed threads will remain
   collapsed. the presence of the new message will still affect index
   sorting, though.

3.378. 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 8.8.x) or
   you may not be able to send mail.

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

3.379. use_domain

   Type: boolean
   Default: yes

   When set, NeoMutt will qualify all local addresses (ones without the
   "@host" portion) with the value of $hostname. If unset, no addresses
   will be qualified.

3.380. use_envelope_from

   Type: boolean
   Default: no

   When set, NeoMutt will set the envelope sender of the message. If
   $envelope_from_address is set, it will be used as the sender address.
   If unset, NeoMutt 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.381. use_from

   Type: boolean
   Default: yes

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

   Type: boolean
   Default: yes

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

3.383. user_agent

   Type: boolean
   Default: yes

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

3.384. visual

   Type: path
   Default: (empty)

   Specifies the visual editor to invoke when the "~v" command is given in
   the built-in editor.

3.385. wait_key

   Type: boolean
   Default: yes

   Controls whether NeoMutt 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
   that the corresponding mailcap entry has a needsterminal flag, and the
   external program is interactive.

   When set, NeoMutt will always ask for a key. When unset, NeoMutt will
   wait for a key only if the external command returned a non-zero status.

3.386. weed

   Type: boolean
   Default: yes

   When set, NeoMutt will weed headers when displaying, forwarding,
   printing, or replying to messages.

3.387. wrap

   Type: number
   Default: 0

   When set to a positive value, NeoMutt will wrap text at $wrap
   characters. When set to a negative value, NeoMutt will wrap text so
   that there are $wrap characters of empty space on the right side of the
   terminal. Setting it to zero makes NeoMutt wrap at the terminal width.

   Also see $reflow_wrap.

3.388. wrap_headers

   Type: number
   Default: 78

   This option specifies the number of characters to use for wrapping an
   outgoing message's headers. Allowed values are between 78 and 998
   inclusive.

   Note: This option usually shouldn't be changed. RFC5233 recommends a
   line length of 78 (the default), so please only change this setting
   when you know what you're doing.

3.389. wrap_search

   Type: boolean
   Default: yes

   Controls whether searches wrap around the end.

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

3.390. write_bcc

   Type: boolean
   Default: yes

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

3.391. 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 single message will
   be displayed before writing a mailbox.

   Also see the $read_inc, $net_inc and $time_inc variables and the
   "tuning" section of the manual for performance considerations.

3.392. x_comment_to

   Type: boolean
   Default: no

   If set, NeoMutt will add "X-Comment-To:" field (that contains full name
   of original article author) to article that followuped to newsgroup.

3.393. collapse_all

   Type: boolean
   Default: no

   When set, NeoMutt will collapse all threads when entering a folder.

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

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 9.2. Default Generic Menu Bindings
       Function      Default key                 Description
   <top-page>        H           move to the top of the page
   <next-entry>      j           move to the next entry
   <previous-entry>  k           move to the previous entry
   <bottom-page>     L           move to the bottom of the page
   <refresh>         ^L          clear and redraw the screen
   <middle-page>     M           move to the middle of the page
   <search-next>     n           search for next match
   <exit>            q           exit this menu
   <tag-entry>       t           tag the current entry
   <next-page>       z           move to the next page
   <previous-page>   Z           move to the previous page
   <last-entry>      *           move to the last entry
   <first-entry>     =           move to the first entry
   <enter-command>   :           enter a neomuttrc 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>    <Enter>     select the current entry
   <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 Menu Bindings
   Function Default key Description
   <create-alias> a create an alias from a message sender
   <bounce-message> b remail a message to another user
   <break-thread> # break the thread in two
   <change-folder> c open a different folder
   <change-folder-readonly> Esc c open a different folder in read only
   mode
   <change-newsgroup>   open a different newsgroup
   <change-newsgroup-readonly>   open a different newsgroup in read only
   mode
   <next-unread-mailbox>   open next mailbox with new mail
   <collapse-thread> Esc v collapse/uncollapse current thread
   <collapse-all> Esc V collapse/uncollapse all threads
   <copy-message> C copy a message to a file/mailbox
   <decode-copy> Esc C make decoded (text/plain) copy
   <decode-save> Esc s make decoded copy (text/plain) and delete
   <delete-message> d delete the current entry
   <delete-pattern> D delete messages matching a pattern
   <delete-thread> ^D delete all messages in thread
   <delete-subthread> Esc d delete all messages in subthread
   <edit>   edit the raw message (edit and edit-raw-message are synonyms)
   <edit-raw-message>   edit the raw message (edit and edit-raw-message
   are synonyms)
   <edit-label> Y add, change, or delete a message's label
   <edit-or-view-raw-message> e edit the raw message if the mailbox is not
   read-only, otherwise view it
   <edit-type> ^E edit attachment content type
   <forward-message> f forward a message with comments
   <forward-to-group>   forward to newsgroup
   <followup-message>   followup to newsgroup
   <get-children>   get all children of the current message
   <get-message>   get message with Message-Id
   <get-parent>   get parent of the current message
   <reconstruct-thread>   reconstruct thread containing current message
   <flag-message> F toggle a message's 'important' flag
   <group-reply> g reply to all recipients
   <fetch-mail> G retrieve mail from POP server
   <imap-fetch-mail>   force retrieval of mail from IMAP server
   <imap-logout-all>   logout from all IMAP servers
   <display-toggle-weed> h display message and toggle header weeding
   <next-undeleted> j move to the next undeleted message
   <previous-undeleted> k move to the previous undeleted message
   <limit> l show only messages matching a pattern
   <limit-current-thread>   limit view to current thread
   <link-threads> & link tagged message to the current one
   <list-reply> L reply to specified mailing list
   <mail> m compose a new mail message
   <toggle-new> N toggle a message's 'new' flag
   <toggle-write> % toggle whether the mailbox will be rewritten
   <next-thread> ^N jump to the next thread
   <next-subthread> Esc n jump to the next subthread
   <purge-message>   delete the current entry, bypassing the trash folder
   <purge-thread>   delete the current thread, bypassing the trash folder
   <query> Q query external program for addresses
   <quit> q save changes to mailbox and quit
   <reply> r reply to a message
   <show-limit> Esc l show currently active limit pattern
   <sort-mailbox> o sort messages
   <sort-reverse> O sort messages in reverse order
   <print-message> p print the current entry
   <post-message>   post message to newsgroup
   <previous-thread> ^P jump to previous thread
   <previous-subthread> Esc p jump to previous subthread
   <recall-message> R recall a postponed message
   <read-thread> ^R mark the current thread as read
   <read-subthread> Esc r mark the current subthread as read
   <resend-message> Esc e use the current message as a template for a new
   one
   <compose-to-sender>   compose a new message to the sender
   <save-message> s save message/attachment to a mailbox/file
   <tag-pattern> T tag messages matching a pattern
   <tag-subthread>   tag the current subthread
   <tag-thread> Esc t tag the current thread
   <untag-pattern> ^T untag messages matching a pattern
   <undelete-message> u undelete the current entry
   <undelete-pattern> U undelete messages matching a pattern
   <undelete-subthread> Esc u undelete all messages in subthread
   <undelete-thread> ^U undelete all messages in thread
   <view-attachments> v show MIME attachments
   <view-raw-message>   show the raw message
   <show-version> V show the NeoMutt version number and date
   <set-flag> w set a status flag on a message
   <clear-flag> W clear a status flag from a message
   <toggle-read>   toggle view of read messages
   <catchup>   mark all articles in newsgroup as read
   <display-message> <Enter> display a message
   <display-message> <Return> display a message
   <mark-message> ~ create a hotkey macro for the current 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> P jump to parent message in thread
   <root-message>   jump to root message in thread
   <extract-keys> ^K extract supported public keys
   <forget-passphrase> ^F wipe passphrase(s) from memory
   <check-traditional-pgp> Esc P check for classic PGP
   <mail-key> Esc k mail a PGP public key
   <decrypt-copy>   make decrypted copy
   <decrypt-save>   make decrypted copy and delete
   <quasi-delete>   delete from NeoMutt, don't touch on disk
   <sidebar-next>   move the highlight to next mailbox
   <sidebar-next-new>   move the highlight to next mailbox with new mail
   <sidebar-open>   open highlighted mailbox
   <sidebar-page-down>   scroll the sidebar down 1 page
   <sidebar-page-up>   scroll the sidebar up 1 page
   <sidebar-prev>   move the highlight to previous mailbox
   <sidebar-prev-new>   move the highlight to previous mailbox with new
   mail
   <sidebar-toggle-virtual>   toggle between mailboxes and virtual
   mailboxes
   <sidebar-toggle-visible>   make the sidebar (in)visible
   <modify-tags>   modify (notmuch/imap) tags
   <modify-tags-then-hide>   modify (notmuch/imap) tags and then hide
   message
   <modify-labels>   modify (notmuch/imap) tags
   <modify-labels-then-hide>   modify (notmuch/imap) tags and then hide
   message

4.3. Pager Menu

   Table 9.4. Default Pager Menu Bindings
   Function Default key Description
   <break-thread> # break the thread in two
   <create-alias> a create an alias from a message sender
   <bounce-message> b remail a message to another user
   <change-folder> c open a different folder
   <change-folder-readonly> Esc c open a different folder in read only
   mode
   <change-newsgroup>   open a different newsgroup
   <change-newsgroup-readonly>   open a different newsgroup in read only
   mode
   <next-unread-mailbox>   open next mailbox with new mail
   <copy-message> C copy a message to a file/mailbox
   <decode-copy> Esc C make decoded (text/plain) copy
   <delete-message> d delete the current entry
   <delete-thread> ^D delete all messages in thread
   <delete-subthread> Esc d delete all messages in subthread
   <set-flag> w set a status flag on a message
   <clear-flag> W clear a status flag from a message
   <edit>   edit the raw message (edit and edit-raw-message are synonyms)
   <edit-raw-message>   edit the raw message (edit and edit-raw-message
   are synonyms)
   <edit-label> Y add, change, or delete a message's label
   <edit-or-view-raw-message> e edit the raw message if the mailbox is not
   read-only, otherwise view it
   <edit-type> ^E edit attachment content type
   <followup-message>   followup to newsgroup
   <forward-to-group>   forward to newsgroup
   <forward-message> f forward a message with comments
   <flag-message> F toggle a message's 'important' flag
   <group-reply> g reply to all recipients
   <imap-fetch-mail>   force retrieval of mail from IMAP server
   <imap-logout-all>   logout from all IMAP servers
   <display-toggle-weed> h display message and toggle header weeding
   <next-undeleted> j move to the next undeleted message
   <next-entry> J move to the next entry
   <previous-undeleted> k move to the previous undeleted message
   <previous-entry> K move to the previous entry
   <link-threads> & link tagged message to the current one
   <list-reply> L reply to specified mailing list
   <redraw-screen> ^L clear and redraw the screen
   <mail> m compose a new mail message
   <mark-as-new> N toggle a message's 'new' flag
   <search-next> n search for next match
   <next-thread> ^N jump to the next thread
   <next-subthread> Esc n jump to the next subthread
   <sort-mailbox> o sort messages
   <sort-reverse> O sort messages in reverse order
   <print-message> p print the current entry
   <post-message>   post message to newsgroup
   <previous-thread> ^P jump to previous thread
   <previous-subthread> Esc p jump to previous subthread
   <purge-message>   delete the current entry, bypassing the trash folder
   <purge-thread>   delete the current thread, bypassing the trash folder
   <quit> Q save changes to mailbox and quit
   <exit> q exit this menu
   <reply> r reply to a message
   <recall-message> R recall a postponed message
   <reconstruct-thread>   reconstruct thread containing current message
   <read-thread> ^R mark the current thread as read
   <read-subthread> Esc r mark the current subthread as read
   <resend-message> Esc e use the current message as a template for a new
   one
   <compose-to-sender>   compose a new message to the sender
   <save-message> s save message/attachment to a mailbox/file
   <skip-quoted> S skip beyond quoted text
   <decode-save> Esc s make decoded copy (text/plain) and delete
   <tag-message> t tag the current entry
   <toggle-quoted> T toggle display of quoted text
   <undelete-message> u undelete the current entry
   <undelete-subthread> Esc u undelete all messages in subthread
   <undelete-thread> ^U undelete all messages in thread
   <view-attachments> v show MIME attachments
   <view-raw-message>   show the raw message
   <show-version> V show the NeoMutt 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
   <next-new-then-unread> <Tab> jump to the next new or unread 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 neomuttrc 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> <Enter> scroll down one line
   <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-new-then-unread>   jump to the previous new or unread 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> P jump to parent message in thread
   <root-message>   jump to root message in thread
   <check-traditional-pgp> Esc P check for classic PGP
   <mail-key> Esc k mail a PGP public key
   <extract-keys> ^K extract supported public keys
   <forget-passphrase> ^F wipe 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
   <quasi-delete>   delete from NeoMutt, don't touch on disk
   <sidebar-next>   move the highlight to next mailbox
   <sidebar-next-new>   move the highlight to next mailbox with new mail
   <sidebar-open>   open highlighted mailbox
   <sidebar-page-down>   scroll the sidebar down 1 page
   <sidebar-page-up>   scroll the sidebar up 1 page
   <sidebar-prev>   move the highlight to previous mailbox
   <sidebar-prev-new>   move the highlight to previous mailbox with new
   mail
   <sidebar-toggle-virtual>   toggle between mailboxes and virtual
   mailboxes
   <sidebar-toggle-visible>   make the sidebar (in)visible
   <modify-tags>   modify (notmuch/imap) tags
   <modify-tags-then-hide>   modify (notmuch/imap) tags and then hide
   message
   <modify-labels>   modify (notmuch/imap) tags
   <modify-labels-then-hide>   modify (notmuch/imap) tags and then hide
   message

4.4. Alias Menu

   Table 9.5. Default Alias Menu Bindings
       Function     Default key        Description
   <delete-entry>   d           delete the current entry
   <undelete-entry> u           undelete the current entry

4.5. Query Menu

   Table 9.6. Default Query Menu Bindings
      Function    Default key                 Description
   <create-alias> a           create an alias from a message sender
   <mail>         m           compose a new mail message
   <query>        Q           query external program for addresses
   <query-append> A           append new query results to current results

4.6. Attachment Menu

   Table 9.7. Default Attachment Menu Bindings
   Function Default key Description
   <bounce-message> b remail a message to another user
   <display-toggle-weed> h display message and toggle header weeding
   <edit-type> ^E edit attachment content type
   <followup-message>   followup to newsgroup
   <forward-to-group>   forward to newsgroup
   <print-entry> p print the current entry
   <save-entry> s save message/attachment to a mailbox/file
   <pipe-entry> | pipe message/attachment to a shell command
   <view-mailcap> m force viewing of attachment using mailcap
   <reply> r reply to a message
   <resend-message> Esc e use the current message as a template for a new
   one
   <group-reply> g reply to all recipients
   <list-reply> L reply to specified mailing list
   <forward-message> f forward a message with comments
   <view-text> T view attachment as text
   <view-attach> <Enter> view attachment using mailcap entry if necessary
   <view-attach> <Return> view attachment using mailcap entry if necessary
   <delete-entry> d delete the current entry
   <undelete-entry> u undelete the current entry
   <collapse-parts> v toggle display of subparts
   <check-traditional-pgp> Esc P check for classic PGP
   <extract-keys> ^K extract supported public keys
   <forget-passphrase> ^F wipe passphrase(s) from memory

4.7. Compose Menu

   Table 9.8. Default Compose Menu Bindings
   Function Default key Description
   <attach-file> a attach file(s) to this message
   <attach-message> A attach message(s) to this message
   <attach-news-message>   attach news article(s) to this message
   <edit-bcc> b edit the BCC list
   <edit-cc> c edit the CC list
   <copy-file> C save message/attachment to a mailbox/file
   <detach-file> D delete the current entry
   <toggle-disposition> ^D toggle disposition between inline/attachment
   <edit-description> d edit attachment description
   <edit-message> e edit the message
   <edit-headers> E edit the message with headers
   <edit-file> ^X e edit the file to be attached
   <edit-encoding> ^E edit attachment transfer-encoding
   <edit-from> Esc f edit the from field
   <edit-fcc> f enter a file to save a copy of this message in
   <filter-entry> F filter attachment through a shell command
   <get-attachment> G get a temporary copy of an attachment
   <display-toggle-weed> h display message and toggle header weeding
   <ispell> i run ispell on the message
   <print-entry> l print the current entry
   <edit-mime> m edit attachment using mailcap entry
   <new-mime> n compose new attachment using mailcap entry
   <edit-newsgroups>   edit the newsgroups list
   <edit-followup-to>   edit the Followup-To field
   <edit-x-comment-to>   edit the X-Comment-To field
   <postpone-message> P save this message to send later
   <edit-reply-to> r edit the Reply-To field
   <rename-attachment> ^O send attachment with a different name
   <rename-file> R rename/move an attached file
   <edit-subject> s edit the subject of this message
   <edit-to> t edit the TO list
   <edit-type> ^T edit attachment content type
   <write-fcc> w write the message to a folder
   <toggle-unlink> u toggle whether to delete file after sending it
   <toggle-recode>   toggle recoding of this attachment
   <update-encoding> U update an attachment's encoding info
   <view-attach> <Enter> view attachment using mailcap entry if necessary
   <view-attach> <Return> view attachment using mailcap entry if necessary
   <send-message> y send the message
   <pipe-entry> | pipe message/attachment to a shell command
   <attach-key> Esc k attach a PGP public key
   <pgp-menu> p show PGP options
   <forget-passphrase> ^F wipe passphrase(s) from memory
   <smime-menu> S show S/MIME options

4.8. Postpone Menu

   Table 9.9. Default Postpone Menu Bindings
       Function     Default key        Description
   <delete-entry>   d           delete the current entry
   <undelete-entry> u           undelete the current entry

4.9. Browser Menu

   Table 9.10. Default Browser Menu Bindings
   Function Default key Description
   <change-dir> c change directories
   <goto-parent> p go to parent directory
   <display-filename> @ display the currently selected file's name
   <enter-mask> m enter a file mask
   <sort> o sort messages
   <sort-reverse> O sort messages in reverse order
   <select-new> N select a new file in this directory
   <check-new>   check mailboxes for new mail
   <toggle-mailboxes> <Tab> toggle whether to browse mailboxes or all
   files
   <reload-active>   load list of all newsgroups from NNTP server
   <subscribe-pattern>   subscribe to newsgroups matching a pattern
   <unsubscribe-pattern>   unsubscribe from newsgroups matching a pattern
   <catchup>   mark all articles in newsgroup as read
   <uncatchup>   mark all articles in newsgroup as unread
   <view-file> <Space> view file
   <buffy-list> . list mailboxes with new mail
   <create-mailbox> C create a new mailbox (IMAP only)
   <delete-mailbox> d delete the current mailbox (IMAP only)
   <rename-mailbox> r rename the current mailbox (IMAP only)
   <subscribe> s subscribe to current mbox (IMAP/NNTP only)
   <unsubscribe> u unsubscribe from current mbox (IMAP/NNTP only)
   <toggle-subscribed> T toggle view all/subscribed mailboxes (IMAP only)
   <goto-folder> = swap the current folder position with $folder if it
   exists

4.10. Pgp Menu

   Table 9.11. Default Pgp Menu Bindings
     Function   Default key       Description
   <verify-key> c           verify a PGP public key
   <view-name>  %           view the key's user id

4.11. Editor Menu

   Table 9.12. Default Editor Menu Bindings
   Function Default key Description
   <bol> ^A jump to the beginning of the line
   <backward-char> ^B move the cursor one character to the left
   <backward-word> Esc b move the cursor to the beginning of the word
   <capitalize-word> Esc c capitalize the word
   <downcase-word> Esc l convert the word to lower case
   <upcase-word> Esc u convert the word to upper case
   <delete-char> ^D delete the char under the cursor
   <eol> ^E jump to the end of the line
   <forward-char> ^F move the cursor one character to the right
   <forward-word> Esc f move the cursor to the end of the word
   <backspace> <Backspace> delete the char in front of the cursor
   <kill-eol> ^K delete chars from cursor to end of line
   <kill-eow> Esc d delete chars from the cursor to the end of the word
   <kill-line> ^U delete all chars on the line
   <quote-char> ^V quote the next typed key
   <kill-word> ^W delete the word in front of the cursor
   <complete> <Tab> complete filename or alias
   <complete-query> ^T complete 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
   <history-search> ^R search through the history list
   <transpose-chars>   transpose character under cursor with previous

Chapter 10. Miscellany

   Table of Contents

   1. Acknowledgements
   2. About This Document

1. Acknowledgements

   Kari Hurtta <kari.hurtta@fmi.fi> co-developed the original MIME parsing
   code back in the ELM-ME days.

   The following people have been very helpful to the development of Mutt:
     * Vikas Agnihotri <vikasa@writeme.com>
     * Francois Berjon <Francois.Berjon@aar.alcatel-alsthom.fr>
     * Aric Blumer <aric@fore.com>
     * John Capo <jc@irbs.com>
     * David Champion <dgc@uchicago.edu>
     * Brendan Cully <brendan@kublai.com>
     * Liviu Daia <daia@stoilow.imar.ro>
     * Thomas E. Dickey <dickey@herndon4.his.com>
     * David DeSimone <fox@convex.hp.com>
     * Nickolay N. Dudorov <nnd@wint.itfs.nsk.su>
     * Ruslan Ermilov <ru@freebsd.org>
     * Edmund Grimley Evans <edmundo@rano.org>
     * Michael Finken <finken@conware.de>
     * Sven Guckes <guckes@math.fu-berlin.de>
     * Lars Hecking <lhecking@nmrc.ie>
     * Mark Holloman <holloman@nando.net>
     * Andreas Holzmann <holzmann@fmi.uni-passau.de>
     * Marco d'Itri <md@linux.it>
     * Bjoern Jacke <bjacke@suse.com>
     * Byrial Jensen <byrial@image.dk>
     * David Jeske <jeske@igcom.net>
     * Christophe Kalt <kalt@hugo.int-evry.fr>
     * Tommi Komulainen <Tommi.Komulainen@iki.fi>
     * Felix von Leitner (a.k.a "Fefe") <leitner@math.fu-berlin.de>
     * Brandon Long <blong@fiction.net>
     * Jimmy Maekelae <jmy@flashback.net>
     * Lars Marowsky-Bree <lmb@pointer.in-minden.de>
     * Thomas "Mike" Michlmayr <mike@cosy.sbg.ac.at>
     * Andrew W. Nosenko <awn@bcs.zp.ua>
     * David O'Brien <obrien@Nuxi.cs.ucdavis.edu>
     * Clint Olsen <olsenc@ichips.intel.com>
     * Park Myeong Seok <pms@romance.kaist.ac.kr>
     * Thomas Parmelan <tom@ankh.fr.eu.org>
     * Ollivier Robert <roberto@keltia.freenix.fr>
     * Thomas Roessler <roessler@does-not-exist.org>
     * Roland Rosenfeld <roland@spinnaker.de>
     * Rocco Rutte <pdmef@gmx.net>
     * TAKIZAWA Takashi <taki@luna.email.ne.jp>
     * Allain Thivillon <Allain.Thivillon@alma.fr>
     * Gero Treuner <gero@70t.de>
     * Vsevolod Volkov <vvv@lucky.net>
     * Ken Weinert <kenw@ihs.com>

2. About This Document

   This document was written in DocBook, and then rendered using the Gnome
   XSLT toolkit.
