1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Mutt E-Mail Client</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="description" content="All mail clients suck. This one just sucks less. -me, circa 1995" /><style xmlns="" type="text/css">
3 body { margin-left:2%; margin-right:2%; font-family:serif; }
4 .toc, .list-of-tables, .list-of-examples { font-family:sans-serif; }
5 h1, h2, h3, h4, h5, h6 { font-family:sans-serif; }
6 em.replaceable code { font-family:sans-serif; }
7 p { text-align:justify; }
8 div.table p.title, div.example p.title { font-size:smaller; font-family:sans-serif; }
9 .email, .email a { font-family:monospace; }
10 div.table-contents table { border-collapse:collapse; border:1px solid #c0c0c0; }
11 div.table-contents table td, div.table-contents table th { padding:5px; text-align:left; }
12 div.table-contents table th {
13 font-family:sans-serif;
18 pre.screen, div.note { background:#f0f0f0; border:1px solid #c0c0c0; padding:5px; }
19 div.note h3 { font-size:small; font-style:italic; font-variant: small-caps; }
20 div.note h3:after { content: ":" }
21 div.note { margin-bottom: 5px; }
23 </style></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2857057"></a>The Mutt E-Mail Client</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Michael</span> <span class="surname">Elkins</span></h3><code class="email"><<a class="email" href="mailto:me@cs.hmc.edu">me@cs.hmc.edu</a>></code></div></div><div><p class="releaseinfo">version 1.5.19 (2009-01-05)</p></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p>
24 “<span class="quote">All mail clients suck. This one just sucks less.</span>” -me, circa 1995
25 </p></div></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#homepage">1. Mutt Home Page</a></span></dt><dt><span class="sect1"><a href="#muttlists">2. Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#distribution">3. Software Distribution Sites</a></span></dt><dt><span class="sect1"><a href="#irc">4. Mutt online resources</a></span></dt><dt><span class="sect1"><a href="#contrib">5. Contributing to Mutt</a></span></dt><dt><span class="sect1"><a href="#typo">6. Typograhical conventions</a></span></dt><dt><span class="sect1"><a href="#copyright">7. Copyright</a></span></dt></dl></dd><dt><span class="chapter"><a href="#gettingstarted">2. Getting Started</a></span></dt><dd><dl><dt><span class="sect1"><a href="#core-concepts">1. Core concepts</a></span></dt><dt><span class="sect1"><a href="#menus">2. Moving Around in Menus</a></span></dt><dt><span class="sect1"><a href="#editing">3. Editing Input Fields</a></span></dt><dd><dl><dt><span class="sect2"><a href="#editing-intro">3.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#editing-history">3.2. History</a></span></dt></dl></dd><dt><span class="sect1"><a href="#reading">4. Reading Mail - The Index and Pager</a></span></dt><dd><dl><dt><span class="sect2"><a href="#index-menu">4.1. The Message Index</a></span></dt><dt><span class="sect2"><a href="#pager-menu">4.2. The Pager</a></span></dt><dt><span class="sect2"><a href="#threads">4.3. Threaded Mode</a></span></dt><dt><span class="sect2"><a href="#reading-misc">4.4. Miscellaneous Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sending">5. Sending Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#sending-intro">5.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#edit-header">5.2. Editing the message header</a></span></dt><dt><span class="sect2"><a href="#sending-crypto">5.3. Sending cryptographically signed/encrypted messages</a></span></dt><dt><span class="sect2"><a href="#sending-mixmaster">5.4. Sending anonymous messages via mixmaster</a></span></dt><dt><span class="sect2"><a href="#ff">5.5. Sending format=flowed messages</a></span></dt></dl></dd><dt><span class="sect1"><a href="#forwarding-mail">6. Forwarding and Bouncing Mail</a></span></dt><dt><span class="sect1"><a href="#postponing-mail">7. Postponing Mail</a></span></dt></dl></dd><dt><span class="chapter"><a href="#configuration">3. Configuration</a></span></dt><dd><dl><dt><span class="sect1"><a href="#configuration-files">1. Location of initialization files</a></span></dt><dt><span class="sect1"><a href="#muttrc-syntax">2. Syntax of Initialization Files</a></span></dt><dt><span class="sect1"><a href="#addrgroup">3. Address groups</a></span></dt><dt><span class="sect1"><a href="#alias">4. Defining/Using aliases</a></span></dt><dt><span class="sect1"><a href="#bind">5. Changing the default key bindings</a></span></dt><dt><span class="sect1"><a href="#charset-hook">6. Defining aliases for character sets </a></span></dt><dt><span class="sect1"><a href="#folder-hook">7. Setting variables based upon mailbox</a></span></dt><dt><span class="sect1"><a href="#macro">8. Keyboard macros</a></span></dt><dt><span class="sect1"><a href="#color">9. Using color and mono video attributes</a></span></dt><dt><span class="sect1"><a href="#ignore">10. Message header display</a></span></dt><dt><span class="sect1"><a href="#alternates">11. Alternative addresses</a></span></dt><dt><span class="sect1"><a href="#lists">12. Mailing lists</a></span></dt><dt><span class="sect1"><a href="#mbox-hook">13. Using Multiple spool mailboxes</a></span></dt><dt><span class="sect1"><a href="#mailboxes">14. Monitoring incoming mail</a></span></dt><dt><span class="sect1"><a href="#my-hdr">15. User defined headers</a></span></dt><dt><span class="sect1"><a href="#save-hook">16. Specify default save mailbox</a></span></dt><dt><span class="sect1"><a href="#fcc-hook">17. Specify default Fcc: mailbox when composing</a></span></dt><dt><span class="sect1"><a href="#fcc-save-hook">18. Specify default save filename and default Fcc: mailbox at once</a></span></dt><dt><span class="sect1"><a href="#send-hook">19. Change settings based upon message recipients</a></span></dt><dt><span class="sect1"><a href="#message-hook">20. Change settings before formatting a message</a></span></dt><dt><span class="sect1"><a href="#crypt-hook">21. Choosing the cryptographic key of the recipient</a></span></dt><dt><span class="sect1"><a href="#push">22. Adding key sequences to the keyboard buffer</a></span></dt><dt><span class="sect1"><a href="#exec">23. Executing functions</a></span></dt><dt><span class="sect1"><a href="#score-command">24. Message Scoring</a></span></dt><dt><span class="sect1"><a href="#spam">25. Spam detection</a></span></dt><dt><span class="sect1"><a href="#set">26. Setting and Querying Variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#set-commands">26.1. Commands</a></span></dt><dt><span class="sect2"><a href="#set-myvar">26.2. User-defined variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="#source">27. Reading initialization commands from another file</a></span></dt><dt><span class="sect1"><a href="#unhook">28. Removing hooks</a></span></dt><dt><span class="sect1"><a href="#formatstrings">29. Format Strings</a></span></dt><dd><dl><dt><span class="sect2"><a href="#formatstrings-basics">29.1. Basic usage</a></span></dt><dt><span class="sect2"><a href="#formatstrings-filters">29.2. Filters</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#advancedusage">4. Advanced Usage</a></span></dt><dd><dl><dt><span class="sect1"><a href="#regexp">1. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">2. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#patterns-modifier">2.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#simple-patterns">2.2. Simple Patterns</a></span></dt><dt><span class="sect2"><a href="#complex-patterns">2.3. Complex Patterns</a></span></dt><dt><span class="sect2"><a href="#date-patterns">2.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">3. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">4. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">4.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">5. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">6. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">7. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">8. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#handling-folders">9. Handling multiple folders</a></span></dt><dt><span class="sect1"><a href="#editing-threads">10. Editing threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#link-threads">10.1. Linking threads</a></span></dt><dt><span class="sect2"><a href="#break-threads">10.2. Breaking threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">11. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">12. Start a WWW Browser on URLs</a></span></dt></dl></dd><dt><span class="chapter"><a href="#mimesupport">5. Mutt's MIME Support</a></span></dt><dd><dl><dt><span class="sect1"><a href="#using-mime">1. Using MIME in Mutt</a></span></dt><dd><dl><dt><span class="sect2"><a href="#mime-pager">1.1. Viewing MIME messages in the pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.2. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.3. The Compose Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#mime-types">2. MIME Type configuration with <code class="literal">mime.types</code></a></span></dt><dt><span class="sect1"><a href="#mailcap">3. MIME Viewer configuration with <code class="literal">mailcap</code></a></span></dt><dd><dl><dt><span class="sect2"><a href="#mailcap-basics">3.1. The Basics of the mailcap file</a></span></dt><dt><span class="sect2"><a href="#secure-mailcap">3.2. Secure use of mailcap</a></span></dt><dt><span class="sect2"><a href="#advanced-mailcap">3.3. Advanced mailcap Usage</a></span></dt><dt><span class="sect2"><a href="#mailcap-example">3.4. Example mailcap files</a></span></dt></dl></dd><dt><span class="sect1"><a href="#auto-view">4. MIME Autoview</a></span></dt><dt><span class="sect1"><a href="#alternative-order">5. MIME Multipart/Alternative</a></span></dt><dt><span class="sect1"><a href="#attachments">6. Attachment Searching and Counting</a></span></dt><dt><span class="sect1"><a href="#mime-lookup">7. MIME Lookup</a></span></dt></dl></dd><dt><span class="chapter"><a href="#optionalfeatures">6. Optional features</a></span></dt><dd><dl><dt><span class="sect1"><a href="#optionalfeatures-notes">1. General notes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#compile-time-features">1.1. Enabling/disabling features</a></span></dt><dt><span class="sect2"><a href="#url-syntax">1.2. URL syntax</a></span></dt></dl></dd><dt><span class="sect1"><a href="#ssl">2. SSL/TLS Support</a></span></dt><dt><span class="sect1"><a href="#pop">3. POP3 Support</a></span></dt><dt><span class="sect1"><a href="#imap">4. IMAP Support</a></span></dt><dd><dl><dt><span class="sect2"><a href="#imap-browser">4.1. The Folder Browser</a></span></dt><dt><span class="sect2"><a href="#imap-authentication">4.2. Authentication</a></span></dt></dl></dd><dt><span class="sect1"><a href="#smtp">5. SMTP Support</a></span></dt><dt><span class="sect1"><a href="#account-hook">6. Managing multiple accounts</a></span></dt><dt><span class="sect1"><a href="#caching">7. Local caching</a></span></dt><dd><dl><dt><span class="sect2"><a href="#header-caching">7.1. Header caching</a></span></dt><dt><span class="sect2"><a href="#body-caching">7.2. Body caching</a></span></dt><dt><span class="sect2"><a href="#maint-cache">7.3. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact address generation</a></span></dt></dl></dd><dt><span class="chapter"><a href="#tuning">7. Performance tuning</a></span></dt><dd><dl><dt><span class="sect1"><a href="#tuning-mailboxes">1. Reading and writing mailboxes</a></span></dt><dt><span class="sect1"><a href="#tuning-messages">2. Reading messages from remote folders</a></span></dt><dt><span class="sect1"><a href="#tuning-search">3. Searching and limiting</a></span></dt></dl></dd><dt><span class="chapter"><a href="#reference">8. Reference</a></span></dt><dd><dl><dt><span class="sect1"><a href="#commandline">1. Command line options</a></span></dt><dt><span class="sect1"><a href="#commands">2. Configuration Commands</a></span></dt><dt><span class="sect1"><a href="#variables">3. Configuration variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#abort-nosubject">3.1. abort_nosubject</a></span></dt><dt><span class="sect2"><a href="#abort-unmodified">3.2. abort_unmodified</a></span></dt><dt><span class="sect2"><a href="#alias-file">3.3. alias_file</a></span></dt><dt><span class="sect2"><a href="#alias-format">3.4. alias_format</a></span></dt><dt><span class="sect2"><a href="#allow-8bit">3.5. allow_8bit</a></span></dt><dt><span class="sect2"><a href="#allow-ansi">3.6. allow_ansi</a></span></dt><dt><span class="sect2"><a href="#arrow-cursor">3.7. arrow_cursor</a></span></dt><dt><span class="sect2"><a href="#ascii-chars">3.8. ascii_chars</a></span></dt><dt><span class="sect2"><a href="#askbcc">3.9. askbcc</a></span></dt><dt><span class="sect2"><a href="#askcc">3.10. askcc</a></span></dt><dt><span class="sect2"><a href="#assumed-charset">3.11. assumed_charset</a></span></dt><dt><span class="sect2"><a href="#attach-charset">3.12. attach_charset</a></span></dt><dt><span class="sect2"><a href="#attach-format">3.13. attach_format</a></span></dt><dt><span class="sect2"><a href="#attach-sep">3.14. attach_sep</a></span></dt><dt><span class="sect2"><a href="#attach-split">3.15. attach_split</a></span></dt><dt><span class="sect2"><a href="#attribution">3.16. attribution</a></span></dt><dt><span class="sect2"><a href="#autoedit">3.17. autoedit</a></span></dt><dt><span class="sect2"><a href="#auto-tag">3.18. auto_tag</a></span></dt><dt><span class="sect2"><a href="#beep">3.19. beep</a></span></dt><dt><span class="sect2"><a href="#beep-new">3.20. beep_new</a></span></dt><dt><span class="sect2"><a href="#bounce">3.21. bounce</a></span></dt><dt><span class="sect2"><a href="#bounce-delivered">3.22. bounce_delivered</a></span></dt><dt><span class="sect2"><a href="#braille-friendly">3.23. braille_friendly</a></span></dt><dt><span class="sect2"><a href="#check-mbox-size">3.24. check_mbox_size</a></span></dt><dt><span class="sect2"><a href="#charset">3.25. charset</a></span></dt><dt><span class="sect2"><a href="#check-new">3.26. check_new</a></span></dt><dt><span class="sect2"><a href="#collapse-unread">3.27. collapse_unread</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.28. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#compose-format">3.29. compose_format</a></span></dt><dt><span class="sect2"><a href="#config-charset">3.30. config_charset</a></span></dt><dt><span class="sect2"><a href="#confirmappend">3.31. confirmappend</a></span></dt><dt><span class="sect2"><a href="#confirmcreate">3.32. confirmcreate</a></span></dt><dt><span class="sect2"><a href="#connect-timeout">3.33. connect_timeout</a></span></dt><dt><span class="sect2"><a href="#content-type">3.34. content_type</a></span></dt><dt><span class="sect2"><a href="#copy">3.35. copy</a></span></dt><dt><span class="sect2"><a href="#crypt-use-gpgme">3.36. crypt_use_gpgme</a></span></dt><dt><span class="sect2"><a href="#crypt-use-pka">3.37. crypt_use_pka</a></span></dt><dt><span class="sect2"><a href="#crypt-autopgp">3.38. crypt_autopgp</a></span></dt><dt><span class="sect2"><a href="#crypt-autosmime">3.39. crypt_autosmime</a></span></dt><dt><span class="sect2"><a href="#date-format">3.40. date_format</a></span></dt><dt><span class="sect2"><a href="#default-hook">3.41. default_hook</a></span></dt><dt><span class="sect2"><a href="#delete">3.42. delete</a></span></dt><dt><span class="sect2"><a href="#delete-untag">3.43. delete_untag</a></span></dt><dt><span class="sect2"><a href="#digest-collapse">3.44. digest_collapse</a></span></dt><dt><span class="sect2"><a href="#display-filter">3.45. display_filter</a></span></dt><dt><span class="sect2"><a href="#dotlock-program">3.46. dotlock_program</a></span></dt><dt><span class="sect2"><a href="#dsn-notify">3.47. dsn_notify</a></span></dt><dt><span class="sect2"><a href="#dsn-return">3.48. dsn_return</a></span></dt><dt><span class="sect2"><a href="#duplicate-threads">3.49. duplicate_threads</a></span></dt><dt><span class="sect2"><a href="#edit-headers">3.50. edit_headers</a></span></dt><dt><span class="sect2"><a href="#editor">3.51. editor</a></span></dt><dt><span class="sect2"><a href="#encode-from">3.52. encode_from</a></span></dt><dt><span class="sect2"><a href="#envelope-from-address">3.53. envelope_from_address</a></span></dt><dt><span class="sect2"><a href="#escape">3.54. escape</a></span></dt><dt><span class="sect2"><a href="#fast-reply">3.55. fast_reply</a></span></dt><dt><span class="sect2"><a href="#fcc-attach">3.56. fcc_attach</a></span></dt><dt><span class="sect2"><a href="#fcc-clear">3.57. fcc_clear</a></span></dt><dt><span class="sect2"><a href="#folder">3.58. folder</a></span></dt><dt><span class="sect2"><a href="#folder-format">3.59. folder_format</a></span></dt><dt><span class="sect2"><a href="#followup-to">3.60. followup_to</a></span></dt><dt><span class="sect2"><a href="#force-name">3.61. force_name</a></span></dt><dt><span class="sect2"><a href="#forward-decode">3.62. forward_decode</a></span></dt><dt><span class="sect2"><a href="#forward-edit">3.63. forward_edit</a></span></dt><dt><span class="sect2"><a href="#forward-format">3.64. forward_format</a></span></dt><dt><span class="sect2"><a href="#forward-quote">3.65. forward_quote</a></span></dt><dt><span class="sect2"><a href="#from">3.66. from</a></span></dt><dt><span class="sect2"><a href="#gecos-mask">3.67. gecos_mask</a></span></dt><dt><span class="sect2"><a href="#hdrs">3.68. hdrs</a></span></dt><dt><span class="sect2"><a href="#header">3.69. header</a></span></dt><dt><span class="sect2"><a href="#help">3.70. help</a></span></dt><dt><span class="sect2"><a href="#hidden-host">3.71. hidden_host</a></span></dt><dt><span class="sect2"><a href="#hide-limited">3.72. hide_limited</a></span></dt><dt><span class="sect2"><a href="#hide-missing">3.73. hide_missing</a></span></dt><dt><span class="sect2"><a href="#hide-thread-subject">3.74. hide_thread_subject</a></span></dt><dt><span class="sect2"><a href="#hide-top-limited">3.75. hide_top_limited</a></span></dt><dt><span class="sect2"><a href="#hide-top-missing">3.76. hide_top_missing</a></span></dt><dt><span class="sect2"><a href="#history">3.77. history</a></span></dt><dt><span class="sect2"><a href="#history-file">3.78. history_file</a></span></dt><dt><span class="sect2"><a href="#honor-followup-to">3.79. honor_followup_to</a></span></dt><dt><span class="sect2"><a href="#hostname">3.80. hostname</a></span></dt><dt><span class="sect2"><a href="#ignore-linear-white-space">3.81. ignore_linear_white_space</a></span></dt><dt><span class="sect2"><a href="#ignore-list-reply-to">3.82. ignore_list_reply_to</a></span></dt><dt><span class="sect2"><a href="#imap-authenticators">3.83. imap_authenticators</a></span></dt><dt><span class="sect2"><a href="#imap-check-subscribed">3.84. imap_check_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-delim-chars">3.85. imap_delim_chars</a></span></dt><dt><span class="sect2"><a href="#imap-headers">3.86. imap_headers</a></span></dt><dt><span class="sect2"><a href="#imap-idle">3.87. imap_idle</a></span></dt><dt><span class="sect2"><a href="#imap-keepalive">3.88. imap_keepalive</a></span></dt><dt><span class="sect2"><a href="#imap-list-subscribed">3.89. imap_list_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-login">3.90. imap_login</a></span></dt><dt><span class="sect2"><a href="#imap-pass">3.91. imap_pass</a></span></dt><dt><span class="sect2"><a href="#imap-passive">3.92. imap_passive</a></span></dt><dt><span class="sect2"><a href="#imap-peek">3.93. imap_peek</a></span></dt><dt><span class="sect2"><a href="#imap-pipeline-depth">3.94. imap_pipeline_depth</a></span></dt><dt><span class="sect2"><a href="#imap-servernoise">3.95. imap_servernoise</a></span></dt><dt><span class="sect2"><a href="#imap-user">3.96. imap_user</a></span></dt><dt><span class="sect2"><a href="#implicit-autoview">3.97. implicit_autoview</a></span></dt><dt><span class="sect2"><a href="#include">3.98. include</a></span></dt><dt><span class="sect2"><a href="#include-onlyfirst">3.99. include_onlyfirst</a></span></dt><dt><span class="sect2"><a href="#indent-string">3.100. indent_string</a></span></dt><dt><span class="sect2"><a href="#index-format">3.101. index_format</a></span></dt><dt><span class="sect2"><a href="#ispell">3.102. ispell</a></span></dt><dt><span class="sect2"><a href="#keep-flagged">3.103. keep_flagged</a></span></dt><dt><span class="sect2"><a href="#locale">3.104. locale</a></span></dt><dt><span class="sect2"><a href="#mail-check">3.105. mail_check</a></span></dt><dt><span class="sect2"><a href="#mailcap-path">3.106. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.107. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#header-cache">3.108. header_cache</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.109. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#header-cache-pagesize">3.110. header_cache_pagesize</a></span></dt><dt><span class="sect2"><a href="#header-cache-compress">3.111. header_cache_compress</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.112. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.113. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.114. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.115. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.116. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.117. mbox_type</a></span></dt><dt><span class="sect2"><a href="#metoo">3.118. metoo</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.119. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.120. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.121. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.122. meta_key</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.123. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.124. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.125. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.126. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.127. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.128. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.129. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.130. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.131. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.132. move</a></span></dt><dt><span class="sect2"><a href="#message-cachedir">3.133. message_cachedir</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.134. message_cache_clean</a></span></dt><dt><span class="sect2"><a href="#message-format">3.135. message_format</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.136. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.137. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.138. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.139. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.140. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.141. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.142. pager_stop</a></span></dt><dt><span class="sect2"><a href="#crypt-autosign">3.143. crypt_autosign</a></span></dt><dt><span class="sect2"><a href="#crypt-autoencrypt">3.144. crypt_autoencrypt</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.145. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#crypt-replyencrypt">3.146. crypt_replyencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-replysign">3.147. crypt_replysign</a></span></dt><dt><span class="sect2"><a href="#crypt-replysignencrypted">3.148. crypt_replysignencrypted</a></span></dt><dt><span class="sect2"><a href="#crypt-timestamp">3.149. crypt_timestamp</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.150. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#crypt-verify-sig">3.151. crypt_verify_sig</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.152. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.153. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.154. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.155. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.156. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.157. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.158. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.159. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.160. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.161. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.162. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.163. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.164. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.165. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.166. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.167. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.168. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.169. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.170. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.171. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.172. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.173. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.174. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.175. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.176. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.177. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.178. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.179. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.180. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.181. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#forward-decrypt">3.182. forward_decrypt</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.183. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.184. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.185. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.186. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.187. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.188. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.189. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.190. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.191. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.192. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.193. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.194. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.195. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.196. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.197. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.198. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.199. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.200. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.201. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.202. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#certificate-file">3.203. certificate_file</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.204. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#entropy-file">3.205. entropy_file</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.206. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.207. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.208. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.209. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.210. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.211. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.212. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.213. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.214. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.215. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.216. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.217. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.218. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.219. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.220. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.221. pop_user</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.222. pop_pass</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.223. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.224. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.225. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.226. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.227. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.228. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.229. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.230. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.231. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.232. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.233. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.234. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.235. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.236. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.237. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.238. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.239. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.240. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.241. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.242. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.243. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.244. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.245. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.246. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.247. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.248. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.249. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.250. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.251. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.252. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.253. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.254. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.255. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.256. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.257. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.258. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.259. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.260. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.261. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.262. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.263. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.264. simple_search</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.265. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.266. smileys</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.267. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.268. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.269. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.270. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.271. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.272. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.273. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.274. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.275. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.276. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.277. spoolfile</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.278. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.279. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.280. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.281. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.282. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.283. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.284. thread_received</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.285. thorough_search</a></span></dt><dt><span class="sect2"><a href="#tilde">3.286. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.287. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.288. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.289. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.290. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.291. tunnel</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.292. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.293. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.294. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.295. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.296. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.297. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.298. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.299. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.300. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.301. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.302. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.303. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.304. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.305. write_inc</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.306. write_bcc</a></span></dt></dl></dd><dt><span class="sect1"><a href="#functions">4. Functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="#generic_map">4.1. generic menu</a></span></dt><dt><span class="sect2"><a href="#index_map">4.2. index menu</a></span></dt><dt><span class="sect2"><a href="#pager_map">4.3. pager menu</a></span></dt><dt><span class="sect2"><a href="#alias_map">4.4. alias menu</a></span></dt><dt><span class="sect2"><a href="#query_map">4.5. query menu</a></span></dt><dt><span class="sect2"><a href="#attach_map">4.6. attach menu</a></span></dt><dt><span class="sect2"><a href="#compose_map">4.7. compose menu</a></span></dt><dt><span class="sect2"><a href="#postpone_map">4.8. postpone menu</a></span></dt><dt><span class="sect2"><a href="#browser_map">4.9. browser menu</a></span></dt><dt><span class="sect2"><a href="#pgp_map">4.10. pgp menu</a></span></dt><dt><span class="sect2"><a href="#smime_map">4.11. smime menu</a></span></dt><dt><span class="sect2"><a href="#mix_map">4.12. mix menu</a></span></dt><dt><span class="sect2"><a href="#editor_map">4.13. editor menu</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#miscellany">9. Miscellany</a></span></dt><dd><dl><dt><span class="sect1"><a href="#acknowledgements">1. Acknowledgements</a></span></dt><dt><span class="sect1"><a href="#about">2. About this document</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>1.1. <a href="#tab-typo">Typographical conventions for special terms</a></dt><dt>2.1. <a href="#tab-keys-nav">Most common navigation keys</a></dt><dt>2.2. <a href="#tab-keys-editor">Most common line editor keys</a></dt><dt>2.3. <a href="#tab-key-index">Most common message index keys</a></dt><dt>2.4. <a href="#tab-msg-status-flags">Message status flags</a></dt><dt>2.5. <a href="#tab-msg-recip-flags">Message recipient flags</a></dt><dt>2.6. <a href="#tab-key-pager">Most common pager keys</a></dt><dt>2.7. <a href="#tab-ansi-esc">ANSI escape sequences</a></dt><dt>2.8. <a href="#tab-color">Color sequences</a></dt><dt>2.9. <a href="#tab-key-threads">Most common thread mode keys</a></dt><dt>2.10. <a href="#tab-key-send">Most common mail sending keys</a></dt><dt>2.11. <a href="#tab-func-compose">Most common compose menu keys</a></dt><dt>2.12. <a href="#tab-pgp-menuflags">PGP key menu flags</a></dt><dt>3.1. <a href="#tab-key-names">Symbolic key names</a></dt><dt>4.1. <a href="#posix-regex-char-classes">POSIX regular expression character classes</a></dt><dt>4.2. <a href="#regex-repeat">Regular expression repetition operators</a></dt><dt>4.3. <a href="#regex-gnu-ext">GNU regular expression extensions</a></dt><dt>4.4. <a href="#tab-patterns">Pattern modifiers</a></dt><dt>4.5. <a href="#tab-simplesearch-keywords">Simple search keywords</a></dt><dt>4.6. <a href="#tab-date-units">Date units</a></dt><dt>8.1. <a href="#tab-commandline-options">Command line options</a></dt><dt>8.2. <a href="#generic_table">Default generic function bindings</a></dt><dt>8.3. <a href="#index_table">Default index function bindings</a></dt><dt>8.4. <a href="#pager_table">Default pager function bindings</a></dt><dt>8.5. <a href="#alias_table">Default alias function bindings</a></dt><dt>8.6. <a href="#query_table">Default query function bindings</a></dt><dt>8.7. <a href="#attach_table">Default attach function bindings</a></dt><dt>8.8. <a href="#compose_table">Default compose function bindings</a></dt><dt>8.9. <a href="#postpone_table">Default postpone function bindings</a></dt><dt>8.10. <a href="#browser_table">Default browser function bindings</a></dt><dt>8.11. <a href="#pgp_table">Default pgp function bindings</a></dt><dt>8.12. <a href="#smime_table">Default smime function bindings</a></dt><dt>8.13. <a href="#mix_table">Default mix function bindings</a></dt><dt>8.14. <a href="#editor_table">Default editor function bindings</a></dt></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>3.1. <a href="#ex-rc-multiple-cmds">Multiple configuration commands per line</a></dt><dt>3.2. <a href="#ex-ec-comment">Commenting configuration files</a></dt><dt>3.3. <a href="#ex-rc-quote">Escaping quotes in congfiguration files</a></dt><dt>3.4. <a href="#ex-rc-backtick">Using external command's output in configuration files</a></dt><dt>3.5. <a href="#ex-rc-env">Using environment variables in configuration files</a></dt><dt>3.6. <a href="#ex-alias-external">Configuring external alias files</a></dt><dt>3.7. <a href="#ex-folder-sorting">Setting sort method based on mailbox name</a></dt><dt>3.8. <a href="#ex-header-weeding">Header weeding</a></dt><dt>3.9. <a href="#ex-hdr-order">Configuring header display order</a></dt><dt>3.10. <a href="#ex-my-hdr">Defining custom headers</a></dt><dt>3.11. <a href="#ex-save-hook-exando">Using %-expandos in <code class="literal">save-hook</code></a></dt><dt>3.12. <a href="#ex-folder-hook-push">Embedding <code class="literal">push</code> in <code class="literal">folder-hook</code></a></dt><dt>3.13. <a href="#ex-spam">Configuring spam detection</a></dt><dt>3.14. <a href="#ex-myvar1">Using user-defined variables for config file readability</a></dt><dt>3.15. <a href="#ex-myvar2">Using user-defined variables for backing up other config option values</a></dt><dt>3.16. <a href="#ex-myvar3">Deferring user-defined variable expansion to runtime</a></dt><dt>3.17. <a href="#ex-fmtpipe">Using external filters in format strings</a></dt><dt>4.1. <a href="#ex-pattern-bool">Using boolean operators in patterns</a></dt><dt>4.2. <a href="#ex-send-hook-my-hdr">Combining <code class="literal">send-hook</code> and <code class="literal">my_hdr</code></a></dt><dt>5.1. <a href="#ex-attach-count">Attachment counting</a></dt></dl></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#homepage">1. Mutt Home Page</a></span></dt><dt><span class="sect1"><a href="#muttlists">2. Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#distribution">3. Software Distribution Sites</a></span></dt><dt><span class="sect1"><a href="#irc">4. Mutt online resources</a></span></dt><dt><span class="sect1"><a href="#contrib">5. Contributing to Mutt</a></span></dt><dt><span class="sect1"><a href="#typo">6. Typograhical conventions</a></span></dt><dt><span class="sect1"><a href="#copyright">7. Copyright</a></span></dt></dl></div><p>
26 <span class="bold"><strong>Mutt</strong></span> is a small but very powerful text-based MIME mail client. Mutt is
27 highly configurable, and is well suited to the mail power user with advanced
28 features like key bindings, keyboard macros, mail threading, regular
29 expression searches and a powerful pattern matching language for selecting
31 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="homepage"></a>1. Mutt Home Page</h2></div></div></div><p>
32 The official homepage can be found at
33 <a class="ulink" href="http://www.mutt.org/" target="_top">http://www.mutt.org/</a>.
34 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttlists"></a>2. Mailing Lists</h2></div></div></div><p>
35 To subscribe to one of the following mailing lists, send a message with the
36 word <span class="emphasis"><em>subscribe</em></span> in the body to
37 <code class="literal">list-name</code><span class="emphasis"><em>-request</em></span><code class="literal">@mutt.org</code>.
38 </p><div class="itemizedlist"><ul type="disc"><li><p>
39 <code class="email"><<a class="email" href="mailto:mutt-announce-request@mutt.org">mutt-announce-request@mutt.org</a>></code> -- low traffic list for announcements
41 <code class="email"><<a class="email" href="mailto:mutt-users-request@mutt.org">mutt-users-request@mutt.org</a>></code> -- help, bug reports and feature requests
43 <code class="email"><<a class="email" href="mailto:mutt-dev-request@mutt.org">mutt-dev-request@mutt.org</a>></code> -- development mailing list
44 </p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>
45 All messages posted to
46 <span class="emphasis"><em>mutt-announce</em></span> are automatically forwarded to
47 <span class="emphasis"><em>mutt-users</em></span>, so you do not need to be subscribed to
49 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="distribution"></a>3. Software Distribution Sites</h2></div></div></div><p>
50 Mutt releases can be downloaded from
51 <a class="ulink" href="ftp://ftp.mutt.org/mutt/" target="_top">ftp://ftp.mutt.org/mutt/</a>.
52 For a list of mirror sites, please refer to
53 <a class="ulink" href="http://www.mutt.org/download.html" target="_top">http://www.mutt.org/download.html</a>.
54 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="irc"></a>4. Mutt online resources</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">Bug Tracking System</span></dt><dd><p>
55 The official mutt bug tracking system can be found at
56 <a class="ulink" href="http://dev.mutt.org/" target="_top">http://dev.mutt.org/</a>
57 </p></dd><dt><span class="term">Wiki</span></dt><dd><p>
58 An (unofficial) wiki can be found
59 at <a class="ulink" href="http://wiki.mutt.org/" target="_top">http://wiki.mutt.org/</a>.
60 </p></dd><dt><span class="term">IRC</span></dt><dd><p>
61 For the IRC user community, visit channel <span class="emphasis"><em>#mutt</em></span> on
62 <a class="ulink" href="http://www.freenode.net/" target="_top">irc.freenode.net</a>.
63 </p></dd><dt><span class="term">USENET</span></dt><dd><p>
64 For USENET, see the newsgroup <a class="ulink" href="news:comp.mail.mutt" target="_top">comp.mail.mutt</a>.
65 </p></dd></dl></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="contrib"></a>5. Contributing to Mutt</h2></div></div></div><p>
66 There are various ways to contribute to the Mutt project.
68 Especially for new users it may be helpful to meet other new and
69 experienced users to chat about Mutt, talk about problems and share
72 Since translations of Mutt into other languages are highly appreciated,
73 the mutt developers always look for skilled translators that help
74 improve and continue to maintain stale translations.
76 For contributing code patches for new features and bug fixes, please
77 refer to the developer pages at
78 <a class="ulink" href="http://dev.mutt.org/" target="_top">http://dev.mutt.org/</a> for more details.
79 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="typo"></a>6. Typograhical conventions</h2></div></div></div><p>
80 This section lists typographical conventions followed throughout this
81 manual. See table <a class="xref" href="#tab-typo" title="Table 1.1. Typographical conventions for special terms">Table 1.1, “Typographical conventions for special terms”</a> for typographical
82 conventions for special terms.
83 </p><div class="table"><a id="tab-typo"></a><p class="title"><b>Table 1.1. Typographical conventions for special terms</b></p><div class="table-contents"><table summary="Typographical conventions for special terms" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Item</th><th>Refers to...</th></tr></thead><tbody><tr><td><code class="literal">printf(3)</code></td><td>UNIX manual pages, execute <code class="literal">man 3 printf</code></td></tr><tr><td><code class="literal"><PageUp></code></td><td>named keys</td></tr><tr><td><code class="literal"><create-alias></code></td><td>named Mutt function</td></tr><tr><td><code class="literal">^G</code></td><td>Control+G key combination</td></tr><tr><td><code class="literal">$mail_check</code></td><td>Mutt configuration option</td></tr></tbody></table></div></div><br class="table-break" /><p>
84 Examples are presented as:
85 </p><pre class="screen">
88 Within command synopsis, curly brackets (“<span class="quote">{}</span>”) denote a set
89 of options of which one is mandatory, square brackets
90 (“<span class="quote">[]</span>”) denote optional arguments, three dots
91 denote that the argument may be repeated arbitrary times.
92 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="copyright"></a>7. Copyright</h2></div></div></div><p>
93 Mutt is Copyright (C) 1996-2009 Michael R. Elkins
94 <code class="email"><<a class="email" href="mailto:me@mutt.org">me@mutt.org</a>></code> and others.
96 This program is free software; you can redistribute it and/or modify
97 it under the terms of the GNU General Public License as published by
98 the Free Software Foundation; either version 2 of the License, or
99 (at your option) any later version.
101 This program is distributed in the hope that it will be useful,
102 but WITHOUT ANY WARRANTY; without even the implied warranty of
103 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
104 GNU General Public License for more details.
106 You should have received a copy of the GNU General Public License
107 along with this program; if not, write to the Free Software
108 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
109 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="gettingstarted"></a>Chapter 2. Getting Started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#core-concepts">1. Core concepts</a></span></dt><dt><span class="sect1"><a href="#menus">2. Moving Around in Menus</a></span></dt><dt><span class="sect1"><a href="#editing">3. Editing Input Fields</a></span></dt><dd><dl><dt><span class="sect2"><a href="#editing-intro">3.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#editing-history">3.2. History</a></span></dt></dl></dd><dt><span class="sect1"><a href="#reading">4. Reading Mail - The Index and Pager</a></span></dt><dd><dl><dt><span class="sect2"><a href="#index-menu">4.1. The Message Index</a></span></dt><dt><span class="sect2"><a href="#pager-menu">4.2. The Pager</a></span></dt><dt><span class="sect2"><a href="#threads">4.3. Threaded Mode</a></span></dt><dt><span class="sect2"><a href="#reading-misc">4.4. Miscellaneous Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sending">5. Sending Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#sending-intro">5.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#edit-header">5.2. Editing the message header</a></span></dt><dt><span class="sect2"><a href="#sending-crypto">5.3. Sending cryptographically signed/encrypted messages</a></span></dt><dt><span class="sect2"><a href="#sending-mixmaster">5.4. Sending anonymous messages via mixmaster</a></span></dt><dt><span class="sect2"><a href="#ff">5.5. Sending format=flowed messages</a></span></dt></dl></dd><dt><span class="sect1"><a href="#forwarding-mail">6. Forwarding and Bouncing Mail</a></span></dt><dt><span class="sect1"><a href="#postponing-mail">7. Postponing Mail</a></span></dt></dl></div><p>
110 This section is intended as a brief overview of how to use Mutt. There are
111 many other features which are described elsewhere in the manual. There
112 is even more information available in the Mutt FAQ and various web
113 pages. See the <a class="ulink" href="http://www.mutt.org/" target="_top">Mutt homepage</a> for more details.
115 The keybindings described in this section are the defaults as distributed.
116 Your local system administrator may have altered the defaults for your site.
117 You can always type “<span class="quote">?</span>” in any menu to display the current bindings.
119 The first thing you need to do is invoke mutt, simply by typing <code class="literal">mutt</code>
120 at the command line. There are various command-line options, see
121 either the mutt man page or the <a class="link" href="#commandline" title="1. Command line options">reference</a>.
122 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="core-concepts"></a>1. Core concepts</h2></div></div></div><p>
123 Mutt is a text-based application which interacts with users through
124 different menus which are mostly line-/entry-based or page-based. A
125 line-based menu is the so-called “<span class="quote">index</span>” menu (listing all messages of
126 the currently opened folder) or the “<span class="quote">alias</span>” menu (allowing you to
127 select recipients from a list). Examples for page-based menus are the
128 “<span class="quote">pager</span>” (showing one message at a time) or the “<span class="quote">help</span>” menu listing
129 all available key bindings.
131 The user interface consists of a context sensitive help line at the top,
132 the menu's contents followed by a context sensitive status line and
133 finally the command line. The command line is used to display
134 informational and error messages as well as for prompts and for entering
135 interactive commands.
137 Because Mutt allows for customizing almost all key bindings, there are
138 so-called “<span class="quote">functions</span>” which can be executed manually (using the
139 command line) or in macros. Macros allow the user to bind a sequence of
140 commands to a single key or a short key sequence instead of repeating a
141 sequence of actions over and over.
143 Many commands (such as saving or copying a message to another folder)
144 can be applied to a single message or a set of messages (so-called
145 “<span class="quote">tagged</span>” messages). To help selecting messages, Mutt provides a rich
146 set of message patterns (such as recipients, sender, body contents, date
147 sent/received, etc.) which can be combined into complex expressions
148 using the boolean <span class="emphasis"><em>and</em></span> and <span class="emphasis"><em>or</em></span>
149 operations as well as negating. These patterns can also be used to (for
150 example) search for messages or to limit the index to show only matching
153 Mutt supports a “<span class="quote">hook</span>” concept which allows the user to execute
154 arbitrary configuration commands and functions in certain situations
155 such as entering a folder, starting a new message or replying to an
156 existing one. These hooks can be used to highly customize Mutt's
157 behaviour including managing multiple identities, customizing the
158 display for a folder or even implementing auto-archiving based on a
159 per-folder basis and much more.
160 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="menus"></a>2. Moving Around in Menus</h2></div></div></div><p>
161 The most important navigation keys common to all menus are shown in
162 <a class="xref" href="#tab-keys-nav" title="Table 2.1. Most common navigation keys">Table 2.1, “Most common navigation keys”</a>.
163 </p><div class="table"><a id="tab-keys-nav"></a><p class="title"><b>Table 2.1. Most common navigation keys</b></p><div class="table-contents"><table summary="Most common navigation keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>j or <Down></td><td><code class="literal"><next-entry></code></td><td>move to the next entry</td></tr><tr><td>k or <Up></td><td><code class="literal"><previous-entry></code></td><td>move to the previous entry</td></tr><tr><td>z or <PageDn></td><td><code class="literal"><page-down></code></td><td>go to the next page</td></tr><tr><td>Z or <PageUp></td><td><code class="literal"><page-up></code></td><td>go to the previous page</td></tr><tr><td>= or <Home></td><td><code class="literal"><first-entry></code></td><td>jump to the first entry</td></tr><tr><td>* or <End></td><td><code class="literal"><last-entry></code></td><td>jump to the last entry</td></tr><tr><td>q</td><td><code class="literal"><quit></code></td><td>exit the current menu</td></tr><tr><td>?</td><td><code class="literal"><help></code></td><td>list all keybindings for the current menu</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing"></a>3. Editing Input Fields</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editing-intro"></a>3.1. Introduction</h3></div></div></div><p>
164 Mutt has a built-in line editor for inputting text, e.g. email
165 addresses or filenames. The keys used to manipulate text input are
166 very similar to those of Emacs. See <a class="xref" href="#tab-keys-editor" title="Table 2.2. Most common line editor keys">Table 2.2, “Most common line editor keys”</a> for a full
167 reference of available functions, their default key bindings, and
169 </p><div class="table"><a id="tab-keys-editor"></a><p class="title"><b>Table 2.2. Most common line editor keys</b></p><div class="table-contents"><table summary="Most common line editor keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>^A or <Home></td><td><code class="literal"><bol></code></td><td>move to the start of the line</td></tr><tr><td>^B or <Left></td><td><code class="literal"><backward-char></code></td><td>move back one char</td></tr><tr><td>Esc B</td><td><code class="literal"><backward-word></code></td><td>move back one word</td></tr><tr><td>^D or <Delete></td><td><code class="literal"><delete-char></code></td><td>delete the char under the cursor</td></tr><tr><td>^E or <End></td><td><code class="literal"><eol></code></td><td>move to the end of the line</td></tr><tr><td>^F or <Right></td><td><code class="literal"><forward-char></code></td><td>move forward one char</td></tr><tr><td>Esc F</td><td><code class="literal"><forward-word></code></td><td>move forward one word</td></tr><tr><td><Tab></td><td><code class="literal"><complete></code></td><td>complete filename or alias</td></tr><tr><td>^T</td><td><code class="literal"><complete-query></code></td><td>complete address with query</td></tr><tr><td>^K</td><td><code class="literal"><kill-eol></code></td><td>delete to the end of the line</td></tr><tr><td>Esc d</td><td><code class="literal"><kill-eow></code></td><td>delete to the end of the word</td></tr><tr><td>^W</td><td><code class="literal"><kill-word></code></td><td>kill the word in front of the cursor</td></tr><tr><td>^U</td><td><code class="literal"><kill-line></code></td><td>delete entire line</td></tr><tr><td>^V</td><td><code class="literal"><quote-char></code></td><td>quote the next typed key</td></tr><tr><td><Up></td><td><code class="literal"><history-up></code></td><td>recall previous string from history</td></tr><tr><td><Down></td><td><code class="literal"><history-down></code></td><td>recall next string from history</td></tr><tr><td><BackSpace></td><td><code class="literal"><backspace></code></td><td>kill the char in front of the cursor</td></tr><tr><td>Esc u</td><td><code class="literal"><upcase-word></code></td><td>convert word to upper case</td></tr><tr><td>Esc l</td><td><code class="literal"><downcase-word></code></td><td>convert word to lower case</td></tr><tr><td>Esc c</td><td><code class="literal"><capitalize-word></code></td><td>capitalize the word</td></tr><tr><td>^G</td><td>n/a</td><td>abort</td></tr><tr><td><Return></td><td>n/a</td><td>finish editing</td></tr></tbody></table></div></div><br class="table-break" /><p>
170 You can remap the <span class="emphasis"><em>editor</em></span> functions using the
171 <a class="link" href="#bind" title="5. Changing the default key bindings">bind</a> command. For example, to make
172 the <Delete> key delete the character in front of
173 the cursor rather than under, you could use:
174 </p><pre class="screen">
175 bind editor <delete> backspace
176 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editing-history"></a>3.2. History</h3></div></div></div><p>
177 Mutt maintains a history for the built-in editor. The number of items
178 is controlled by the <a class="link" href="#history" title="3.77. history">$history</a>
179 variable and can be made persistent using an external file specified
180 using <a class="link" href="#history-file" title="3.78. history_file">$history_file</a>.
181 You may cycle through them at an editor prompt by using the
182 <code class="literal"><history-up></code> and/or
183 <code class="literal"><history-down></code> commands.
185 Mutt maintains several distinct history lists, one for each of the
186 following categories:
187 </p><div class="itemizedlist"><ul type="disc"><li><p>muttrc commands</p></li><li><p>addresses and aliases</p></li><li><p>shell commands</p></li><li><p>filenames</p></li><li><p>patterns</p></li><li><p>everything else</p></li></ul></div><p>
188 Mutt automatically filters out repeated items from the history. It
189 also mimics the behavior of some shells by ignoring items starting
190 with a space. The latter feature can be useful in macros to not clobber
191 the history's valuable entries with unwanted entries.
192 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="reading"></a>4. Reading Mail - The Index and Pager</h2></div></div></div><p>
193 Similar to many other mail clients, there are two modes in which mail is
194 read in Mutt. The first is the index of messages in the mailbox, which is
195 called the “<span class="quote">index</span>” in Mutt. The second mode is the display of the
196 message contents. This is called the “<span class="quote">pager.</span>”
198 The next few sections describe the functions provided in each of these
200 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index-menu"></a>4.1. The Message Index</h3></div></div></div><p>
201 Common keys used to navigate through and manage messages in the index
202 are shown in <a class="xref" href="#tab-key-index" title="Table 2.3. Most common message index keys">Table 2.3, “Most common message index keys”</a>. How messages are presented
203 in the index menu can be customized using the
204 <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> variable.
205 </p><div class="table"><a id="tab-key-index"></a><p class="title"><b>Table 2.3. Most common message index keys</b></p><div class="table-contents"><table summary="Most common message index keys" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td>c</td><td>change to a different mailbox</td></tr><tr><td>Esc c</td><td>change to a folder in read-only mode</td></tr><tr><td>C</td><td>copy the current message to another mailbox</td></tr><tr><td>Esc C</td><td>decode a message and copy it to a folder</td></tr><tr><td>Esc s</td><td>decode a message and save it to a folder</td></tr><tr><td>D</td><td>delete messages matching a pattern</td></tr><tr><td>d</td><td>delete the current message</td></tr><tr><td>F</td><td>mark as important</td></tr><tr><td>l</td><td>show messages matching a pattern</td></tr><tr><td>N</td><td>mark message as new</td></tr><tr><td>o</td><td>change the current sort method</td></tr><tr><td>O</td><td>reverse sort the mailbox</td></tr><tr><td>q</td><td>save changes and exit</td></tr><tr><td>s</td><td>save-message</td></tr><tr><td>T</td><td>tag messages matching a pattern</td></tr><tr><td>t</td><td>toggle the tag on a message</td></tr><tr><td>Esc t</td><td>toggle tag on entire message thread</td></tr><tr><td>U</td><td>undelete messages matching a pattern</td></tr><tr><td>u</td><td>undelete-message</td></tr><tr><td>v</td><td>view-attachments</td></tr><tr><td>x</td><td>abort changes and exit</td></tr><tr><td><Return></td><td>display-message</td></tr><tr><td><Tab></td><td>jump to the next new or unread message</td></tr><tr><td>@</td><td>show the author's full e-mail address</td></tr><tr><td>$</td><td>save changes to mailbox</td></tr><tr><td>/</td><td>search</td></tr><tr><td>Esc /</td><td>search-reverse</td></tr><tr><td>^L</td><td>clear and redraw the screen</td></tr><tr><td>^T</td><td>untag messages matching a pattern</td></tr></tbody></table></div></div><br class="table-break" /><p>
206 In addition to who sent the message and the subject, a short summary of
207 the disposition of each message is printed beside the message number.
208 Zero or more of the “<span class="quote">flags</span>” in <a class="xref" href="#tab-msg-status-flags" title="Table 2.4. Message status flags">Table 2.4, “Message status flags”</a>
209 may appear, some of which can be turned on or off using these functions:
210 <code class="literal"><set-flag></code> and
211 <code class="literal"><clear-flag></code>
212 bound by default to “<span class="quote">w</span>” and “<span class="quote">W</span>” respectively.
214 Furthermore, the flags in <a class="xref" href="#tab-msg-recip-flags" title="Table 2.5. Message recipient flags">Table 2.5, “Message recipient flags”</a> reflect
215 who the message is addressed to. They can be customized with the
216 <a class="link" href="#to-chars" title="3.290. to_chars">$to_chars</a> variable.
217 </p><div class="table"><a id="tab-msg-status-flags"></a><p class="title"><b>Table 2.4. Message status flags</b></p><div class="table-contents"><table summary="Message status flags" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td>D</td><td>message is deleted (is marked for deletion)</td></tr><tr><td>d</td><td>message has attachments marked for deletion</td></tr><tr><td>K</td><td>contains a PGP public key</td></tr><tr><td>N</td><td>message is new</td></tr><tr><td>O</td><td>message is old</td></tr><tr><td>P</td><td>message is PGP encrypted</td></tr><tr><td>r</td><td>message has been replied to</td></tr><tr><td>S</td><td>message is signed, and the signature is successfully verified</td></tr><tr><td>s</td><td>message is signed</td></tr><tr><td>!</td><td>message is flagged</td></tr><tr><td>*</td><td>message is tagged</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="tab-msg-recip-flags"></a><p class="title"><b>Table 2.5. Message recipient flags</b></p><div class="table-contents"><table summary="Message recipient flags" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td>+</td><td>message is to you and you only</td></tr><tr><td>T</td><td>message is to you, but also to or cc'ed to others</td></tr><tr><td>C</td><td>message is cc'ed to you</td></tr><tr><td>F</td><td>message is from you</td></tr><tr><td>L</td><td>message is sent to a subscribed mailing list</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-menu"></a>4.2. The Pager</h3></div></div></div><p>
218 By default, Mutt uses its builtin pager to display the contents of messages.
219 The pager is very similar to the Unix program <span class="emphasis"><em>less</em></span> though not nearly as
221 </p><div class="table"><a id="tab-key-pager"></a><p class="title"><b>Table 2.6. Most common pager keys</b></p><div class="table-contents"><table summary="Most common pager keys" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td><Return></td><td>go down one line</td></tr><tr><td><Space></td><td>display the next page (or next message if at the end of a message)</td></tr><tr><td>-</td><td>go back to the previous page</td></tr><tr><td>n</td><td>search for next match</td></tr><tr><td>S</td><td>skip beyond quoted text</td></tr><tr><td>T</td><td>toggle display of quoted text</td></tr><tr><td>?</td><td>show keybindings</td></tr><tr><td>/</td><td>regular expression search</td></tr><tr><td>Esc /</td><td>backward regular expression search</td></tr><tr><td>\</td><td>toggle highlighting of search matches</td></tr><tr><td>^</td><td>jump to the top of the message</td></tr></tbody></table></div></div><br class="table-break" /><p>
222 In addition to key bindings in <a class="xref" href="#tab-key-pager" title="Table 2.6. Most common pager keys">Table 2.6, “Most common pager keys”</a>,
223 many of the functions from the index menu are also available in
224 the pager, such as <code class="literal"><delete-message></code> or <code class="literal"><copy-message></code>
225 (this is one advantage over using an external pager to view messages).
227 Also, the internal pager supports a couple other advanced features. For
228 one, it will accept and translate the “<span class="quote">standard</span>” nroff sequences for
229 bold and underline. These sequences are a series of either the letter,
230 backspace (^H), the letter again for bold or the letter, backspace,
231 “<span class="quote">_</span>” for denoting underline. Mutt will attempt to display these
232 in bold and underline respectively if your terminal supports them. If
233 not, you can use the bold and underline <a class="link" href="#color" title="9. Using color and mono video attributes">color</a>
234 objects to specify a color or mono attribute for them.
236 Additionally, the internal pager supports the ANSI escape sequences for
237 character attributes. Mutt translates them into the correct color and
238 character settings. The sequences Mutt supports are:
239 </p><pre class="screen">
240 \e[<span class="emphasis"><em>Ps</em></span>;<span class="emphasis"><em>Ps</em></span>;..<span class="emphasis"><em>Ps</em></span>;m
242 where <span class="emphasis"><em>Ps</em></span> can be one of the codes shown in
243 <a class="xref" href="#tab-ansi-esc" title="Table 2.7. ANSI escape sequences">Table 2.7, “ANSI escape sequences”</a>.
244 </p><div class="table"><a id="tab-ansi-esc"></a><p class="title"><b>Table 2.7. ANSI escape sequences</b></p><div class="table-contents"><table summary="ANSI escape sequences" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Escape code</th><th>Description</th></tr></thead><tbody><tr><td>0</td><td>All attributes off</td></tr><tr><td>1</td><td>Bold on</td></tr><tr><td>4</td><td>Underline on</td></tr><tr><td>5</td><td>Blink on</td></tr><tr><td>7</td><td>Reverse video on</td></tr><tr><td>3<span class="emphasis"><em><color></em></span></td><td>Foreground color is <span class="emphasis"><em><color></em></span> (see <a class="xref" href="#tab-color" title="Table 2.8. Color sequences">Table 2.8, “Color sequences”</a>)</td></tr><tr><td>4<span class="emphasis"><em><color></em></span></td><td>Background color is <span class="emphasis"><em><color></em></span> (see <a class="xref" href="#tab-color" title="Table 2.8. Color sequences">Table 2.8, “Color sequences”</a>)</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="tab-color"></a><p class="title"><b>Table 2.8. Color sequences</b></p><div class="table-contents"><table summary="Color sequences" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Color code</th><th>Color</th></tr></thead><tbody><tr><td>0</td><td>Black</td></tr><tr><td>1</td><td>Red</td></tr><tr><td>2</td><td>Green</td></tr><tr><td>3</td><td>Yellow</td></tr><tr><td>4</td><td>Blue</td></tr><tr><td>5</td><td>Magenta</td></tr><tr><td>6</td><td>Cyan</td></tr><tr><td>7</td><td>White</td></tr></tbody></table></div></div><br class="table-break" /><p>
245 Mutt uses these attributes for handling <code class="literal">text/enriched</code>
246 messages, and they can also be used by an external
247 <a class="link" href="#auto-view" title="4. MIME Autoview">autoview</a> script for highlighting
249 </p><div class="note"><h3 class="title">Note</h3><p>
250 If you change the colors for your
251 display, for example by changing the color associated with color2 for
252 your xterm, then that color will be used instead of green.
253 </p></div><div class="note"><h3 class="title">Note</h3><p>
254 Note that the search commands in the pager take regular expressions,
255 which are not quite the same as the more
256 complex <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> used by the search
257 command in the index. This is because the pager only performs simple
258 text search, whereas the index provides boolean filtering on several
260 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="threads"></a>4.3. Threaded Mode</h3></div></div></div><p>
261 When the mailbox is <a class="link" href="#sort" title="3.271. sort">sorted</a> by <span class="emphasis"><em>threads</em></span>, there are
262 a few additional functions available in the <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span> modes
263 as shown in <a class="xref" href="#tab-key-threads" title="Table 2.9. Most common thread mode keys">Table 2.9, “Most common thread mode keys”</a>.
264 </p><div class="table"><a id="tab-key-threads"></a><p class="title"><b>Table 2.9. Most common thread mode keys</b></p><div class="table-contents"><table summary="Most common thread mode keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>^D</td><td><code class="literal"><delete-thread></code></td><td>delete all messages in the current thread</td></tr><tr><td>^U</td><td><code class="literal"><undelete-thread></code></td><td>undelete all messages in the current thread</td></tr><tr><td>^N</td><td><code class="literal"><next-thread></code></td><td>jump to the start of the next thread</td></tr><tr><td>^P</td><td><code class="literal"><previous-thread></code></td><td>jump to the start of the previous thread</td></tr><tr><td>^R</td><td><code class="literal"><read-thread></code></td><td>mark the current thread as read</td></tr><tr><td>Esc d</td><td><code class="literal"><delete-subthread></code></td><td>delete all messages in the current subthread</td></tr><tr><td>Esc u</td><td><code class="literal"><undelete-subthread></code></td><td>undelete all messages in the current subthread</td></tr><tr><td>Esc n</td><td><code class="literal"><next-subthread></code></td><td>jump to the start of the next subthread</td></tr><tr><td>Esc p</td><td><code class="literal"><previous-subthread></code></td><td>jump to the start of the previous subthread</td></tr><tr><td>Esc r</td><td><code class="literal"><read-subthread></code></td><td>mark the current subthread as read</td></tr><tr><td>Esc t</td><td><code class="literal"><tag-thread></code></td><td>toggle the tag on the current thread</td></tr><tr><td>Esc v</td><td><code class="literal"><collapse-thread></code></td><td>toggle collapse for the current thread</td></tr><tr><td>Esc V</td><td><code class="literal"><collapse-all></code></td><td>toggle collapse for all threads</td></tr><tr><td>P</td><td><code class="literal"><parent-message></code></td><td>jump to parent message in thread</td></tr></tbody></table></div></div><br class="table-break" /><div class="note"><h3 class="title">Note</h3><p>
265 Collapsing a thread displays only the first message
266 in the thread and hides the others. This is useful when threads
267 contain so many messages that you can only see a handful of threads on
268 the screen. See %M in <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>.
269 For example, you could use "%?M?(#%03M)&(%4l)?" in <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> to optionally
270 display the number of hidden messages if the thread is collapsed.
272 See also: <a class="link" href="#strict-threads" title="3.281. strict_threads">$strict_threads</a>.
273 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reading-misc"></a>4.4. Miscellaneous Functions</h3></div></div></div><p>
274 In addition, the <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span>
275 menus have these interesting functions:
276 </p><div class="variablelist"><dl><dt><span class="term">
277 <code class="literal"><create-alias></code><a id="create-alias"></a> (default: a)
279 Creates a new alias based upon the current message (or prompts for a
280 new one). Once editing is complete, an <a class="link" href="#alias" title="4. Defining/Using aliases">alias</a>
281 command is added to the file specified by
282 the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a> variable
284 </p><div class="note"><h3 class="title">Note</h3><p>
285 Mutt does not read the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a>
286 upon startup so you must explicitly <a class="link" href="#source" title="27. Reading initialization commands from another file">source</a> the file.
287 </p></div></dd><dt><span class="term">
288 <code class="literal"><check-traditional-pgp></code><a id="check-traditional-pgp"></a> (default: Esc P)
290 This function will search the current message for content signed or
291 encrypted with PGP the “<span class="quote">traditional</span>” way, that is, without proper
292 MIME tagging. Technically, this function will temporarily change
293 the MIME content types of the body parts containing PGP data; this
294 is similar to the <a class="link" href="#edit-type"><code class="literal"><edit-type></code></a> function's
296 </p></dd><dt><span class="term">
297 <code class="literal"><edit></code><a id="edit"></a> (default: e)
299 This command (available in the index and pager) allows you to
300 edit the raw current message as it's present in the mail folder.
301 After you have finished editing, the changed message will be
302 appended to the current folder, and the original message will be
303 marked for deletion; if the message is unchanged it won't be replaced.
304 </p></dd><dt><span class="term">
305 <code class="literal"><edit-type></code><a id="edit-type"></a> (default:
306 ^E on the attachment menu, and in the pager and index menus;
307 ^T on the compose menu)
309 This command is used to temporarily edit an attachment's content
310 type to fix, for instance, bogus character set parameters. When
311 invoked from the index or from the pager, you'll have the
312 opportunity to edit the top-level attachment's content type. On the
313 <a class="link" href="#attach-menu" title="1.2. The Attachment Menu">attachment menu</a>, you can change any
314 attachment's content type. These changes are not persistent, and get
315 lost upon changing folders.
317 Note that this command is also available on the <a class="link" href="#compose-menu" title="1.3. The Compose Menu">compose
318 menu</a>. There, it's used to fine-tune the properties of attachments you are going
320 </p></dd><dt><span class="term">
321 <code class="literal"><enter-command></code><a id="enter-command"></a> (default: “<span class="quote">:</span>”)
323 This command is used to execute any command you would normally put in a
324 configuration file. A common use is to check the settings of variables, or
325 in conjunction with <a class="link" href="#macro" title="8. Keyboard macros">macros</a> to change settings on the
327 </p></dd><dt><span class="term">
328 <code class="literal"><extract-keys></code><a id="extract-keys"></a> (default: ^K)
330 This command extracts PGP public keys from the current or tagged
331 message(s) and adds them to your PGP public key ring.
332 </p></dd><dt><span class="term">
333 <code class="literal"><forget-passphrase></code><a id="forget-passphrase"></a> (default:
336 This command wipes the passphrase(s) from memory. It is useful, if
337 you misspelled the passphrase.
338 </p></dd><dt><span class="term">
339 <code class="literal"><list-reply></code><a id="list-reply"></a> (default: L)
341 Reply to the current or tagged message(s) by extracting any addresses which
342 match the regular expressions given by the <a class="link" href="#lists" title="12. Mailing lists">lists or subscribe</a>
343 commands, but also honor any <code class="literal">Mail-Followup-To</code> header(s) if the
344 <a class="link" href="#honor-followup-to" title="3.79. honor_followup_to">$honor_followup_to</a>
345 configuration variable is set. Using this when replying to messages posted
346 to mailing lists helps avoid duplicate copies being sent to the author of
347 the message you are replying to.
348 </p></dd><dt><span class="term">
349 <code class="literal"><pipe-message></code><a id="pipe-message"></a> (default: |)
351 Asks for an external Unix command and pipes the current or
352 tagged message(s) to it. The variables <a class="link" href="#pipe-decode" title="3.212. pipe_decode">$pipe_decode</a>, <a class="link" href="#pipe-split" title="3.211. pipe_split">$pipe_split</a>,
353 <a class="link" href="#pipe-sep" title="3.213. pipe_sep">$pipe_sep</a> and <a class="link" href="#wait-key" title="3.300. wait_key">$wait_key</a> control the exact behavior of this function.
354 </p></dd><dt><span class="term">
355 <code class="literal"><resend-message></code><a id="resend-message"></a> (default: Esc e)
357 Mutt takes the current message as a template for a
358 new message. This function is best described as "recall from arbitrary
359 folders". It can conveniently be used to forward MIME messages while
360 preserving the original mail structure. Note that the amount of headers
361 included here depends on the value of the <a class="link" href="#weed" title="3.301. weed">$weed</a>
364 This function is also available from the attachment menu. You can use this
365 to easily resend a message which was included with a bounce message
366 as a <code class="literal">message/rfc822</code> body part.
367 </p></dd><dt><span class="term">
368 <code class="literal"><shell-escape></code><a id="shell-escape"></a> (default: !)
370 Asks for an external Unix command and executes it. The <a class="link" href="#wait-key" title="3.300. wait_key">$wait_key</a> can be used to control
371 whether Mutt will wait for a key to be pressed when the command returns
372 (presumably to let the user read the output of the command), based on
373 the return status of the named command. If no command is given, an
374 interactive shell is executed.
375 </p></dd><dt><span class="term">
376 <code class="literal"><toggle-quoted></code><a id="toggle-quoted"></a> (default: T)
378 The pager uses the <a class="link" href="#quote-regexp" title="3.235. quote_regexp">$quote_regexp</a> variable to detect quoted text when
379 displaying the body of the message. This function toggles the display
380 of the quoted material in the message. It is particularly useful when
381 being interested in just the response and there is a large amount of
382 quoted text in the way.
383 </p></dd><dt><span class="term">
384 <code class="literal"><skip-quoted></code><a id="skip-quoted"></a> (default: S)
386 This function will go to the next line of non-quoted text which comes
387 after a line of quoted text in the internal pager.
388 </p></dd></dl></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sending"></a>5. Sending Mail</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sending-intro"></a>5.1. Introduction</h3></div></div></div><p>
389 The bindings shown in <a class="xref" href="#tab-key-send" title="Table 2.10. Most common mail sending keys">Table 2.10, “Most common mail sending keys”</a> are available in the
390 <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span> to start a new message.
391 </p><div class="table"><a id="tab-key-send"></a><p class="title"><b>Table 2.10. Most common mail sending keys</b></p><div class="table-contents"><table summary="Most common mail sending keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>m</td><td><code class="literal"><compose></code></td><td>compose a new message</td></tr><tr><td>r</td><td><code class="literal"><reply></code></td><td>reply to sender</td></tr><tr><td>g</td><td><code class="literal"><group-reply></code></td><td>reply to all recipients</td></tr><tr><td>L</td><td><code class="literal"><list-reply></code></td><td>reply to mailing list address</td></tr><tr><td>f</td><td><code class="literal"><forward></code></td><td>forward message</td></tr><tr><td>b</td><td><code class="literal"><bounce></code></td><td>bounce (remail) message</td></tr><tr><td>Esc k</td><td><code class="literal"><mail-key></code></td><td>mail a PGP public key to someone</td></tr></tbody></table></div></div><br class="table-break" /><p>
392 <span class="emphasis"><em>Bouncing</em></span> a message sends the message as-is to the recipient you
393 specify. <span class="emphasis"><em>Forwarding</em></span> a message allows you to add comments or
394 modify the message you are forwarding. These items are discussed
395 in greater detail in the next chapter “<span class="quote"><a class="link" href="#forwarding-mail" title="6. Forwarding and Bouncing Mail">Forwarding
396 and Bouncing Mail</a>.</span>”
398 Mutt will then enter the <span class="emphasis"><em>compose</em></span> menu and prompt you for the
399 recipients to place on the “<span class="quote">To:</span>” header field. Next, it will ask
400 you for the “<span class="quote">Subject:</span>” field for the message, providing a default if
401 you are replying to or forwarding a message. See also
402 <a class="link" href="#askcc" title="3.10. askcc">$askcc</a>,
403 <a class="link" href="#askbcc" title="3.9. askbcc">$askbcc</a>,
404 <a class="link" href="#autoedit" title="3.17. autoedit">$autoedit</a>,
405 <a class="link" href="#bounce" title="3.21. bounce">$bounce</a>,
406 <a class="link" href="#fast-reply" title="3.55. fast_reply">$fast_reply</a>,
407 and <a class="link" href="#include" title="3.98. include">$include</a>
408 for changing how Mutt asks these questions.
410 Mutt will then automatically start your <a class="link" href="#editor" title="3.51. editor">$editor</a>
411 on the message body. If the <a class="link" href="#edit-headers" title="3.50. edit_headers">$edit_headers</a>
412 variable is set, the headers will be at the top of the message in your editor.
413 Any messages you are replying to will be added in sort order to the message,
414 with appropriate <a class="link" href="#attribution" title="3.16. attribution">$attribution</a>,
415 <a class="link" href="#indent-string" title="3.100. indent_string">$indent_string</a> and
416 <a class="link" href="#post-indent-string" title="3.223. post_indent_string">$post_indent_string</a>.
417 When forwarding a message, if the <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a>
418 variable is unset, a copy of the forwarded message will be included. If
419 you have specified a <a class="link" href="#signature" title="3.263. signature">$signature</a>, it
420 will be appended to the message.
422 Once you have finished editing the body of your mail message, you are
423 returned to the <span class="emphasis"><em>compose</em></span> menu providing the functions
424 shown in <a class="xref" href="#tab-func-compose" title="Table 2.11. Most common compose menu keys">Table 2.11, “Most common compose menu keys”</a> to modify, send or postpone the
426 </p><div class="table"><a id="tab-func-compose"></a><p class="title"><b>Table 2.11. Most common compose menu keys</b></p><div class="table-contents"><table summary="Most common compose menu keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td><code class="literal"><attach-file></code></td><td>attach a file</td></tr><tr><td>A</td><td><code class="literal"><attach-message></code></td><td>attach message(s) to the message</td></tr><tr><td>Esc k</td><td><code class="literal"><attach-key></code></td><td>attach a PGP public key</td></tr><tr><td>d</td><td><code class="literal"><edit-description></code></td><td>edit description on attachment</td></tr><tr><td>D</td><td><code class="literal"><detach-file></code></td><td>detach a file</td></tr><tr><td>t</td><td><code class="literal"><edit-to></code></td><td>edit the To field</td></tr><tr><td>Esc f</td><td><code class="literal"><edit-from></code></td><td>edit the From field</td></tr><tr><td>r</td><td><code class="literal"><edit-reply-to></code></td><td>edit the Reply-To field</td></tr><tr><td>c</td><td><code class="literal"><edit-cc></code></td><td>edit the Cc field</td></tr><tr><td>b</td><td><code class="literal"><edit-bcc></code></td><td>edit the Bcc field</td></tr><tr><td>y</td><td><code class="literal"><send-message></code></td><td>send the message</td></tr><tr><td>s</td><td><code class="literal"><edit-subject></code></td><td>edit the Subject</td></tr><tr><td>S</td><td><code class="literal"><smime-menu></code></td><td>select S/MIME options</td></tr><tr><td>f</td><td><code class="literal"><edit-fcc></code></td><td>specify an “<span class="quote">Fcc</span>” mailbox</td></tr><tr><td>p</td><td><code class="literal"><pgp-menu></code></td><td>select PGP options</td></tr><tr><td>P</td><td><code class="literal"><postpone-message></code></td><td>postpone this message until later</td></tr><tr><td>q</td><td><code class="literal"><quit></code></td><td>quit (abort) sending the message</td></tr><tr><td>w</td><td><code class="literal"><write-fcc></code></td><td>write the message to a folder</td></tr><tr><td>i</td><td><code class="literal"><ispell></code></td><td>check spelling (if available on your system)</td></tr><tr><td>^F</td><td><code class="literal"><forget-passphrase></code></td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><br class="table-break" /><p>
427 The compose menu is also used to edit the attachments for a message which can be either files
428 or other messages. The <code class="literal"><attach-message></code> function to will prompt you for a folder to
429 attach messages from. You can now tag messages in that folder and they
430 will be attached to the message you are sending.
431 </p><div class="note"><h3 class="title">Note</h3><p>
433 operations like composing a new mail, replying, forwarding, etc. are
434 not permitted when you are in that folder. The %r in
435 <a class="link" href="#status-format" title="3.279. status_format">$status_format</a> will change to
436 a “<span class="quote">A</span>” to indicate that you are in attach-message mode.
437 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="edit-header"></a>5.2. Editing the message header</h3></div></div></div><p>
438 When editing the header because of <a class="link" href="#edit-headers" title="3.50. edit_headers">$edit_headers</a>
439 being set, there are a several pseudo headers available which
440 will not be included in sent messages.
441 </p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="fcc-header"></a>5.2.1. Fcc: pseudo header</h4></div></div></div><p>
444 <code class="literal">Fcc:</code> <span class="emphasis"><em>filename</em></span>
446 as a header, Mutt will pick up <span class="emphasis"><em>filename</em></span>
447 just as if you had used the <code class="literal"><edit-fcc></code> function in the <span class="emphasis"><em>compose</em></span> menu.
448 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="attach-header"></a>5.2.2. Attach: pseudo header</h4></div></div></div><p>
449 You can also attach files to your message by specifying
451 <code class="literal">Attach:</code> <span class="emphasis"><em>filename</em></span> [ <span class="emphasis"><em>description</em></span> ]
453 where <span class="emphasis"><em>filename</em></span> is the file to attach and <span class="emphasis"><em>description</em></span> is an
454 optional string to use as the description of the attached file.
455 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="pgp-header"></a>5.2.3. Pgp: pseudo header</h4></div></div></div><p>
456 If you want to use PGP, you can specify
458 <code class="literal">Pgp:</code> [ <code class="literal">E</code> | <code class="literal">S</code> | <code class="literal">S</code><span class="emphasis"><em><id></em></span> ]
461 “<span class="quote">E</span>” selects encryption, “<span class="quote">S</span>” selects signing and
462 “<span class="quote">S<id></span>” selects signing with the given key, setting
463 <a class="link" href="#pgp-sign-as" title="3.163. pgp_sign_as">$pgp_sign_as</a>
465 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="in-reply-to-header"></a>5.2.4. In-Reply-To: header</h4></div></div></div><p>
466 When replying to messages, the <span class="emphasis"><em>In-Reply-To:</em></span> header contains the
467 Message-Id of the message(s) you reply to. If you remove its value, Mutt will not generate a
468 <span class="emphasis"><em>References:</em></span> field, which allows you to create a new message thread, for example
469 to create a new message to a mailing list without having to enter the mailing list's address.
470 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sending-crypto"></a>5.3. Sending cryptographically signed/encrypted messages</h3></div></div></div><p>
471 If you have told mutt to PGP or S/MIME encrypt a message, it will guide you
472 through a key selection process when you try to send the message.
473 Mutt will not ask you any questions about keys which have a
474 certified user ID matching one of the message recipients' mail
475 addresses. However, there may be situations in which there are
476 several keys, weakly certified user ID fields, or where no matching
479 In these cases, you are dropped into a menu with a list of keys from
480 which you can select one. When you quit this menu, or mutt can't
481 find any matching keys, you are prompted for a user ID. You can, as
482 usually, abort this prompt using <code class="literal">^G</code>. When you do so, mutt will
483 return to the compose screen.
485 Once you have successfully finished the key selection, the message
486 will be encrypted using the selected public keys when sent out.
488 Most fields of the entries in the key selection menu (see also <a class="link" href="#pgp-entry-format" title="3.155. pgp_entry_format">$pgp_entry_format</a>)
489 have obvious meanings. But some explanations on the capabilities, flags,
490 and validity fields are in order.
492 The flags sequence (%f) will expand to one of the flags in
493 <a class="xref" href="#tab-pgp-menuflags" title="Table 2.12. PGP key menu flags">Table 2.12, “PGP key menu flags”</a>.
494 </p><div class="table"><a id="tab-pgp-menuflags"></a><p class="title"><b>Table 2.12. PGP key menu flags</b></p><div class="table-contents"><table summary="PGP key menu flags" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td>R</td><td>The key has been revoked and can't be used.</td></tr><tr><td>X</td><td>The key is expired and can't be used.</td></tr><tr><td>d</td><td>You have marked the key as disabled.</td></tr><tr><td>c</td><td>There are unknown critical self-signature packets.</td></tr></tbody></table></div></div><br class="table-break" /><p>
495 The capabilities field (%c) expands to a two-character sequence
496 representing a key's capabilities. The first character gives
497 the key's encryption capabilities: A minus sign (“<span class="quote">-</span>”) means
498 that the key cannot be used for encryption. A dot (“<span class="quote">.</span>”) means that
499 it's marked as a signature key in one of the user IDs, but may
500 also be used for encryption. The letter “<span class="quote">e</span>” indicates that
501 this key can be used for encryption.
503 The second character indicates the key's signing capabilities. Once
504 again, a “<span class="quote">-</span>” implies “<span class="quote">not for signing</span>”, “<span class="quote">.</span>” implies
505 that the key is marked as an encryption key in one of the user-ids, and
506 “<span class="quote">s</span>” denotes a key which can be used for signing.
508 Finally, the validity field (%t) indicates how well-certified a user-id
509 is. A question mark (“<span class="quote">?</span>”) indicates undefined validity, a minus
510 character (“<span class="quote">-</span>”) marks an untrusted association, a space character
511 means a partially trusted association, and a plus character (“<span class="quote">+</span>”)
512 indicates complete validity.
513 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sending-mixmaster"></a>5.4. Sending anonymous messages via mixmaster</h3></div></div></div><p>
514 You may also have compiled mutt to co-operate with Mixmaster, an
515 anonymous remailer. Mixmaster permits you to send your messages
516 anonymously using a chain of remailers. Mixmaster support in mutt is for
517 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
518 It does not support earlier versions or the later so-called version 3 betas,
519 of which the latest appears to be called 2.9b23.
521 To use it, you'll have to obey certain restrictions. Most
522 important, you cannot use the <code class="literal">Cc</code> and <code class="literal">Bcc</code> headers. To tell
523 Mutt to use mixmaster, you have to select a remailer chain, using
524 the mix function on the compose menu.
526 The chain selection screen is divided into two parts. In the
527 (larger) upper part, you get a list of remailers you may use. In
528 the lower part, you see the currently selected chain of remailers.
530 You can navigate in the chain using the <code class="literal"><chain-prev></code> and
531 <code class="literal"><chain-next></code> functions, which are by default bound to the left
532 and right arrows and to the <code class="literal">h</code> and <code class="literal">l</code> keys (think vi
533 keyboard bindings). To insert a remailer at the current chain
534 position, use the <code class="literal"><insert></code> function. To append a remailer behind
535 the current chain position, use <code class="literal"><select-entry></code> or <code class="literal"><append></code>.
536 You can also delete entries from the chain, using the corresponding
537 function. Finally, to abandon your changes, leave the menu, or
538 <code class="literal"><accept></code> them pressing (by default) the <code class="literal">Return</code> key.
540 Note that different remailers do have different capabilities,
541 indicated in the %c entry of the remailer menu lines (see
542 <a class="link" href="#mix-entry-format" title="3.130. mix_entry_format">$mix_entry_format</a>). Most important is
543 the “<span class="quote">middleman</span>” capability, indicated by a capital “<span class="quote">M</span>”: This
544 means that the remailer in question cannot be used as the final
545 element of a chain, but will only forward messages to other
546 mixmaster remailers. For details on the other capabilities, please
547 have a look at the mixmaster documentation.
548 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ff"></a>5.5. Sending format=flowed messages</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="ff-concept"></a>5.5.1. Concept</h4></div></div></div><p>
549 <code class="literal">format=flowed</code>-style messages (or <code class="literal">f=f</code>
550 for short) are <code class="literal">text/plain</code> messages that consist of paragraphs which a receiver's
551 mail client may reformat to its own needs which mostly means to
552 customize line lengths regardless of what the sender sent. Technically this is
553 achieved by letting lines of a “<span class="quote">flowable</span>” paragraph end in spaces
554 except for the last line.
556 While for text-mode clients like mutt it's the best way to assume only a
557 standard 80x25 character cell terminal, it may be desired to let the
558 receiver decide completely how to view a message.
559 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="ff-support"></a>5.5.2. Mutt support</h4></div></div></div><p>
560 Mutt only supports setting the required <code class="literal">format=flowed</code>
561 MIME parameter on outgoing messages if the <a class="link" href="#text-flowed" title="3.283. text_flowed">$text_flowed</a>
562 variable is set, specifically it does not add the
565 After editing the initial message text and before entering
566 the compose menu, mutt properly space-stuffes the message.
567 <span class="emphasis"><em>Space-stuffing</em></span> is required by RfC3676 defining
568 <code class="literal">format=flowed</code> and means to prepend a space to:
569 </p><div class="itemizedlist"><ul type="disc"><li><p>all lines starting with a space</p></li><li><p>lines starting with the word “<span class="quote"><code class="literal">From</code></span>”
570 followed by space</p></li><li><p>all lines starting with “<span class="quote"><code class="literal">></code></span>” which
571 is not intended to be a quote character</p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>
572 Mutt only supports space-stuffing
573 for the first two types of lines but not for the third: It is impossible to
574 safely detect whether a leading <code class="literal">></code> character starts a
575 quote or not. Furthermore, Mutt only applies space-stuffing
576 <span class="emphasis"><em>once</em></span> after the initial edit is finished.
578 All leading spaces are to be removed by receiving clients to restore
579 the original message prior to further processing.
580 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="ff-editor"></a>5.5.3. Editor considerations</h4></div></div></div><p>
581 As mutt provides no additional features to compose <code class="literal">f=f</code>
582 messages, it's completely up to the user and his editor to produce
583 proper messages. Please consider your editor's documentation if you
584 intend to send <code class="literal">f=f</code> messages.
586 Please note that when editing messages from the compose menu several
587 times before really sending a mail, it's up to the user to ensure that
588 the message is properly space-stuffed.
590 For example, <span class="emphasis"><em>vim</em></span> provides the <code class="literal">w</code>
591 flag for its <code class="literal">formatoptions</code> setting to assist in
592 creating <code class="literal">f=f</code> messages, see <code class="literal">:help
593 fo-table</code> for details.
594 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="forwarding-mail"></a>6. Forwarding and Bouncing Mail</h2></div></div></div><p>
595 Bouncing and forwarding let you send an existing message to recipients
596 that you specify. Bouncing a message sends a verbatim copy of a message
597 to alternative addresses as if they were the message's original
598 recipients specified in the Bcc header.
599 Forwarding a message, on the other hand, allows you to modify the message
600 before it is resent (for example, by adding your own comments). Bouncing
601 is done using the <code class="literal"><bounce></code> function and forwarding
602 using the <code class="literal"><forward></code> function bound to “<span class="quote">b</span>” and “<span class="quote">f</span>”
605 Forwarding can be done by including the original message in the new
606 message's body (surrounded by indicating lines) or including it as a MIME
607 attachment, depending on the value of the <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a> variable. Decoding of attachments,
608 like in the pager, can be controlled by the <a class="link" href="#forward-decode" title="3.62. forward_decode">$forward_decode</a> and <a class="link" href="#mime-forward-decode" title="3.128. mime_forward_decode">$mime_forward_decode</a> variables,
609 respectively. The desired forwarding format may depend on the content,
610 therefore <span class="emphasis"><em>$mime_forward</em></span> is a quadoption which, for
611 example, can be set to “<span class="quote">ask-no</span>”.
613 The inclusion of headers is controlled by the current setting of the
614 <a class="link" href="#weed" title="3.301. weed">$weed</a> variable, unless <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a> is set.
616 Editing the message to forward follows the same procedure as sending or
617 replying to a message does.
618 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="postponing-mail"></a>7. Postponing Mail</h2></div></div></div><p>
619 At times it is desirable to delay sending a message that you have
620 already begun to compose. When the <code class="literal"><postpone-message></code> function is
621 used in the <span class="emphasis"><em>compose</em></span> menu, the body of your message and attachments
622 are stored in the mailbox specified by the <a class="link" href="#postponed" title="3.225. postponed">$postponed</a> variable. This means that you can recall the
623 message even if you exit Mutt and then restart it at a later time.
625 Once a message is postponed, there are several ways to resume it. From the
626 command line you can use the “<span class="quote">-p</span>” option, or if you compose a new
627 message from the <span class="emphasis"><em>index</em></span> or <span class="emphasis"><em>pager</em></span> you will be prompted if postponed
628 messages exist. If multiple messages are currently postponed, the
629 <span class="emphasis"><em>postponed</em></span> menu will pop up and you can select which message you would
631 </p><div class="note"><h3 class="title">Note</h3><p>
632 If you postpone a reply to a message, the reply setting of
633 the message is only updated when you actually finish the message and
634 send it. Also, you must be in the same folder with the message you
635 replied to for the status of the message to be updated.
637 See also the <a class="link" href="#postpone" title="3.224. postpone">$postpone</a> quad-option.
638 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="configuration"></a>Chapter 3. Configuration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#configuration-files">1. Location of initialization files</a></span></dt><dt><span class="sect1"><a href="#muttrc-syntax">2. Syntax of Initialization Files</a></span></dt><dt><span class="sect1"><a href="#addrgroup">3. Address groups</a></span></dt><dt><span class="sect1"><a href="#alias">4. Defining/Using aliases</a></span></dt><dt><span class="sect1"><a href="#bind">5. Changing the default key bindings</a></span></dt><dt><span class="sect1"><a href="#charset-hook">6. Defining aliases for character sets </a></span></dt><dt><span class="sect1"><a href="#folder-hook">7. Setting variables based upon mailbox</a></span></dt><dt><span class="sect1"><a href="#macro">8. Keyboard macros</a></span></dt><dt><span class="sect1"><a href="#color">9. Using color and mono video attributes</a></span></dt><dt><span class="sect1"><a href="#ignore">10. Message header display</a></span></dt><dt><span class="sect1"><a href="#alternates">11. Alternative addresses</a></span></dt><dt><span class="sect1"><a href="#lists">12. Mailing lists</a></span></dt><dt><span class="sect1"><a href="#mbox-hook">13. Using Multiple spool mailboxes</a></span></dt><dt><span class="sect1"><a href="#mailboxes">14. Monitoring incoming mail</a></span></dt><dt><span class="sect1"><a href="#my-hdr">15. User defined headers</a></span></dt><dt><span class="sect1"><a href="#save-hook">16. Specify default save mailbox</a></span></dt><dt><span class="sect1"><a href="#fcc-hook">17. Specify default Fcc: mailbox when composing</a></span></dt><dt><span class="sect1"><a href="#fcc-save-hook">18. Specify default save filename and default Fcc: mailbox at once</a></span></dt><dt><span class="sect1"><a href="#send-hook">19. Change settings based upon message recipients</a></span></dt><dt><span class="sect1"><a href="#message-hook">20. Change settings before formatting a message</a></span></dt><dt><span class="sect1"><a href="#crypt-hook">21. Choosing the cryptographic key of the recipient</a></span></dt><dt><span class="sect1"><a href="#push">22. Adding key sequences to the keyboard buffer</a></span></dt><dt><span class="sect1"><a href="#exec">23. Executing functions</a></span></dt><dt><span class="sect1"><a href="#score-command">24. Message Scoring</a></span></dt><dt><span class="sect1"><a href="#spam">25. Spam detection</a></span></dt><dt><span class="sect1"><a href="#set">26. Setting and Querying Variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#set-commands">26.1. Commands</a></span></dt><dt><span class="sect2"><a href="#set-myvar">26.2. User-defined variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="#source">27. Reading initialization commands from another file</a></span></dt><dt><span class="sect1"><a href="#unhook">28. Removing hooks</a></span></dt><dt><span class="sect1"><a href="#formatstrings">29. Format Strings</a></span></dt><dd><dl><dt><span class="sect2"><a href="#formatstrings-basics">29.1. Basic usage</a></span></dt><dt><span class="sect2"><a href="#formatstrings-filters">29.2. Filters</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="configuration-files"></a>1. Location of initialization files</h2></div></div></div><p>
639 While the default configuration (or “<span class="quote">preferences</span>”) make Mutt
640 usable right out of the box, it is often desirable to tailor Mutt to
641 suit your own tastes. When Mutt is first invoked, it will attempt to
642 read the “<span class="quote">system</span>” configuration file (defaults set by your local
643 system administrator), unless the “<span class="quote">-n</span>” <a class="link" href="#commandline" title="1. Command line options">command line</a> option is specified. This file is typically
644 <code class="literal">/usr/local/share/mutt/Muttrc</code> or <code class="literal">/etc/Muttrc</code>. Mutt
645 will next look for a file named <code class="literal">.muttrc</code> in your home
646 directory. If this file does not exist and your home directory has
647 a subdirectory named <code class="literal">.mutt</code>, mutt try to load a file named
648 <code class="literal">.mutt/muttrc</code>.
650 <code class="literal">.muttrc</code> is the file where you will usually place your <a class="link" href="#commands" title="2. Configuration Commands">commands</a> to configure Mutt.
652 In addition, mutt supports version specific configuration files that are
653 parsed instead of the default files as explained above. For instance, if
654 your system has a <code class="literal">Muttrc-0.88</code> file in the system configuration
655 directory, and you are running version 0.88 of mutt, this file will be
656 sourced instead of the <code class="literal">Muttrc</code> file. The same is true of the user
657 configuration file, if you have a file <code class="literal">.muttrc-0.88.6</code> in your home
658 directory, when you run mutt version 0.88.6, it will source this file
659 instead of the default <code class="literal">.muttrc</code> file. The version number is the
660 same which is visible using the “<span class="quote">-v</span>” <a class="link" href="#commandline" title="1. Command line options">command line</a> switch or using the <code class="literal">show-version</code> key (default:
661 V) from the index menu.
662 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttrc-syntax"></a>2. Syntax of Initialization Files</h2></div></div></div><p>
663 An initialization file consists of a series of <a class="link" href="#commands" title="2. Configuration Commands">commands</a>. Each line of the file may contain one or more commands.
664 When multiple commands are used, they must be separated by a semicolon
666 </p><div class="example"><a id="ex-rc-multiple-cmds"></a><p class="title"><b>Example 3.1. Multiple configuration commands per line</b></p><div class="example-contents"><pre class="screen">
667 set realname='Mutt user' ; ignore x-
668 </pre></div></div><br class="example-break" /><p>
669 The hash mark, or pound sign
670 (“<span class="quote">#</span>”), is used as a “<span class="quote">comment</span>” character. You can use it to
671 annotate your initialization file. All text after the comment character
672 to the end of the line is ignored. For example,
673 </p><div class="example"><a id="ex-ec-comment"></a><p class="title"><b>Example 3.2. Commenting configuration files</b></p><div class="example-contents"><pre class="screen">
674 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
675 </pre></div></div><br class="example-break" /><p>
676 Single quotes (') and double quotes (") can be used to quote strings
677 which contain spaces or other special characters. The difference between
678 the two types of quotes is similar to that of many popular shell programs,
679 namely that a single quote is used to specify a literal string (one that is
680 not interpreted for shell variables or quoting with a backslash [see
681 next paragraph]), while double quotes indicate a string for which
682 should be evaluated. For example, backticks are evaluated inside of double
683 quotes, but <span class="bold"><strong>not</strong></span> for single quotes.
685 \ quotes the next character, just as in shells such as bash and zsh.
686 For example, if want to put quotes “<span class="quote">"</span>” inside of a string, you can use
687 “<span class="quote">\</span>” to force the next character to be a literal instead of interpreted
689 </p><div class="example"><a id="ex-rc-quote"></a><p class="title"><b>Example 3.3. Escaping quotes in congfiguration files</b></p><div class="example-contents"><pre class="screen">
690 set realname="Michael \"MuttDude\" Elkins"
691 </pre></div></div><br class="example-break" /><p>
692 “<span class="quote">\\</span>” means to insert a literal “<span class="quote">\</span>” into the line.
693 “<span class="quote">\n</span>” and “<span class="quote">\r</span>” have their usual C meanings of linefeed and
694 carriage-return, respectively.
696 A \ at the end of a line can be used to split commands over
697 multiple lines, provided that the split points don't appear in the
698 middle of command names.
700 It is also possible to substitute the output of a Unix command in an
701 initialization file. This is accomplished by enclosing the command in
702 backticks (``). For example,
703 </p><div class="example"><a id="ex-rc-backtick"></a><p class="title"><b>Example 3.4. Using external command's output in configuration files</b></p><div class="example-contents"><pre class="screen">
704 my_hdr X-Operating-System: `uname -a`
705 </pre></div></div><br class="example-break" /><p>
706 The output of the Unix command “<span class="quote">uname -a</span>” will be substituted before the
708 </p><div class="note"><h3 class="title">Note</h3><p>
709 Since initialization files are line oriented, only
710 the first line of output from the Unix command will be substituted.
712 Both environment variables and mutt variables can be accessed by
713 prepending “<span class="quote">$</span>” to the name of the variable. For example,
714 </p><div class="example"><a id="ex-rc-env"></a><p class="title"><b>Example 3.5. Using environment variables in configuration files</b></p><div class="example-contents"><pre class="screen">
715 set record=+sent_on_$HOSTNAME
716 </pre></div></div><br class="example-break" /><p>
717 will cause mutt to save outgoing messages to a folder named
718 “<span class="quote">sent_on_kremvax</span>” if the environment variable HOSTNAME is set to
719 “<span class="quote">kremvax.</span>” (See <a class="link" href="#record" title="3.240. record">$record</a> for
722 Mutt expands the variable when it is assigned, not when it is used. If
723 the value of a variable on the right-hand side of an assignment
724 changes after the assignment, the variable on the left-hand side will
727 The commands understood by mutt are explained in the next paragraphs.
728 For a complete list, see the <a class="link" href="#commands" title="2. Configuration Commands">command reference</a>.
730 All configuration files are expected to be in the current locale as
731 specified by the <a class="link" href="#charset" title="3.25. charset">$charset</a> variable
732 which doesn't have a default value since it's determined by Mutt at startup.
733 If a configuration file is not encoded in the same character set the
734 <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>
735 variable should be used: all lines starting with the next are recoded
736 from $config_charset to $charset.
738 This mechanism should be avoided if possible as it has the
739 following implications:
740 </p><div class="itemizedlist"><ul type="disc"><li><p>These variables should be set early in a configuration
741 file with $charset preceding $config_charset so Mutt
742 know what character set to convert to.</p></li><li><p>If $config_charset is set, it should be set
743 in each configuration file because the value is global and <span class="emphasis"><em>not</em></span>
744 per configuration file.</p></li><li><p>Because Mutt first recodes a line before it attempts to parse it,
745 a conversion introducing question marks or other characters as
746 part of errors (unconvertable characters, transliteration) may introduce syntax
747 errors or silently change the meaning of certain tokens (e.g. inserting
748 question marks into regular expressions).</p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="addrgroup"></a>3. Address groups</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">group</code> [
749 <code class="option">-group</code>
750 <em class="replaceable"><code>name</code></em>
752 <code class="option">-rx</code>
753 <em class="replaceable"><code>expr</code></em>
755 <code class="option">-addr</code>
756 <em class="replaceable"><code>expr</code></em>
757 ... }</p></div><div class="cmdsynopsis"><p><code class="command">ungroup</code> [
758 <code class="option">-group</code>
759 <em class="replaceable"><code>name</code></em>
761 <em class="replaceable"><code>*</code></em>
763 <code class="option">-rx</code>
764 <em class="replaceable"><code>expr</code></em>
766 <code class="option">-addr</code>
767 <em class="replaceable"><code>expr</code></em>
769 <code class="literal">group</code> is used to directly add either addresses or
770 regular expressions to the specified group or groups. The different
771 categories of arguments to the <code class="literal">group</code> command can be
772 in any order. The flags <code class="literal">-rx</code> and
773 <code class="literal">-addr</code> specify what the following strings (that cannot
774 begin with a hyphen) should be interpreted as: either a regular
775 expression or an email address, respectively.
777 These address groups can also be created implicitly by the
778 <a class="link" href="#alias" title="4. Defining/Using aliases">alias</a>, <a class="link" href="#lists" title="12. Mailing lists">lists</a>,
779 <a class="link" href="#lists" title="12. Mailing lists">subscribe</a> and
780 <a class="link" href="#alternates" title="11. Alternative addresses">alternates</a> commands by specifying the
781 optional <code class="literal">-group</code> option.
783 Once defined, these address groups can be used in
784 <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> to search for and limit the
785 display to messages matching a group.
787 <code class="literal">ungroup</code> is used to remove addresses or regular
788 expressions from the specified group or groups. The syntax is similar to
789 the <code class="literal">group</code> command, however the special character
790 <code class="literal">*</code> can be used to empty a group of all of its
792 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alias"></a>4. Defining/Using aliases</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">alias</code> [
793 <code class="option">-group</code>
794 <em class="replaceable"><code>name</code></em>
796 <em class="replaceable"><code>key</code></em>
798 <em class="replaceable"><code>address</code></em>
800 <em class="replaceable"><code>address</code></em>
802 It's usually very cumbersome to remember or type out the address of someone
803 you are communicating with. Mutt allows you to create “<span class="quote">aliases</span>” which map
804 a short string to a full address.
805 </p><div class="note"><h3 class="title">Note</h3><p>
806 If you want to create an alias for more than
807 one address, you <span class="bold"><strong>must</strong></span> separate the addresses with a comma (“<span class="quote">,</span>”).
809 The optional <code class="literal">-group</code> argument to
810 <code class="literal">alias</code> causes the aliased address(es) to be added to
811 the named <span class="emphasis"><em>group</em></span>.
813 To remove an alias or aliases (“<span class="quote">*</span>” means all aliases):
814 </p><div class="cmdsynopsis"><p><code class="command">unalias</code> [
815 <code class="option">-group</code>
816 <em class="replaceable"><code>name</code></em>
818 <em class="replaceable"><code>*</code></em>
820 <em class="replaceable"><code>key</code></em>
821 ... }</p></div><pre class="screen">
822 alias muttdude me@cs.hmc.edu (Michael Elkins)
823 alias theguys manny, moe, jack
825 Unlike other mailers, Mutt doesn't require aliases to be defined
826 in a special file. The <code class="literal">alias</code> command can appear anywhere in
827 a configuration file, as long as this file is <a class="link" href="#source" title="27. Reading initialization commands from another file">sourced</a>. Consequently, you can have multiple alias files, or
828 you can have all aliases defined in your muttrc.
830 On the other hand, the <a class="link" href="#create-alias"><code class="literal"><create-alias></code></a>
831 function can use only one file, the one pointed to by the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a> variable (which is
832 <code class="literal">˜/.muttrc</code> by default). This file is not special either,
833 in the sense that Mutt will happily append aliases to any file, but in
834 order for the new aliases to take effect you need to explicitly <a class="link" href="#source" title="27. Reading initialization commands from another file">source</a> this file too.
837 </p><div class="example"><a id="ex-alias-external"></a><p class="title"><b>Example 3.6. Configuring external alias files</b></p><div class="example-contents"><pre class="screen">
838 source /usr/local/share/Mutt.aliases
839 source ~/.mail_aliases
840 set alias_file=~/.mail_aliases
841 </pre></div></div><br class="example-break" /><p>
842 To use aliases, you merely use the alias at any place in mutt where mutt
843 prompts for addresses, such as the <span class="emphasis"><em>To:</em></span> or <span class="emphasis"><em>Cc:</em></span> prompt. You can
844 also enter aliases in your editor at the appropriate headers if you have the
845 <a class="link" href="#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable set.
847 In addition, at the various address prompts, you can use the tab character
848 to expand a partial alias to the full alias. If there are multiple matches,
849 mutt will bring up a menu with the matching aliases. In order to be
850 presented with the full list of aliases, you must hit tab with out a partial
851 alias, such as at the beginning of the prompt or after a comma denoting
854 In the alias menu, you can select as many aliases as you want with the
855 <code class="literal">select-entry</code> key (default: <Return>), and use the
856 <span class="emphasis"><em>exit</em></span> key (default: q) to return to the address prompt.
857 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="bind"></a>5. Changing the default key bindings</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">bind</code>
858 <em class="replaceable"><code>map</code></em>
860 <em class="replaceable"><code>key</code></em>
862 <em class="replaceable"><code>function</code></em>
864 This command allows you to change the default key bindings (operation
865 invoked when pressing a key).
867 <span class="emphasis"><em>map</em></span> specifies in which menu the binding belongs. Multiple maps may
868 be specified by separating them with commas (no additional whitespace is
869 allowed). The currently defined maps are:
870 </p><a id="maps"></a><div class="variablelist"><dl><dt><span class="term">generic</span></dt><dd><p>
871 This is not a real menu, but is used as a fallback for all of the other
872 menus except for the pager and editor modes. If a key is not defined in
873 another menu, Mutt will look for a binding to use in this menu. This allows
874 you to bind a key to a certain function in multiple menus instead of having
875 multiple bind statements to accomplish the same task.
876 </p></dd><dt><span class="term">alias</span></dt><dd><p>
877 The alias menu is the list of your personal aliases as defined in your
878 muttrc. It is the mapping from a short alias name to the full email
879 address(es) of the recipient(s).
880 </p></dd><dt><span class="term">attach</span></dt><dd><p>
881 The attachment menu is used to access the attachments on received messages.
882 </p></dd><dt><span class="term">browser</span></dt><dd><p>
883 The browser is used for both browsing the local directory structure, and for
884 listing all of your incoming mailboxes.
885 </p></dd><dt><span class="term">editor</span></dt><dd><p>
886 The editor is the line-based editor the user enters text data.
887 </p></dd><dt><span class="term">index</span></dt><dd><p>
888 The index is the list of messages contained in a mailbox.
889 </p></dd><dt><span class="term">compose</span></dt><dd><p>
890 The compose menu is the screen used when sending a new message.
891 </p></dd><dt><span class="term">pager</span></dt><dd><p>
892 The pager is the mode used to display message/attachment data, and help
894 </p></dd><dt><span class="term">pgp</span></dt><dd><p>
895 The pgp menu is used to select the OpenPGP keys used to encrypt outgoing
897 </p></dd><dt><span class="term">smime</span></dt><dd><p>
898 The smime menu is used to select the OpenSSL certificates used to encrypt outgoing
900 </p></dd><dt><span class="term">postpone</span></dt><dd><p>
901 The postpone menu is similar to the index menu, except is used when
902 recalling a message the user was composing, but saved until later.
903 </p></dd><dt><span class="term">query</span></dt><dd><p>
904 The query menu is the browser for results returned by
905 <a class="link" href="#query-command" title="3.232. query_command">$query_command</a>.
906 </p></dd><dt><span class="term">mix</span></dt><dd><p>
907 The mixmaster screen is used to select remailer options for outgoing
908 messages (if Mutt is compiled with Mixmaster support).
909 </p></dd></dl></div><p>
910 <span class="emphasis"><em>key</em></span> is the key (or key sequence) you wish to bind. To specify a
911 control character, use the sequence <span class="emphasis"><em>\Cx</em></span>, where <span class="emphasis"><em>x</em></span> is the
912 letter of the control character (for example, to specify control-A use
913 “<span class="quote">\Ca</span>”). Note that the case of <span class="emphasis"><em>x</em></span> as well as <span class="emphasis"><em>\C</em></span> is
914 ignored, so that <span class="emphasis"><em>\CA</em></span>, <span class="emphasis"><em>\Ca</em></span>, <span class="emphasis"><em>\cA</em></span> and <span class="emphasis"><em>\ca</em></span> are all
915 equivalent. An alternative form is to specify the key as a three digit
916 octal number prefixed with a “<span class="quote">\</span>” (for example <span class="emphasis"><em>\177</em></span> is
917 equivalent to <span class="emphasis"><em>\c?</em></span>). In addition, <span class="emphasis"><em>key</em></span> may
918 be a symbolic name as shown in <a class="xref" href="#tab-key-names" title="Table 3.1. Symbolic key names">Table 3.1, “Symbolic key names”</a>.
919 </p><div class="table"><a id="tab-key-names"></a><p class="title"><b>Table 3.1. Symbolic key names</b></p><div class="table-contents"><table summary="Symbolic key names" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Symbolic name</th><th>Meaning</th></tr></thead><tbody><tr><td>\t</td><td>tab</td></tr><tr><td><tab></td><td>tab</td></tr><tr><td><backtab></td><td>backtab / shift-tab</td></tr><tr><td>\r</td><td>carriage return</td></tr><tr><td>\n</td><td>newline</td></tr><tr><td>\e</td><td>escape</td></tr><tr><td><esc></td><td>escape</td></tr><tr><td><up></td><td>up arrow</td></tr><tr><td><down></td><td>down arrow</td></tr><tr><td><left></td><td>left arrow</td></tr><tr><td><right></td><td>right arrow</td></tr><tr><td><pageup></td><td>Page Up</td></tr><tr><td><pagedown></td><td>Page Down</td></tr><tr><td><backspace></td><td>Backspace</td></tr><tr><td><delete></td><td>Delete</td></tr><tr><td><insert></td><td>Insert</td></tr><tr><td><enter></td><td>Enter</td></tr><tr><td><return></td><td>Return</td></tr><tr><td><home></td><td>Home</td></tr><tr><td><end></td><td>End</td></tr><tr><td><space></td><td>Space bar</td></tr><tr><td><f1></td><td>function key 1</td></tr><tr><td><f10></td><td>function key 10</td></tr></tbody></table></div></div><br class="table-break" /><p>
920 <span class="emphasis"><em>key</em></span> does not need to be enclosed in quotes unless it contains a
921 space (“<span class="quote"> </span>”) or semi-colon (“<span class="quote">;</span>”).
923 <span class="emphasis"><em>function</em></span> specifies which action to take when <span class="emphasis"><em>key</em></span> is pressed.
924 For a complete list of functions, see the <a class="link" href="#functions" title="4. Functions">reference</a>. The special function <code class="literal"><noop></code> unbinds the specified key
926 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="charset-hook"></a>6. Defining aliases for character sets </h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">charset-hook</code>
927 <em class="replaceable"><code>alias</code></em>
929 <em class="replaceable"><code>charset</code></em>
930 </p></div><div class="cmdsynopsis"><p><code class="command">iconv-hook</code>
931 <em class="replaceable"><code>charset</code></em>
933 <em class="replaceable"><code>local-charset</code></em>
935 The <code class="literal">charset-hook</code> command defines an alias for a character set.
936 This is useful to properly display messages which are tagged with a
937 character set name not known to mutt.
939 The <code class="literal">iconv-hook</code> command defines a system-specific name for a
940 character set. This is helpful when your systems character
941 conversion library insists on using strange, system-specific names
943 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="folder-hook"></a>7. Setting variables based upon mailbox</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">folder-hook</code>
944 <em class="replaceable"><code>[!]regexp</code></em>
946 <em class="replaceable"><code>command</code></em>
948 It is often desirable to change settings based on which mailbox you are
949 reading. The folder-hook command provides a method by which you can execute
950 any configuration command. <span class="emphasis"><em>regexp</em></span> is a regular expression specifying
951 in which mailboxes to execute <span class="emphasis"><em>command</em></span> before loading. If a mailbox
952 matches multiple folder-hook's, they are executed in the order given in the
954 </p><div class="note"><h3 class="title">Note</h3><p>
955 If you use the “<span class="quote">!</span>” shortcut for <a class="link" href="#spoolfile" title="3.277. spoolfile">$spoolfile</a> at the beginning of the pattern, you must place it
956 inside of double or single quotes in order to distinguish it from the
957 logical <span class="emphasis"><em>not</em></span> operator for the expression.
958 </p></div><div class="note"><h3 class="title">Note</h3><p>
959 Settings are <span class="emphasis"><em>not</em></span> restored when you leave the mailbox.
960 For example, a command action to perform is to change the sorting method
961 based upon the mailbox being read:
962 </p></div><pre class="screen">
963 folder-hook mutt set sort=threads
965 However, the sorting method is not restored to its previous value when
966 reading a different mailbox. To specify a <span class="emphasis"><em>default</em></span> command, use the
967 pattern “<span class="quote">.</span>” before other folder-hooks adjusting a value on a per-folder basis
968 because folder-hooks are evaluated in the order given in the configuration file.
969 The following example will set the <a class="link" href="#sort" title="3.271. sort">sort</a> variable
970 to <code class="literal">date-sent</code> for all folders but to <code class="literal">threads</code>
971 for all folders containing “<span class="quote">mutt</span>” in their name.
972 </p><div class="example"><a id="ex-folder-sorting"></a><p class="title"><b>Example 3.7. Setting sort method based on mailbox name</b></p><div class="example-contents"><pre class="screen">
973 folder-hook . set sort=date-sent
974 folder-hook mutt set sort=threads
975 </pre></div></div><br class="example-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="macro"></a>8. Keyboard macros</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">macro</code>
976 <em class="replaceable"><code>menu</code></em>
978 <em class="replaceable"><code>key</code></em>
980 <em class="replaceable"><code>sequence</code></em>
982 <em class="replaceable"><code>description</code></em>
984 Macros are useful when you would like a single key to perform a series of
985 actions. When you press <span class="emphasis"><em>key</em></span> in menu <span class="emphasis"><em>menu</em></span>, Mutt will behave as if
986 you had typed <span class="emphasis"><em>sequence</em></span>. So if you have a common sequence of commands
987 you type, you can create a macro to execute those commands with a single
990 <span class="emphasis"><em>menu</em></span> is the <a class="link" href="#maps">map</a> which the macro will be bound in.
991 Multiple maps may be specified by separating multiple menu arguments by
992 commas. Whitespace may not be used in between the menu arguments and the
993 commas separating them.
995 <span class="emphasis"><em>key</em></span> and <span class="emphasis"><em>sequence</em></span> are expanded by the same rules as the
996 <a class="link" href="#bind" title="5. Changing the default key bindings">key bindings</a> with some additions. The
997 first is that control characters in <span class="emphasis"><em>sequence</em></span> can also be specified
998 as <span class="emphasis"><em>^x</em></span>. In order to get a caret (“<span class="quote">^</span>”) you need to use
999 <span class="emphasis"><em>^^</em></span>. Secondly, to specify a certain key such as <span class="emphasis"><em>up</em></span>
1000 or to invoke a function directly, you can use the format
1001 <span class="emphasis"><em><key name></em></span> and <span class="emphasis"><em><function name></em></span>. For a listing of key
1002 names see the section on <a class="link" href="#bind" title="5. Changing the default key bindings">key bindings</a>. Functions
1003 are listed in the <a class="link" href="#functions" title="4. Functions">reference</a>.
1005 The advantage with using function names directly is that the macros will
1006 work regardless of the current key bindings, so they are not dependent on
1007 the user having particular key definitions. This makes them more robust
1008 and portable, and also facilitates defining of macros in files used by more
1009 than one user (e.g., the system Muttrc).
1011 Optionally you can specify a descriptive text after <span class="emphasis"><em>sequence</em></span>,
1012 which is shown in the help screens.
1013 </p><div class="note"><h3 class="title">Note</h3><p>
1014 Macro definitions (if any) listed in the help screen(s), are
1015 silently truncated at the screen width, and are not wrapped.
1016 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="color"></a>9. Using color and mono video attributes</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">color</code>
1017 <em class="replaceable"><code>object</code></em>
1019 <em class="replaceable"><code>foreground</code></em>
1021 <em class="replaceable"><code>background</code></em>
1022 </p></div><div class="cmdsynopsis"><p><code class="command">color</code> {
1023 <code class="option">header</code>
1025 <code class="option">body</code>
1027 <em class="replaceable"><code>foreground</code></em>
1029 <em class="replaceable"><code>background</code></em>
1031 <em class="replaceable"><code>regexp</code></em>
1032 </p></div><div class="cmdsynopsis"><p><code class="command">color</code>
1033 <code class="option">index</code>
1035 <em class="replaceable"><code>foreground</code></em>
1037 <em class="replaceable"><code>background</code></em>
1039 <em class="replaceable"><code>pattern</code></em>
1040 </p></div><div class="cmdsynopsis"><p><code class="command">uncolor</code>
1041 <code class="option">index</code>
1043 <em class="replaceable"><code>*</code></em>
1045 <em class="replaceable"><code>pattern</code></em>
1047 If your terminal supports color, you can spice up Mutt by creating your own
1048 color scheme. To define the color of an object (type of information), you
1049 must specify both a foreground color <span class="bold"><strong>and</strong></span> a background color (it is not
1050 possible to only specify one or the other).
1052 <span class="emphasis"><em>header</em></span> and <span class="emphasis"><em>body</em></span> match <span class="emphasis"><em>regexp</em></span>
1053 in the header/body of a message, <span class="emphasis"><em>index</em></span> matches <span class="emphasis"><em>pattern</em></span>
1054 (see <a class="xref" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">Section 2, “Patterns: Searching, Limiting and Tagging”</a>) in the message index.
1056 <span class="emphasis"><em>object</em></span> can be one of:
1057 </p><div class="itemizedlist"><ul type="disc"><li><p>attachment</p></li><li><p>bold (hiliting bold patterns in the body of messages)</p></li><li><p>error (error messages printed by Mutt)</p></li><li><p>hdrdefault (default color of the message header in the pager)</p></li><li><p>indicator (arrow or bar used to indicate the current item in a menu)</p></li><li><p>markers (the “<span class="quote">+</span>” markers at the beginning of wrapped lines in the pager)</p></li><li><p>message (informational messages)</p></li><li><p>normal</p></li><li><p>quoted (text matching <a class="link" href="#quote-regexp" title="3.235. quote_regexp">$quote_regexp</a> in the body of a message)</p></li><li><p>quoted1, quoted2, ..., quoted<span class="bold"><strong>N</strong></span> (higher levels of quoting)</p></li><li><p>search (hiliting of words in the pager)</p></li><li><p>signature</p></li><li><p>status (mode lines used to display info about the mailbox or message)</p></li><li><p>tilde (the “<span class="quote">˜</span>” used to pad blank lines in the pager)</p></li><li><p>tree (thread tree drawn in the message index and attachment menu)</p></li><li><p>underline (hiliting underlined patterns in the body of messages)</p></li></ul></div><p>
1058 <span class="emphasis"><em>foreground</em></span> and <span class="emphasis"><em>background</em></span> can be one of the following:
1059 </p><div class="itemizedlist"><ul type="disc"><li><p>white</p></li><li><p>black</p></li><li><p>green</p></li><li><p>magenta</p></li><li><p>blue</p></li><li><p>cyan</p></li><li><p>yellow</p></li><li><p>red</p></li><li><p>default</p></li><li><p>color<span class="emphasis"><em>x</em></span></p></li></ul></div><p>
1060 <span class="emphasis"><em>foreground</em></span> can optionally be prefixed with the keyword <code class="literal">bright</code> to make
1061 the foreground color boldfaced (e.g., <code class="literal">brightred</code>).
1063 If your terminal supports it, the special keyword <span class="emphasis"><em>default</em></span> can be
1064 used as a transparent color. The value <span class="emphasis"><em>brightdefault</em></span> is also valid.
1065 If Mutt is linked against the <span class="emphasis"><em>S-Lang</em></span> library, you also need to set
1066 the <span class="emphasis"><em>COLORFGBG</em></span> environment variable to the default colors of your
1067 terminal for this to work; for example (for Bourne-like shells):
1068 </p><pre class="screen">
1069 set COLORFGBG="green;black"
1071 </pre><div class="note"><h3 class="title">Note</h3><p>
1072 The <span class="emphasis"><em>S-Lang</em></span> library requires you to use the <span class="emphasis"><em>lightgray</em></span>
1073 and <span class="emphasis"><em>brown</em></span> keywords instead of <span class="emphasis"><em>white</em></span> and <span class="emphasis"><em>yellow</em></span> when
1074 setting this variable.
1075 </p></div><div class="note"><h3 class="title">Note</h3><p>
1076 The uncolor command can be applied to the index object only. It
1077 removes entries from the list. You <span class="bold"><strong>must</strong></span> specify the same pattern
1078 specified in the color command for it to be removed. The pattern “<span class="quote">*</span>” is
1079 a special token which means to clear the color index list of all entries.
1081 Mutt also recognizes the keywords <span class="emphasis"><em>color0</em></span>, <span class="emphasis"><em>color1</em></span>, …,
1082 <span class="emphasis"><em>color</em></span><span class="bold"><strong>N-1</strong></span> (<span class="bold"><strong>N</strong></span> being the number of colors supported
1083 by your terminal). This is useful when you remap the colors for your
1084 display (for example by changing the color associated with <span class="emphasis"><em>color2</em></span>
1085 for your xterm), since color names may then lose their normal meaning.
1087 If your terminal does not support color, it is still possible change the video
1088 attributes through the use of the “<span class="quote">mono</span>” command:
1089 </p><a id="mono"></a><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">mono</code>
1090 <em class="replaceable"><code>object</code></em>
1092 <em class="replaceable"><code>attribute</code></em>
1093 </p></div><div class="cmdsynopsis"><p><code class="command">mono</code> {
1094 <code class="option">header</code>
1096 <code class="option">body</code>
1098 <em class="replaceable"><code>attribute</code></em>
1100 <em class="replaceable"><code>regexp</code></em>
1101 </p></div><div class="cmdsynopsis"><p><code class="command">mono</code>
1102 <code class="option">index</code>
1104 <em class="replaceable"><code>attribute</code></em>
1106 <em class="replaceable"><code>pattern</code></em>
1107 </p></div><div class="cmdsynopsis"><p><code class="command">unmono</code>
1108 <code class="option">index</code>
1110 <em class="replaceable"><code>*</code></em>
1112 <em class="replaceable"><code>pattern</code></em>
1114 For <span class="emphasis"><em>object</em></span>, see the color command. <span class="emphasis"><em>attribute</em></span>
1115 can be one of the following:
1116 </p><div class="itemizedlist"><ul type="disc"><li><p>none</p></li><li><p>bold</p></li><li><p>underline</p></li><li><p>reverse</p></li><li><p>standout</p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ignore"></a>10. Message header display</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">ignore</code>
1117 <em class="replaceable"><code>pattern</code></em>
1119 <em class="replaceable"><code>pattern</code></em>
1120 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unignore</code> {
1121 <em class="replaceable"><code>*</code></em>
1123 <em class="replaceable"><code>pattern</code></em>
1125 Messages often have many header fields added by automatic processing systems,
1126 or which may not seem useful to display on the screen. This command allows
1127 you to specify header fields which you don't normally want to see in the pager.
1129 You do not need to specify the full header field name. For example,
1130 “<span class="quote">ignore content-</span>” will ignore all header fields that begin with the pattern
1131 “<span class="quote">content-</span>”. “<span class="quote">ignore *</span>” will ignore all headers.
1133 To remove a previously added token from the list, use the “<span class="quote">unignore</span>” command.
1134 The “<span class="quote">unignore</span>” command will make Mutt display headers with the given pattern.
1135 For example, if you do “<span class="quote">ignore x-</span>” it is possible to “<span class="quote">unignore x-mailer</span>”.
1137 “<span class="quote">unignore *</span>” will remove all tokens from the ignore list.
1140 </p><div class="example"><a id="ex-header-weeding"></a><p class="title"><b>Example 3.8. Header weeding</b></p><div class="example-contents"><pre class="screen">
1141 # Sven's draconian header weeding
1143 unignore from date subject to cc
1144 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
1146 </pre></div></div><br class="example-break" /><a id="hdr-order"></a><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">hdr_order</code>
1147 <em class="replaceable"><code>header</code></em>
1149 <em class="replaceable"><code>header</code></em>
1150 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unhdr_order</code> {
1151 <em class="replaceable"><code>*</code></em>
1153 <em class="replaceable"><code>header</code></em>
1155 With the <code class="literal">hdr_order</code> command you can specify an order in
1156 which mutt will attempt to present these headers to you when viewing messages.
1158 “<span class="quote">unhdr_order *</span>” will clear all previous headers from the order list,
1159 thus removing the header order effects set by the system-wide startup file.
1160 </p><div class="example"><a id="ex-hdr-order"></a><p class="title"><b>Example 3.9. Configuring header display order</b></p><div class="example-contents"><pre class="screen">
1161 hdr_order From Date: From: To: Cc: Subject:
1162 </pre></div></div><br class="example-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alternates"></a>11. Alternative addresses</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">alternates</code> [
1163 <code class="option">-group</code>
1164 <em class="replaceable"><code>name</code></em>
1166 <em class="replaceable"><code>regexp</code></em>
1168 <em class="replaceable"><code>regexp</code></em>
1169 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unalternates</code> [
1170 <code class="option">-group</code>
1171 <em class="replaceable"><code>name</code></em>
1173 <em class="replaceable"><code>*</code></em>
1175 <em class="replaceable"><code>regexp</code></em>
1177 With various functions, mutt will treat messages differently,
1178 depending on whether you sent them or whether you received them from
1179 someone else. For instance, when replying to a message that you
1180 sent to a different party, mutt will automatically suggest to send
1181 the response to the original message's recipients -- responding to
1182 yourself won't make much sense in many cases. (See <a class="link" href="#reply-to" title="3.243. reply_to">$reply_to</a>.)
1184 Many users receive e-mail under a number of different addresses. To
1185 fully use mutt's features here, the program must be able to
1186 recognize what e-mail addresses you receive mail under. That's the
1187 purpose of the <code class="literal">alternates</code> command: It takes a list of regular
1188 expressions, each of which can identify an address under which you
1191 As addresses are matched using regular expressions and not exact strict
1192 comparisons, you should make sure you specify your addresses as precise
1193 as possible to avoid mismatches. For example, if you specify:
1194 </p><pre class="screen">
1195 alternates user@example
1197 mutt will consider “<span class="quote"><code class="literal">some-user@example</code></span>” as
1198 being your address, too which may not be desired. As a solution, in such
1199 cases addresses should be specified as:
1200 </p><pre class="screen">
1201 alternates '^user@example$'
1203 The <code class="literal">-group</code> flag causes all of the subsequent regular expressions
1204 to be added to the named group.
1206 The <code class="literal">unalternates</code> command can be used to write exceptions to
1207 <code class="literal">alternates</code> patterns. If an address matches something in an
1208 <code class="literal">alternates</code> command, but you nonetheless do not think it is
1209 from you, you can list a more precise pattern under an <code class="literal">unalternates</code>
1212 To remove a regular expression from the <code class="literal">alternates</code> list, use the
1213 <code class="literal">unalternates</code> command with exactly the same <span class="emphasis"><em>regexp</em></span>.
1214 Likewise, if the <span class="emphasis"><em>regexp</em></span> for an <code class="literal">alternates</code> command matches
1215 an entry on the <code class="literal">unalternates</code> list, that <code class="literal">unalternates</code>
1216 entry will be removed. If the <span class="emphasis"><em>regexp</em></span> for <code class="literal">unalternates</code>
1217 is “<span class="quote">*</span>”, <span class="emphasis"><em>all entries</em></span> on <code class="literal">alternates</code> will be removed.
1218 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="lists"></a>12. Mailing lists</h2></div></div></div><a id="subscribe"></a><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">lists</code> [
1219 <code class="option">-group</code>
1220 <em class="replaceable"><code>name</code></em>
1222 <em class="replaceable"><code>regexp</code></em>
1224 <em class="replaceable"><code>regexp</code></em>
1225 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unlists</code> [
1226 <code class="option">-group</code>
1227 <em class="replaceable"><code>name</code></em>
1229 <em class="replaceable"><code>*</code></em>
1231 <em class="replaceable"><code>regexp</code></em>
1232 ... }</p></div><div class="cmdsynopsis"><p><code class="command">subscribe</code> [
1233 <code class="option">-group</code>
1234 <em class="replaceable"><code>name</code></em>
1236 <em class="replaceable"><code>regexp</code></em>
1238 <em class="replaceable"><code>regexp</code></em>
1239 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unsubscribe</code> [
1240 <code class="option">-group</code>
1241 <em class="replaceable"><code>name</code></em>
1243 <em class="replaceable"><code>*</code></em>
1245 <em class="replaceable"><code>regexp</code></em>
1247 Mutt has a few nice features for <a class="link" href="#using-lists" title="8. Handling Mailing Lists">handling mailing lists</a>. In order to take advantage of them, you must
1248 specify which addresses belong to mailing lists, and which mailing
1249 lists you are subscribed to. Once you have done this, the <a class="link" href="#list-reply"><code class="literal"><list-reply></code></a> function will work for all known lists.
1250 Additionally, when you send a message to a subscribed list, mutt will
1251 add a Mail-Followup-To header to tell other users' mail user agents
1252 not to send copies of replies to your personal address.
1253 </p><div class="note"><h3 class="title">Note</h3><p>
1254 The Mail-Followup-To header is a non-standard extension which is not
1255 supported by all mail user agents. Adding it is not bullet-proof against
1256 receiving personal CCs of list messages. Also note that the generation
1257 of the Mail-Followup-To header is controlled by the
1258 <a class="link" href="#followup-to" title="3.60. followup_to">$followup_to</a>
1259 configuration variable.
1261 More precisely, Mutt maintains lists of patterns for the addresses
1262 of known and subscribed mailing lists. Every subscribed mailing
1263 list is known. To mark a mailing list as known, use the “<span class="quote">lists</span>”
1264 command. To mark it as subscribed, use “<span class="quote">subscribe</span>”.
1266 You can use regular expressions with both commands. To mark all
1267 messages sent to a specific bug report's address on mutt's bug
1268 tracking system as list mail, for instance, you could say
1269 “<span class="quote">subscribe [0-9]*@bugs.guug.de</span>”. Often, it's sufficient to just
1270 give a portion of the list's e-mail address.
1272 Specify as much of the address as you need to to remove ambiguity. For
1273 example, if you've subscribed to the Mutt mailing list, you will receive mail
1274 addressed to <span class="emphasis"><em>mutt-users@mutt.org</em></span>. So, to tell Mutt
1275 that this is a mailing list, you could add “<span class="quote">lists mutt-users@</span>” to your
1276 initialization file. To tell mutt that you are subscribed to it,
1277 add “<span class="quote">subscribe mutt-users</span>” to your initialization file instead.
1278 If you also happen to get mail from someone whose address is
1279 <span class="emphasis"><em>mutt-users@example.com</em></span>, you could use
1280 “<span class="quote">lists ^mutt-users@mutt\\.org$</span>”
1281 or “<span class="quote">subscribe ^mutt-users@mutt\\.org$</span>” to
1282 match only mail from the actual list.
1284 The <code class="literal">-group</code> flag adds all of the subsequent regular expressions
1287 The “<span class="quote">unlists</span>” command is used to remove a token from the list of
1288 known and subscribed mailing-lists. Use “<span class="quote">unlists *</span>” to remove all
1291 To remove a mailing list from the list of subscribed mailing lists,
1292 but keep it on the list of known mailing lists, use “<span class="quote">unsubscribe</span>”.
1293 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mbox-hook"></a>13. Using Multiple spool mailboxes</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">mbox-hook</code>
1294 <em class="replaceable"><code>[!]pattern</code></em>
1296 <em class="replaceable"><code>mailbox</code></em>
1298 This command is used to move read messages from a specified mailbox to a
1299 different mailbox automatically when you quit or change folders.
1300 <span class="emphasis"><em>pattern</em></span> is a regular expression specifying the mailbox to treat as a
1301 “<span class="quote">spool</span>” mailbox and <span class="emphasis"><em>mailbox</em></span> specifies where mail should be saved when
1304 Unlike some of the other <span class="emphasis"><em>hook</em></span> commands, only the <span class="emphasis"><em>first</em></span> matching
1305 pattern is used (it is not possible to save read mail in more than a single
1307 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailboxes"></a>14. Monitoring incoming mail</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">mailboxes</code>
1308 <em class="replaceable"><code>mailbox</code></em>
1310 <em class="replaceable"><code>mailbox</code></em>
1311 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unmailboxes</code> {
1312 <em class="replaceable"><code>*</code></em>
1314 <em class="replaceable"><code>mailbox</code></em>
1316 This command specifies folders which can receive mail and
1317 which will be checked for new messages periodically.
1319 <span class="emphasis"><em>folder</em></span> can either be a local file or directory
1320 (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
1321 support, <span class="emphasis"><em>folder</em></span> can also be a POP/IMAP folder
1322 URL. The URL syntax is described in <a class="xref" href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a>,
1323 POP and IMAP are described in <a class="xref" href="#pop" title="3. POP3 Support">Section 3, “POP3 Support”</a> and <a class="xref" href="#imap" title="4. IMAP Support">Section 4, “IMAP Support”</a>
1326 Mutt provides a number of advanced features for handling (possibly many)
1327 folders and new mail within them, please refer to
1328 <a class="xref" href="#handling-folders" title="9. Handling multiple folders">Section 9, “Handling multiple folders”</a> for details (including in what
1329 situations and how often Mutt checks for new mail).
1331 The “<span class="quote">unmailboxes</span>” command is used to remove a token from the list
1332 of folders which receive mail. Use “<span class="quote">unmailboxes *</span>” to remove all
1334 </p><div class="note"><h3 class="title">Note</h3><p>
1335 The folders in the <code class="literal">mailboxes</code> command are resolved when
1336 the command is executed, so if these names contain <a class="link" href="#shortcuts" title="7. Mailbox Shortcuts">shortcut characters</a> (such as “<span class="quote">=</span>” and “<span class="quote">!</span>”), any variable
1337 definition that affects these characters (like <a class="link" href="#folder" title="3.58. folder">$folder</a> and <a class="link" href="#spoolfile" title="3.277. spoolfile">$spoolfile</a>)
1338 should be set before the <code class="literal">mailboxes</code> command. If
1339 none of these shorcuts are used, a local path should be absolute as
1340 otherwise mutt tries to find it relative to the directory
1341 from where mutt was started which may not always be desired.
1343 For Mbox and Mmdf folders, new mail is detected by comparing access and/or
1344 modification times of files: Mutt assumes a folder has new mail if it wasn't
1345 accessed after it was last modified. Utilities like <code class="literal">biff</code> or
1346 <code class="literal">frm</code> or any other program which accesses the mailbox might cause
1347 Mutt to never detect new mail for that mailbox if they do not properly reset the
1348 access time. Other possible causes of Mutt not detecting new mail in these folders
1349 are backup tools (updating access times) or filesystems mounted without
1350 access time update support.
1352 In cases where new mail detection for Mbox or Mmdf folders appears to be
1354 <a class="link" href="#check-mbox-size" title="3.24. check_mbox_size">$check_mbox_size</a>
1355 option can be used to make Mutt track and consult file sizes for new
1356 mail detection instead.
1357 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="my-hdr"></a>15. User defined headers</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">my_hdr</code>
1358 <em class="replaceable"><code>string</code></em>
1359 </p></div><div class="cmdsynopsis"><p><code class="command">unmy_hdr</code> {
1360 <em class="replaceable"><code>*</code></em>
1362 <em class="replaceable"><code>field</code></em>
1364 The <code class="literal">my_hdr</code> command allows you to create your own header
1365 fields which will be added to every message you send.
1367 For example, if you would like to add an “<span class="quote">Organization:</span>” header field to
1368 all of your outgoing messages, you can put the command
1369 </p><div class="example"><a id="ex-my-hdr"></a><p class="title"><b>Example 3.10. Defining custom headers</b></p><div class="example-contents"><pre class="screen">
1370 my_hdr Organization: A Really Big Company, Anytown, USA
1371 </pre></div></div><br class="example-break" /><p>
1372 in your <code class="literal">.muttrc</code>.
1373 </p><div class="note"><h3 class="title">Note</h3><p>
1374 Space characters are <span class="emphasis"><em>not</em></span> allowed between the keyword and
1375 the colon (“<span class="quote">:</span>”). The standard for electronic mail (RFC2822) says that
1376 space is illegal there, so Mutt enforces the rule.
1378 If you would like to add a header field to a single message, you should
1379 either set the <a class="link" href="#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable,
1380 or use the <code class="literal"><edit-headers></code> function (default: “<span class="quote">E</span>”) in the compose menu so
1381 that you can edit the header of your message along with the body.
1383 To remove user defined header fields, use the <code class="literal">unmy_hdr</code>
1384 command. You may specify an asterisk (“<span class="quote">*</span>”) to remove all header
1385 fields, or the fields to remove. For example, to remove all “<span class="quote">To</span>” and
1386 “<span class="quote">Cc</span>” header fields, you could use:
1387 </p><pre class="screen">
1389 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="save-hook"></a>16. Specify default save mailbox</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">save-hook</code>
1390 <em class="replaceable"><code>[!]pattern</code></em>
1392 <em class="replaceable"><code>mailbox</code></em>
1394 This command is used to override the default mailbox used when saving
1395 messages. <span class="emphasis"><em>mailbox</em></span> will be used as the default if the message
1396 matches <span class="emphasis"><em>pattern</em></span>, see <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for information
1397 on the exact format.
1399 To provide more flexibility and good defaults, Mutt applies the
1400 expandos of <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> to
1401 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1404 </p><div class="example"><a id="ex-save-hook-exando"></a><p class="title"><b>Example 3.11. Using %-expandos in <code class="literal">save-hook</code></b></p><div class="example-contents"><pre class="screen">
1405 # default: save all to ~/Mail/<author name>
1406 save-hook . ~/Mail/%F
1408 # save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins
1409 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
1411 # save from aol.com to $folder/spam
1412 save-hook aol\\.com$ +spam
1413 </pre></div></div><br class="example-break" /><p>
1414 Also see the <a class="link" href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a> command.
1415 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="fcc-hook"></a>17. Specify default Fcc: mailbox when composing</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">fcc-hook</code>
1416 <em class="replaceable"><code>[!]pattern</code></em>
1418 <em class="replaceable"><code>mailbox</code></em>
1420 This command is used to save outgoing mail in a mailbox other than
1421 <a class="link" href="#record" title="3.240. record">$record</a>. Mutt searches the initial list of
1422 message recipients for the first matching <span class="emphasis"><em>regexp</em></span> and uses <span class="emphasis"><em>mailbox</em></span>
1423 as the default Fcc: mailbox. If no match is found the message will be saved
1424 to <a class="link" href="#record" title="3.240. record">$record</a> mailbox.
1426 To provide more flexibility and good defaults, Mutt applies the
1427 expandos of <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> to
1428 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1430 See <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1432 Example: <code class="literal">fcc-hook [@.]aol\\.com$ +spammers</code>
1434 The above will save a copy of all messages going to the aol.com domain to
1435 the `+spammers' mailbox by default. Also see the <a class="link" href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a> command.
1436 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="fcc-save-hook"></a>18. Specify default save filename and default Fcc: mailbox at once</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">fcc-save-hook</code>
1437 <em class="replaceable"><code>[!]pattern</code></em>
1439 <em class="replaceable"><code>mailbox</code></em>
1441 This command is a shortcut, equivalent to doing both a <a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>
1442 and a <a class="link" href="#save-hook" title="16. Specify default save mailbox">save-hook</a> with its arguments,
1443 including %-expansion on <span class="emphasis"><em>mailbox</em></span> according
1444 to <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>.
1445 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="send-hook"></a>19. Change settings based upon message recipients</h2></div></div></div><a id="reply-hook"></a><a id="send2-hook"></a><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">reply-hook</code>
1446 <em class="replaceable"><code>[!]pattern</code></em>
1448 <em class="replaceable"><code>command</code></em>
1449 </p></div><div class="cmdsynopsis"><p><code class="command">send-hook</code>
1450 <em class="replaceable"><code>[!]pattern</code></em>
1452 <em class="replaceable"><code>command</code></em>
1453 </p></div><div class="cmdsynopsis"><p><code class="command">send2-hook</code>
1454 <em class="replaceable"><code>[!]pattern</code></em>
1456 <em class="replaceable"><code>command</code></em>
1458 These commands can be used to execute arbitrary configuration commands based
1459 upon recipients of the message. <span class="emphasis"><em>pattern</em></span> is used to match
1460 the message, see <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for details. <span class="emphasis"><em>command</em></span>
1461 is executed when <span class="emphasis"><em>pattern</em></span> matches.
1463 <code class="literal">reply-hook</code> is matched against the message you are <span class="emphasis"><em>replying to</em></span>,
1464 instead of the message you are <span class="emphasis"><em>sending</em></span>. <code class="literal">send-hook</code> is
1465 matched against all messages, both <span class="emphasis"><em>new</em></span>
1466 and <span class="emphasis"><em>replies</em></span>.
1467 </p><div class="note"><h3 class="title">Note</h3><p>
1468 <code class="literal">reply-hook</code>s are matched <span class="bold"><strong>before</strong></span> the <code class="literal">send-hook</code>, <span class="bold"><strong>regardless</strong></span>
1469 of the order specified in the user's configuration file.
1471 <code class="literal">send2-hook</code> is matched every time a message is changed, either
1472 by editing it, or by using the compose menu to change its recipients
1473 or subject. <code class="literal">send2-hook</code> is executed after <code class="literal">send-hook</code>, and
1474 can, e.g., be used to set parameters such as the <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> variable depending on the message's sender
1477 For each type of <code class="literal">send-hook</code> or <code class="literal">reply-hook</code>, when multiple matches
1478 occur, commands are executed in the order they are specified in the muttrc
1479 (for that type of hook).
1481 Example: <code class="literal">send-hook mutt "set mime_forward signature=''"</code>
1483 Another typical use for this command is to change the values of the
1484 <a class="link" href="#attribution" title="3.16. attribution">$attribution</a>, <a class="link" href="#signature" title="3.263. signature">$signature</a> and <a class="link" href="#locale" title="3.104. locale">$locale</a>
1485 variables in order to change the language of the attributions and
1486 signatures based upon the recipients.
1487 </p><div class="note"><h3 class="title">Note</h3><p>
1488 send-hook's are only executed once after getting the initial
1489 list of recipients. Adding a recipient after replying or editing the
1490 message will not cause any send-hook to be executed. Also note that
1491 <code class="literal">my_hdr</code> commands which modify recipient headers, or the message's
1492 subject, don't have any effect on the current message when executed
1494 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="message-hook"></a>20. Change settings before formatting a message</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">message-hook</code>
1495 <em class="replaceable"><code>[!]pattern</code></em>
1497 <em class="replaceable"><code>command</code></em>
1499 This command can be used to execute arbitrary configuration commands
1500 before viewing or formatting a message based upon information about the message.
1501 <span class="emphasis"><em>command</em></span> is executed if the <span class="emphasis"><em>pattern</em></span> matches the message to be
1502 displayed. When multiple matches occur, commands are executed in the order
1503 they are specified in the muttrc.
1505 See <a class="xref" href="#pattern-hook" title="4.1. Message Matching in Hooks">Message Matching in Hooks</a> for
1506 information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1509 </p><pre class="screen">
1510 message-hook ~A 'set pager=builtin'
1511 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
1512 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="crypt-hook"></a>21. Choosing the cryptographic key of the recipient</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">crypt-hook</code>
1513 <em class="replaceable"><code>pattern</code></em>
1515 <em class="replaceable"><code>keyid</code></em>
1517 When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a certain
1518 key with a given e-mail address automatically, either because the
1519 recipient's public key can't be deduced from the destination address,
1520 or because, for some reasons, you need to override the key Mutt would
1521 normally use. The <code class="literal">crypt-hook</code> command provides a
1522 method by which you can specify the ID of the public key to be used
1523 when encrypting messages to a certain recipient.
1525 The meaning of <span class="emphasis"><em>keyid</em></span> is to be taken broadly in this context: You
1526 can either put a numerical key ID here, an e-mail address, or even
1528 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="push"></a>22. Adding key sequences to the keyboard buffer</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">push</code>
1529 <em class="replaceable"><code>string</code></em>
1531 This command adds the named string to the keyboard buffer. The string may
1532 contain control characters, key names and function names like the sequence
1533 string in the <a class="link" href="#macro" title="8. Keyboard macros">macro</a> command. You may use it to
1534 automatically run a sequence of commands at startup, or when entering
1535 certain folders. For example, the following command will automatically
1536 collapse all threads when entering a folder:
1537 </p><div class="example"><a id="ex-folder-hook-push"></a><p class="title"><b>Example 3.12. Embedding <code class="literal">push</code> in <code class="literal">folder-hook</code></b></p><div class="example-contents"><pre class="screen">
1538 folder-hook . 'push <collapse-all>'
1539 </pre></div></div><br class="example-break" /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="exec"></a>23. Executing functions</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">exec</code>
1540 <em class="replaceable"><code>function</code></em>
1542 <em class="replaceable"><code>function</code></em>
1544 This command can be used to execute any function. Functions are
1545 listed in the <a class="link" href="#functions" title="4. Functions">function reference</a>.
1546 “<span class="quote">exec function</span>” is equivalent to “<span class="quote">push <function></span>”.
1547 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="score-command"></a>24. Message Scoring</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">score</code>
1548 <em class="replaceable"><code>pattern</code></em>
1550 <em class="replaceable"><code>value</code></em>
1551 </p></div><div class="cmdsynopsis"><p><code class="command">unscore</code> {
1552 <em class="replaceable"><code>*</code></em>
1554 <em class="replaceable"><code>pattern</code></em>
1556 The <code class="literal">score</code> commands adds <span class="emphasis"><em>value</em></span> to a message's score if <span class="emphasis"><em>pattern</em></span>
1557 matches it. <span class="emphasis"><em>pattern</em></span> is a string in the format described in the <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> section (note: For efficiency reasons, patterns
1558 which scan information not available in the index, such as <code class="literal">˜b</code>,
1559 <code class="literal">˜B</code> or <code class="literal">˜h</code>, may not be used). <span class="emphasis"><em>value</em></span> is a
1560 positive or negative integer. A message's final score is the sum total of all
1561 matching <code class="literal">score</code> entries. However, you may optionally prefix <span class="emphasis"><em>value</em></span> with
1562 an equal sign (=) to cause evaluation to stop at a particular entry if there is
1563 a match. Negative final scores are rounded up to 0.
1565 The <code class="literal">unscore</code> command removes score entries from the list. You <span class="bold"><strong>must</strong></span>
1566 specify the same pattern specified in the <code class="literal">score</code> command for it to be
1567 removed. The pattern “<span class="quote">*</span>” is a special token which means to clear the list
1568 of all score entries.
1569 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="spam"></a>25. Spam detection</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">spam</code>
1570 <em class="replaceable"><code>pattern</code></em>
1572 <em class="replaceable"><code>format</code></em>
1573 </p></div><div class="cmdsynopsis"><p><code class="command">nospam</code> {
1574 <em class="replaceable"><code>*</code></em>
1576 <em class="replaceable"><code>pattern</code></em>
1578 Mutt has generalized support for external spam-scoring filters.
1579 By defining your spam patterns with the <code class="literal">spam</code> and <code class="literal">nospam</code>
1580 commands, you can <span class="emphasis"><em>limit</em></span>, <span class="emphasis"><em>search</em></span>, and <span class="emphasis"><em>sort</em></span> your
1581 mail based on its spam attributes, as determined by the external
1582 filter. You also can display the spam attributes in your index
1583 display using the <code class="literal">%H</code> selector in the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> variable. (Tip: try <code class="literal">%?H?[%H] ?</code>
1584 to display spam tags only when they are defined for a given message.)
1586 Your first step is to define your external filter's spam patterns using
1587 the <code class="literal">spam</code> command. <span class="emphasis"><em>pattern</em></span> should be a regular expression
1588 that matches a header in a mail message. If any message in the mailbox
1589 matches this regular expression, it will receive a “<span class="quote">spam tag</span>” or
1590 “<span class="quote">spam attribute</span>” (unless it also matches a <code class="literal">nospam</code> pattern -- see
1591 below.) The appearance of this attribute is entirely up to you, and is
1592 governed by the <span class="emphasis"><em>format</em></span> parameter. <span class="emphasis"><em>format</em></span> can be any static
1593 text, but it also can include back-references from the <span class="emphasis"><em>pattern</em></span>
1594 expression. (A regular expression “<span class="quote">back-reference</span>” refers to a
1595 sub-expression contained within parentheses.) <code class="literal">%1</code> is replaced with
1596 the first back-reference in the regex, <code class="literal">%2</code> with the second, etc.
1598 If you're using multiple spam filters, a message can have more than
1599 one spam-related header. You can define <code class="literal">spam</code> patterns for each
1600 filter you use. If a message matches two or more of these patterns, and
1601 the $spam_separator variable is set to a string, then the
1602 message's spam tag will consist of all the <span class="emphasis"><em>format</em></span> strings joined
1603 together, with the value of $spam_separator separating
1606 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
1607 define these spam settings:
1608 </p><div class="example"><a id="ex-spam"></a><p class="title"><b>Example 3.13. Configuring spam detection</b></p><div class="example-contents"><pre class="screen">
1609 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
1610 spam "X-Spam-Status: Yes" "90+/SA"
1611 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
1612 set spam_separator=", "
1613 </pre></div></div><br class="example-break" /><p>
1614 If I then received a message that DCC registered with “<span class="quote">many</span>” hits
1615 under the “<span class="quote">Fuz2</span>” checksum, and that PureMessage registered with a
1616 97% probability of being spam, that message's spam tag would read
1617 <code class="literal">90+/DCC-Fuz2, 97/PM</code>. (The four characters before “<span class="quote">=many</span>” in a
1618 DCC report indicate the checksum used -- in this case, “<span class="quote">Fuz2</span>”.)
1620 If the $spam_separator variable is unset, then each
1621 spam pattern match supersedes the previous one. Instead of getting
1622 joined <span class="emphasis"><em>format</em></span> strings, you'll get only the last one to match.
1624 The spam tag is what will be displayed in the index when you use
1625 <code class="literal">%H</code> in the <code class="literal">$index_format</code> variable. It's also the
1626 string that the <code class="literal">˜H</code> pattern-matching expression matches against for
1627 <code class="literal"><search></code> and <code class="literal"><limit></code> functions. And it's what sorting by spam
1628 attribute will use as a sort key.
1630 That's a pretty complicated example, and most people's actual
1631 environments will have only one spam filter. The simpler your
1632 configuration, the more effective mutt can be, especially when it comes
1635 Generally, when you sort by spam tag, mutt will sort <span class="emphasis"><em>lexically</em></span> --
1636 that is, by ordering strings alphanumerically. However, if a spam tag
1637 begins with a number, mutt will sort numerically first, and lexically
1638 only when two numbers are equal in value. (This is like UNIX's
1639 <code class="literal">sort -n</code>.) A message with no spam attributes at all -- that is, one
1640 that didn't match <span class="emphasis"><em>any</em></span> of your <code class="literal">spam</code> patterns -- is sorted at
1641 lowest priority. Numbers are sorted next, beginning with 0 and ranging
1642 upward. Finally, non-numeric strings are sorted, with “<span class="quote">a</span>” taking lower
1643 priority than “<span class="quote">z</span>”. Clearly, in general, sorting by spam tags is most
1644 effective when you can coerce your filter to give you a raw number. But
1645 in case you can't, mutt can still do something useful.
1647 The <code class="literal">nospam</code> command can be used to write exceptions to <code class="literal">spam</code>
1648 patterns. If a header pattern matches something in a <code class="literal">spam</code> command,
1649 but you nonetheless do not want it to receive a spam tag, you can list a
1650 more precise pattern under a <code class="literal">nospam</code> command.
1652 If the <span class="emphasis"><em>pattern</em></span> given to <code class="literal">nospam</code> is exactly the same as the
1653 <span class="emphasis"><em>pattern</em></span> on an existing <code class="literal">spam</code> list entry, the effect will be to
1654 remove the entry from the spam list, instead of adding an exception.
1655 Likewise, if the <span class="emphasis"><em>pattern</em></span> for a <code class="literal">spam</code> command matches an entry
1656 on the <code class="literal">nospam</code> list, that <code class="literal">nospam</code> entry will be removed. If the
1657 <span class="emphasis"><em>pattern</em></span> for <code class="literal">nospam</code> is “<span class="quote">*</span>”, <span class="emphasis"><em>all entries on both lists</em></span>
1658 will be removed. This might be the default action if you use <code class="literal">spam</code>
1659 and <code class="literal">nospam</code> in conjunction with a <code class="literal">folder-hook</code>.
1661 You can have as many <code class="literal">spam</code> or <code class="literal">nospam</code> commands as you like.
1662 You can even do your own primitive spam detection within mutt -- for
1663 example, if you consider all mail from <code class="literal">MAILER-DAEMON</code> to be spam,
1664 you can use a <code class="literal">spam</code> command like this:
1665 </p><pre class="screen">
1666 spam "^From: .*MAILER-DAEMON" "999"
1667 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="set"></a>26. Setting and Querying Variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="set-commands"></a>26.1. Commands</h3></div></div></div><p>
1668 The following commands are available to manipulate and query variables:
1669 </p><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">set</code> {
1670 [ <code class="option">no</code> | <code class="option">inv</code> ]
1671 <em class="replaceable"><code>variable</code></em>
1673 <em class="replaceable"><code>variable=value</code></em>
1674 } [...]</p></div><div class="cmdsynopsis"><p><code class="command">toggle</code>
1675 <em class="replaceable"><code>variable</code></em>
1677 <em class="replaceable"><code>variable</code></em>
1678 ...]</p></div><div class="cmdsynopsis"><p><code class="command">unset</code>
1679 <em class="replaceable"><code>variable</code></em>
1681 <em class="replaceable"><code>variable</code></em>
1682 ...]</p></div><div class="cmdsynopsis"><p><code class="command">reset</code>
1683 <em class="replaceable"><code>variable</code></em>
1685 <em class="replaceable"><code>variable</code></em>
1687 This command is used to set (and unset) <a class="link" href="#variables" title="3. Configuration variables">configuration variables</a>. There are four basic types of variables:
1688 boolean, number, string and quadoption. <span class="emphasis"><em>boolean</em></span> variables can be
1689 <span class="emphasis"><em>set</em></span> (true) or <span class="emphasis"><em>unset</em></span> (false). <span class="emphasis"><em>number</em></span> variables can be
1690 assigned a positive integer value.
1691 <span class="emphasis"><em>string</em></span> variables consist of any number of printable characters and
1692 must be enclosed in quotes if they contain spaces or tabs. You
1693 may also use the escape sequences “<span class="quote">\n</span>” and “<span class="quote">\t</span>” for newline and tab, respectively.
1694 <span class="emphasis"><em>quadoption</em></span> variables are used to control whether or not to be prompted
1695 for certain actions, or to specify a default action. A value of <span class="emphasis"><em>yes</em></span>
1696 will cause the action to be carried out automatically as if you had answered
1697 yes to the question. Similarly, a value of <span class="emphasis"><em>no</em></span> will cause the
1698 action to be carried out as if you had answered “<span class="quote">no.</span>” A value of
1699 <span class="emphasis"><em>ask-yes</em></span> will cause a prompt with a default answer of “<span class="quote">yes</span>” and
1700 <span class="emphasis"><em>ask-no</em></span> will provide a default answer of “<span class="quote">no.</span>”
1702 Prefixing a variable with “<span class="quote">no</span>” will unset it. Example: <code class="literal">set noaskbcc</code>.
1704 For <span class="emphasis"><em>boolean</em></span> variables, you may optionally prefix the variable name with
1705 <code class="literal">inv</code> to toggle the value (on or off). This is useful when writing
1706 macros. Example: <code class="literal">set invsmart_wrap</code>.
1708 The <code class="literal">toggle</code> command automatically prepends the <code class="literal">inv</code> prefix to all
1709 specified variables.
1711 The <code class="literal">unset</code> command automatically prepends the <code class="literal">no</code> prefix to all
1712 specified variables.
1714 Using the <code class="literal"><enter-command></code> function in the <span class="emphasis"><em>index</em></span> menu, you can query the
1715 value of a variable by prefixing the name of the variable with a question
1717 </p><pre class="screen">
1720 The question mark is actually only required for boolean and quadoption
1723 The <code class="literal">reset</code> command resets all given variables to the compile time
1724 defaults (hopefully mentioned in this manual). If you use the command
1725 <code class="literal">set</code> and prefix the variable with “<span class="quote">&</span>” this has the same
1726 behavior as the reset command.
1728 With the <code class="literal">reset</code> command there exists the special variable “<span class="quote">all</span>”,
1729 which allows you to reset all variables to their system defaults.
1730 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="set-myvar"></a>26.2. User-defined variables</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-intro"></a>26.2.1. Introduction</h4></div></div></div><p>
1731 Along with the variables listed in the
1732 <a class="link" href="#variables" title="3. Configuration variables">Configuration variables</a> section, mutt
1733 supports user-defined variables with names starting
1734 with <code class="literal">my_</code> as in, for
1735 example, <code class="literal">my_cfgdir</code>.
1737 The <code class="literal">set</code> command either creates a
1738 custom <code class="literal">my_</code> variable or changes its
1739 value if it does exist already. The <code class="literal">unset</code> and <code class="literal">reset</code>
1740 commands remove the variable entirely.
1742 Since user-defined variables are expanded in the same way that
1743 environment variables are (except for
1744 the <a class="link" href="#shell-escape">shell-escape</a> command and
1745 backtick expansion), this feature can be used to make configuration
1746 files more readable.
1747 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-examples"></a>26.2.2. Examples</h4></div></div></div><p>
1748 The following example defines and uses the variable <code class="literal">my_cfgdir</code>
1749 to abbreviate the calls of the <a class="link" href="#source" title="27. Reading initialization commands from another file">source</a> command:
1750 </p><div class="example"><a id="ex-myvar1"></a><p class="title"><b>Example 3.14. Using user-defined variables for config file readability</b></p><div class="example-contents"><pre class="screen">
1751 set my_cfgdir = $HOME/mutt/config
1753 source $my_cfgdir/hooks
1754 source $my_cfgdir/macros
1755 # more source commands...
1756 </pre></div></div><br class="example-break" /><p>
1757 A custom variable can also be used in macros to backup the current value
1758 of another variable. In the following example, the value of the
1759 <a class="link" href="#delete" title="3.42. delete">$delete</a> is changed temporarily
1760 while its original value is saved as <code class="literal">my_delete</code>.
1761 After the macro has executed all commands, the original value of <a class="link" href="#delete" title="3.42. delete">$delete</a> is restored.
1762 </p><div class="example"><a id="ex-myvar2"></a><p class="title"><b>Example 3.15. Using user-defined variables for backing up other config option values</b></p><div class="example-contents"><pre class="screen">
1764 <enter-command>set my_delete=$delete<enter>\
1765 <enter-command>set delete=yes<enter>\
1767 <enter-command>set delete=$my_delete<enter>'
1768 </pre></div></div><br class="example-break" /><p>
1769 Since mutt expands such values already when parsing the configuration
1770 file(s), the value of <code class="literal">$my_delete</code> in the
1771 last example would be the value of <code class="literal">$delete</code> exactly
1772 as it was at that point during parsing the configuration file. If
1773 another statement would change the value for <code class="literal">$delete</code>
1774 later in the same or another file, it would have no effect on
1775 <code class="literal">$my_delete</code>. However, the expansion can
1776 be deferred to runtime, as shown in the next example, when escaping the
1778 </p><div class="example"><a id="ex-myvar3"></a><p class="title"><b>Example 3.16. Deferring user-defined variable expansion to runtime</b></p><div class="example-contents"><pre class="screen">
1779 macro pager <PageDown> "\
1780 <enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
1782 <enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
1783 <enter-command> unset my_old_pager_stop<Enter>"
1784 </pre></div></div><br class="example-break" /><p>
1785 Note that there is a space
1786 between <code class="literal"><enter-command></code> and
1787 the <code class="literal">set</code> configuration command, preventing mutt from
1788 recording the macro's commands into its history.
1789 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="source"></a>27. Reading initialization commands from another file</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">source</code>
1790 <em class="replaceable"><code>filename</code></em>
1792 This command allows the inclusion of initialization commands
1793 from other files. For example, I place all of my aliases in
1794 <code class="literal">˜/.mail_aliases</code> so that I can make my
1795 <code class="literal">˜/.muttrc</code> readable and keep my aliases private.
1797 If the filename begins with a tilde (“<span class="quote">˜</span>”), it will be expanded to the
1798 path of your home directory.
1800 If the filename ends with a vertical bar (|), then <span class="emphasis"><em>filename</em></span> is
1801 considered to be an executable program from which to read input (eg.
1802 <code class="literal">source ˜/bin/myscript|</code>).
1803 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="unhook"></a>28. Removing hooks</h2></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">unhook</code> {
1804 <em class="replaceable"><code>*</code></em>
1806 <em class="replaceable"><code>hook-type</code></em>
1808 This command permits you to flush hooks you have previously defined.
1809 You can either remove all hooks by giving the “<span class="quote">*</span>” character as an
1810 argument, or you can remove all hooks of a specific type by saying
1811 something like <code class="literal">unhook send-hook</code>.
1812 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="formatstrings"></a>29. Format Strings</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-basics"></a>29.1. Basic usage</h3></div></div></div><p>
1813 Format strings are a general concept you'll find in several locations
1814 through the mutt configuration, especially in the
1815 <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>,
1816 <a class="link" href="#pager-format" title="3.140. pager_format">$pager_format</a>,
1817 <a class="link" href="#status-format" title="3.279. status_format">$status_format</a>,
1818 and other “<span class="quote">*_format</span>” variables. These can be very straightforward,
1819 and it's quite possible you already know how to use them.
1821 The most basic format string element is a percent symbol followed
1822 by another character. For example, <code class="literal">%s</code>
1823 represents a message's Subject: header in the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> variable. The
1824 “<span class="quote">expandos</span>” available are documented with each format variable, but
1825 there are general modifiers available with all formatting expandos,
1826 too. Those are our concern here.
1828 Some of the modifiers are borrowed right out of C (though you might
1829 know them from Perl, Python, shell, or another language). These are
1830 the [-]m.n modifiers, as in <code class="literal">%-12.12s</code>. As with
1831 such programming languages, these modifiers allow you to specify the
1832 minimum and maximum size of the resulting string, as well as its
1833 justification. If the “<span class="quote">-</span>” sign follows the percent, the string will
1834 be left-justified instead of right-justified. If there's a number
1835 immediately following that, it's the minimum amount of space the
1836 formatted string will occupy -- if it's naturally smaller than that, it
1837 will be padded out with spaces. If a decimal point and another number
1838 follow, that's the maximum space allowable -- the string will not be
1839 permitted to exceed that width, no matter its natural size. Each of
1840 these three elements is optional, so that all these are legal format
1842 <code class="literal">%-12s</code>
1843 <code class="literal">%4c</code>
1844 <code class="literal">%.15F</code>
1845 <code class="literal">%-12.15L</code>
1847 Mutt adds some other modifiers to format strings. If you use an equals
1848 symbol (<code class="literal">=</code>) as a numeric prefix (like the minus
1849 above), it will force the string to be centered within its minimum
1850 space range. For example, <code class="literal">%=14y</code> will reserve 14
1851 characters for the %y expansion -- that's the X-Label: header, in
1852 <code class="literal">$index_format</code>. If the expansion
1853 results in a string less than 14 characters, it will be centered in a
1854 14-character space. If the X-Label for a message were "test", that
1855 expansion would look like “<span class="quote"> test </span>”.
1857 There are two very little-known modifiers that affect the way that an
1858 expando is replaced. If there is an underline (“<span class="quote">_</span>”) character
1859 between any format modifiers (as above) and the expando letter, it will
1860 expands in all lower case. And if you use a colon (“<span class="quote">:</span>”), it will
1861 replace all decimal points with underlines.
1862 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-filters"></a>29.2. Filters</h3></div></div></div><p>
1863 Any format string ending in a vertical bar (“<span class="quote">|</span>”) will be
1864 expanded and piped through the first word in the string, using spaces
1865 as separator. The string returned will be used for display.
1866 If the returned string ends in %, it will be passed through
1867 the formatter a second time. This allows the filter to generate a
1868 replacement format string including % expandos.
1870 All % expandos in a format string are expanded before the script
1872 </p><div class="example"><a id="ex-fmtpipe"></a><p class="title"><b>Example 3.17. Using external filters in format strings</b></p><div class="example-contents"><pre class="screen">
1873 set status_format="script.sh '%r %f (%L)'|"
1874 </pre></div></div><br class="example-break" /><p>
1875 will make mutt expand <code class="literal">%r</code>,
1876 <code class="literal">%f</code> and <code class="literal">%L</code>
1877 before calling the script. The example also shows that arguments can be
1878 quoted: the script will receive the expanded string between the single quotes
1879 as the only argument.
1881 A practical example is the <code class="literal">mutt_xtitle</code>
1882 script installed in the <code class="literal">samples</code>
1883 subdirectory of the mutt documentation: it can be used as filter for
1884 <code class="literal">$status_format</code> to set the current
1885 terminal's title, if supported.
1886 </p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="advancedusage"></a>Chapter 4. Advanced Usage</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#regexp">1. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">2. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#patterns-modifier">2.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#simple-patterns">2.2. Simple Patterns</a></span></dt><dt><span class="sect2"><a href="#complex-patterns">2.3. Complex Patterns</a></span></dt><dt><span class="sect2"><a href="#date-patterns">2.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">3. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">4. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">4.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">5. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">6. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">7. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">8. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#handling-folders">9. Handling multiple folders</a></span></dt><dt><span class="sect1"><a href="#editing-threads">10. Editing threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#link-threads">10.1. Linking threads</a></span></dt><dt><span class="sect2"><a href="#break-threads">10.2. Breaking threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">11. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">12. Start a WWW Browser on URLs</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="regexp"></a>1. Regular Expressions</h2></div></div></div><p>
1887 All string patterns in Mutt including those in more complex
1888 <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> must be specified
1889 using regular expressions (regexp) in the “<span class="quote">POSIX extended</span>” syntax (which
1890 is more or less the syntax used by egrep and GNU awk). For your
1891 convenience, we have included below a brief description of this syntax.
1893 The search is case sensitive if the pattern contains at least one upper
1894 case letter, and case insensitive otherwise.
1895 </p><div class="note"><h3 class="title">Note</h3><p>
1896 Note that “<span class="quote">\</span>”
1897 must be quoted if used for a regular expression in an initialization
1898 command: “<span class="quote">\\</span>”.
1900 A regular expression is a pattern that describes a set of strings.
1901 Regular expressions are constructed analogously to arithmetic
1902 expressions, by using various operators to combine smaller expressions.
1903 </p><div class="note"><h3 class="title">Note</h3><p>
1904 Note that the regular expression can be enclosed/delimited by either "
1905 or ' which is useful if the regular expression includes a white-space
1906 character. See <a class="xref" href="#muttrc-syntax" title="2. Syntax of Initialization Files">Syntax of Initialization Files</a>
1907 for more information on " and ' delimiter processing. To match a
1908 literal " or ' you must preface it with \ (backslash).
1910 The fundamental building blocks are the regular expressions that match
1911 a single character. Most characters, including all letters and digits,
1912 are regular expressions that match themselves. Any metacharacter with
1913 special meaning may be quoted by preceding it with a backslash.
1915 The period “<span class="quote">.</span>” matches any single character. The caret “<span class="quote">^</span>” and
1916 the dollar sign “<span class="quote">$</span>” are metacharacters that respectively match
1917 the empty string at the beginning and end of a line.
1919 A list of characters enclosed by “<span class="quote">[</span>” and “<span class="quote">]</span>” matches any
1920 single character in that list; if the first character of the list
1921 is a caret “<span class="quote">^</span>” then it matches any character <span class="bold"><strong>not</strong></span> in the
1922 list. For example, the regular expression <span class="bold"><strong>[0123456789]</strong></span>
1923 matches any single digit. A range of ASCII characters may be specified
1924 by giving the first and last characters, separated by a hyphen
1925 “<span class="quote">-</span>”. Most metacharacters lose their special meaning inside
1926 lists. To include a literal “<span class="quote">]</span>” place it first in the list.
1927 Similarly, to include a literal “<span class="quote">^</span>” place it anywhere but first.
1928 Finally, to include a literal hyphen “<span class="quote">-</span>” place it last.
1930 Certain named classes of characters are predefined. Character classes
1931 consist of “<span class="quote">[:</span>”, a keyword denoting the class, and “<span class="quote">:]</span>”.
1932 The following classes are defined by the POSIX standard in
1933 <a class="xref" href="#posix-regex-char-classes" title="Table 4.1. POSIX regular expression character classes">Table 4.1, “POSIX regular expression character classes”</a>
1934 </p><div class="table"><a id="posix-regex-char-classes"></a><p class="title"><b>Table 4.1. POSIX regular expression character classes</b></p><div class="table-contents"><table summary="POSIX regular expression character classes" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Character class</th><th>Description</th></tr></thead><tbody><tr><td>[:alnum:]</td><td>Alphanumeric characters</td></tr><tr><td>[:alpha:]</td><td>Alphabetic characters</td></tr><tr><td>[:blank:]</td><td>Space or tab characters</td></tr><tr><td>[:cntrl:]</td><td>Control characters</td></tr><tr><td>[:digit:]</td><td>Numeric characters</td></tr><tr><td>[:graph:]</td><td>Characters that are both printable and visible. (A space is printable, but not visible, while an “<span class="quote">a</span>” is both)</td></tr><tr><td>[:lower:]</td><td>Lower-case alphabetic characters</td></tr><tr><td>[:print:]</td><td>Printable characters (characters that are not control characters)</td></tr><tr><td>[:punct:]</td><td>Punctuation characters (characters that are not letter, digits, control characters, or space characters)</td></tr><tr><td>[:space:]</td><td>Space characters (such as space, tab and formfeed, to name a few)</td></tr><tr><td>[:upper:]</td><td>Upper-case alphabetic characters</td></tr><tr><td>[:xdigit:]</td><td>Characters that are hexadecimal digits</td></tr></tbody></table></div></div><br class="table-break" /><p>
1935 A character class is only valid in a regular expression inside the
1936 brackets of a character list.
1937 </p><div class="note"><h3 class="title">Note</h3><p>
1938 Note that the brackets in these
1939 class names are part of the symbolic names, and must be included
1940 in addition to the brackets delimiting the bracket list. For
1941 example, <span class="bold"><strong>[[:digit:]]</strong></span> is equivalent to
1942 <span class="bold"><strong>[0-9]</strong></span>.
1944 Two additional special sequences can appear in character lists. These
1945 apply to non-ASCII character sets, which can have single symbols (called
1946 collating elements) that are represented with more than one character,
1947 as well as several characters that are equivalent for collating or
1949 </p><div class="variablelist"><dl><dt><span class="term">Collating Symbols</span></dt><dd><p>
1950 A collating symbol is a multi-character collating element enclosed in
1951 “<span class="quote">[.</span>” and “<span class="quote">.]</span>”. For example, if “<span class="quote">ch</span>” is a collating
1952 element, then <span class="bold"><strong>[[.ch.]]</strong></span> is a regexp that matches
1953 this collating element, while <span class="bold"><strong>[ch]</strong></span> is a regexp that
1954 matches either “<span class="quote">c</span>” or “<span class="quote">h</span>”.
1955 </p></dd><dt><span class="term">Equivalence Classes</span></dt><dd><p>
1956 An equivalence class is a locale-specific name for a list of
1957 characters that are equivalent. The name is enclosed in “<span class="quote">[=</span>”
1958 and “<span class="quote">=]</span>”. For example, the name “<span class="quote">e</span>” might be used to
1959 represent all of “<span class="quote">è</span>” “<span class="quote">é</span>” and “<span class="quote">e</span>”. In this case,
1960 <span class="bold"><strong>[[=e=]]</strong></span> is a regexp that matches any of
1961 “<span class="quote">è</span>”, “<span class="quote">é</span>” and “<span class="quote">e</span>”.
1962 </p></dd></dl></div><p>
1963 A regular expression matching a single character may be followed by one
1964 of several repetition operators described in <a class="xref" href="#regex-repeat" title="Table 4.2. Regular expression repetition operators">Table 4.2, “Regular expression repetition operators”</a>.
1965 </p><div class="table"><a id="regex-repeat"></a><p class="title"><b>Table 4.2. Regular expression repetition operators</b></p><div class="table-contents"><table summary="Regular expression repetition operators" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Operator</th><th>Description</th></tr></thead><tbody><tr><td>?</td><td>The preceding item is optional and matched at most once</td></tr><tr><td>*</td><td>The preceding item will be matched zero or more times</td></tr><tr><td>+</td><td>The preceding item will be matched one or more times</td></tr><tr><td>{n}</td><td>The preceding item is matched exactly <span class="emphasis"><em>n</em></span> times</td></tr><tr><td>{n,}</td><td>The preceding item is matched <span class="emphasis"><em>n</em></span> or more times</td></tr><tr><td>{,m}</td><td>The preceding item is matched at most <span class="emphasis"><em>m</em></span> times</td></tr><tr><td>{n,m}</td><td>The preceding item is matched at least <span class="emphasis"><em>n</em></span> times, but no more than <span class="emphasis"><em>m</em></span> times</td></tr></tbody></table></div></div><br class="table-break" /><p>
1966 Two regular expressions may be concatenated; the resulting regular
1967 expression matches any string formed by concatenating two substrings
1968 that respectively match the concatenated subexpressions.
1970 Two regular expressions may be joined by the infix operator “<span class="quote">|</span>”;
1971 the resulting regular expression matches any string matching either
1974 Repetition takes precedence over concatenation, which in turn takes
1975 precedence over alternation. A whole subexpression may be enclosed in
1976 parentheses to override these precedence rules.
1977 </p><div class="note"><h3 class="title">Note</h3><p>
1978 If you compile Mutt with the GNU <span class="emphasis"><em>rx</em></span> package, the
1979 following operators may also be used in regular expressions as described in <a class="xref" href="#regex-gnu-ext" title="Table 4.3. GNU regular expression extensions">Table 4.3, “GNU regular expression extensions”</a>.
1980 </p></div><div class="table"><a id="regex-gnu-ext"></a><p class="title"><b>Table 4.3. GNU regular expression extensions</b></p><div class="table-contents"><table summary="GNU regular expression extensions" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Expression</th><th>Description</th></tr></thead><tbody><tr><td>\\y</td><td>Matches the empty string at either the beginning or the end of a word</td></tr><tr><td>\\B</td><td>Matches the empty string within a word</td></tr><tr><td>\\<</td><td>Matches the empty string at the beginning of a word</td></tr><tr><td>\\></td><td>Matches the empty string at the end of a word</td></tr><tr><td>\\w</td><td>Matches any word-constituent character (letter, digit, or underscore)</td></tr><tr><td>\\W</td><td>Matches any character that is not word-constituent</td></tr><tr><td>\\`</td><td>Matches the empty string at the beginning of a buffer (string)</td></tr><tr><td>\\'</td><td>Matches the empty string at the end of a buffer</td></tr></tbody></table></div></div><br class="table-break" /><p>
1981 Please note however that these operators are not defined by POSIX, so
1982 they may or may not be available in stock libraries on various systems.
1983 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="patterns"></a>2. Patterns: Searching, Limiting and Tagging</h2></div></div></div><p>
1984 Many of Mutt's commands allow you to specify a pattern to match
1985 (<code class="literal">limit</code>, <code class="literal">tag-pattern</code>,
1986 <code class="literal">delete-pattern</code>, etc.). <a class="xref" href="#tab-patterns" title="Table 4.4. Pattern modifiers">Table 4.4, “Pattern modifiers”</a>
1987 shows several ways to select messages.
1988 </p><div class="table"><a id="tab-patterns"></a><p class="title"><b>Table 4.4. Pattern modifiers</b></p><div class="table-contents"><table summary="Pattern modifiers" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Pattern modifier</th><th>Description</th></tr></thead><tbody><tr><td>~A</td><td>all messages</td></tr><tr><td>~b <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the message body</td></tr><tr><td>=b <span class="emphasis"><em>STRING</em></span></td><td>messages which contain <span class="emphasis"><em>STRING</em></span> in the message body. If IMAP is enabled, searches for <span class="emphasis"><em>STRING</em></span> on the server, rather than downloading each message and searching it locally.</td></tr><tr><td>~B <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the whole message</td></tr><tr><td>~c <span class="emphasis"><em>EXPR</em></span></td><td>messages carbon-copied to <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%c <span class="emphasis"><em>GROUP</em></span></td><td>messages carbon-copied to any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~C <span class="emphasis"><em>EXPR</em></span></td><td>messages either to: or cc: <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%C <span class="emphasis"><em>GROUP</em></span></td><td>messages either to: or cc: to any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~d [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with “<span class="quote">date-sent</span>” in a Date range</td></tr><tr><td>~D</td><td>deleted messages</td></tr><tr><td>~e <span class="emphasis"><em>EXPR</em></span></td><td>messages which contains <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">Sender</span>” field</td></tr><tr><td>%e <span class="emphasis"><em>GROUP</em></span></td><td>messages which contain a member of <span class="emphasis"><em>GROUP</em></span> in the “<span class="quote">Sender</span>” field</td></tr><tr><td>~E</td><td>expired messages</td></tr><tr><td>~F</td><td>flagged messages</td></tr><tr><td>~f <span class="emphasis"><em>EXPR</em></span></td><td>messages originating from <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%f <span class="emphasis"><em>GROUP</em></span></td><td>messages originating from any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~g</td><td>cryptographically signed messages</td></tr><tr><td>~G</td><td>cryptographically encrypted messages</td></tr><tr><td>~h <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the message header</td></tr><tr><td>~H <span class="emphasis"><em>EXPR</em></span></td><td>messages with a spam attribute matching <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>~i <span class="emphasis"><em>EXPR</em></span></td><td>messages which match <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">Message-ID</span>” field</td></tr><tr><td>~k</td><td>messages which contain PGP key material</td></tr><tr><td>~L <span class="emphasis"><em>EXPR</em></span></td><td>messages either originated or received by <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>%L <span class="emphasis"><em>GROUP</em></span></td><td>message either originated or received by any member of <span class="emphasis"><em>GROUP</em></span></td></tr><tr><td>~l</td><td>messages addressed to a known mailing list</td></tr><tr><td>~m [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages in the range <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> *)</td></tr><tr><td>~n [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with a score in the range <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> *)</td></tr><tr><td>~N</td><td>new messages</td></tr><tr><td>~O</td><td>old messages</td></tr><tr><td>~p</td><td>messages addressed to you (consults alternates)</td></tr><tr><td>~P</td><td>messages from you (consults alternates)</td></tr><tr><td>~Q</td><td>messages which have been replied to</td></tr><tr><td>~r [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with “<span class="quote">date-received</span>” in a Date range</td></tr><tr><td>~R</td><td>read messages</td></tr><tr><td>~s <span class="emphasis"><em>EXPR</em></span></td><td>messages having <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">Subject</span>” field.</td></tr><tr><td>~S</td><td>superseded messages</td></tr><tr><td>~t <span class="emphasis"><em>EXPR</em></span></td><td>messages addressed to <span class="emphasis"><em>EXPR</em></span></td></tr><tr><td>~T</td><td>tagged messages</td></tr><tr><td>~u</td><td>messages addressed to a subscribed mailing list</td></tr><tr><td>~U</td><td>unread messages</td></tr><tr><td>~v</td><td>messages part of a collapsed thread.</td></tr><tr><td>~V</td><td>cryptographically verified messages</td></tr><tr><td>~x <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">References</span>” field</td></tr><tr><td>~X [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> attachments *)</td></tr><tr><td>~y <span class="emphasis"><em>EXPR</em></span></td><td>messages which contain <span class="emphasis"><em>EXPR</em></span> in the “<span class="quote">X-Label</span>” field</td></tr><tr><td>~z [<span class="emphasis"><em>MIN</em></span>]-[<span class="emphasis"><em>MAX</em></span>]</td><td>messages with a size in the range <span class="emphasis"><em>MIN</em></span> to <span class="emphasis"><em>MAX</em></span> *)</td></tr><tr><td>~=</td><td>duplicated messages (see <a class="link" href="#duplicate-threads" title="3.49. duplicate_threads">$duplicate_threads</a>)</td></tr><tr><td>~$</td><td>unreferenced messages (requires threaded view)</td></tr><tr><td>~(<span class="emphasis"><em>PATTERN</em></span>)</td><td>messages in threads
1989 containing messages matching <span class="emphasis"><em>PATTERN</em></span>, e.g. all
1990 threads containing messages from you: ~(~P)</td></tr></tbody></table></div></div><br class="table-break" /><p>
1991 Where <span class="emphasis"><em>EXPR</em></span> is a
1992 <a class="link" href="#regexp" title="1. Regular Expressions">regular expression</a>. Special attention has to be
1993 made when using regular expressions inside of patterns. Specifically,
1994 Mutt's parser for these patterns will strip one level of backslash (“<span class="quote">\</span>”),
1995 which is normally used for quoting. If it is your intention to use a
1996 backslash in the regular expression, you will need to use two backslashes
1997 instead (“<span class="quote">\\</span>”). You can force mutt to treat <span class="emphasis"><em>EXPR</em></span> as a simple string
1998 instead of a regular expression by using = instead of ˜ in the
1999 pattern name. For example, <code class="literal">=b *.*</code> will find all messages that contain
2000 the literal string “<span class="quote">*.*</span>”. Simple string matches are less powerful than
2001 regular expressions but can be considerably faster. This is especially
2002 true for IMAP folders, because string matches can be performed on the
2003 server instead of by fetching every message. IMAP treats <code class="literal">=h</code> specially:
2004 it must be of the form "header: substring" and will not partially
2005 match header names. The substring part may be omitted if you simply
2006 wish to find messages containing a particular header without regard to
2009 *) The forms “<span class="quote"><[<span class="emphasis"><em>MAX</em></span>]</span>”, “<span class="quote">>[<span class="emphasis"><em>MIN</em></span>]</span>”,
2010 “<span class="quote">[<span class="emphasis"><em>MIN</em></span>]-</span>” and “<span class="quote">-[<span class="emphasis"><em>MAX</em></span>]</span>”
2012 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="patterns-modifier"></a>2.1. Pattern Modifier</h3></div></div></div><div class="note"><h3 class="title">Note</h3><p>
2013 Note that patterns matching 'lists' of addresses (notably c, C, p, P and t)
2014 match if there is at least one match in the whole list. If you want to
2015 make sure that all elements of that list match, you need to prefix your
2016 pattern with “<span class="quote">^</span>”.
2017 This example matches all mails which only has recipients from Germany.
2018 </p></div><pre class="screen">
2020 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="simple-patterns"></a>2.2. Simple Patterns</h3></div></div></div><p>
2021 Mutt supports two versions of so called “<span class="quote">simple searches</span>” which are
2022 issued if the query entered for searching, limiting and similar
2023 operations does not seem to be a valid pattern (i.e. it does not contain
2024 one of these characters: “<span class="quote">˜</span>”, “<span class="quote">=</span>” or “<span class="quote">%</span>”). If the query is
2025 supposed to contain one of these special characters, they must be escaped
2026 by prepending a backslash (“<span class="quote">\</span>”).
2028 The first type is by checking whether the query string equals
2029 a keyword case-insensitively from <a class="xref" href="#tab-simplesearch-keywords" title="Table 4.5. Simple search keywords">Table 4.5, “Simple search keywords”</a>:
2030 If that is the case, Mutt will use the shown pattern modifier instead.
2031 If a keyword would conflict with your search keyword, you need to turn
2032 it into a regular expression to avoid matching the keyword table. For
2033 example, if you want to find all messages matching “<span class="quote">flag</span>”
2034 (using <a class="link" href="#simple-search" title="3.264. simple_search">$simple_search</a>)
2035 but don't want to match flagged messages, simply search for
2036 “<span class="quote"><code class="literal">[f]lag</code></span>”.
2037 </p><div class="table"><a id="tab-simplesearch-keywords"></a><p class="title"><b>Table 4.5. Simple search keywords</b></p><div class="table-contents"><table summary="Simple search keywords" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Keyword</th><th>Pattern modifier</th></tr></thead><tbody><tr><td>all</td><td>~A</td></tr><tr><td>.</td><td>~A</td></tr><tr><td>^</td><td>~A</td></tr><tr><td>del</td><td>~D</td></tr><tr><td>flag</td><td>~F</td></tr><tr><td>new</td><td>~N</td></tr><tr><td>old</td><td>~O</td></tr><tr><td>repl</td><td>~Q</td></tr><tr><td>read</td><td>~R</td></tr><tr><td>tag</td><td>~T</td></tr><tr><td>unread</td><td>~U</td></tr></tbody></table></div></div><br class="table-break" /><p>
2038 The second type of simple search is to build a complex search
2039 pattern using <a class="link" href="#simple-search" title="3.264. simple_search">$simple_search</a>
2040 as a template. Mutt will insert your query properly quoted and search
2041 for the composed complex query.
2042 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="complex-patterns"></a>2.3. Complex Patterns</h3></div></div></div><p>
2043 Logical AND is performed by specifying more than one criterion. For
2045 </p><pre class="screen">
2048 would select messages which contain the word “<span class="quote">mutt</span>” in the list of
2049 recipients <span class="bold"><strong>and</strong></span> that have the word “<span class="quote">elkins</span>” in the “<span class="quote">From</span>” header
2052 Mutt also recognizes the following operators to create more complex search
2054 </p><div class="itemizedlist"><ul type="disc"><li><p>
2055 ! -- logical NOT operator
2057 | -- logical OR operator
2059 () -- logical grouping operator
2060 </p></li></ul></div><p>
2061 Here is an example illustrating a complex search pattern. This pattern will
2062 select all messages which do not contain “<span class="quote">mutt</span>” in the “<span class="quote">To</span>” or “<span class="quote">Cc</span>”
2063 field and which are from “<span class="quote">elkins</span>”.
2064 </p><div class="example"><a id="ex-pattern-bool"></a><p class="title"><b>Example 4.1. Using boolean operators in patterns</b></p><div class="example-contents"><pre class="screen">
2065 !(~t mutt|~c mutt) ~f elkins
2066 </pre></div></div><br class="example-break" /><p>
2067 Here is an example using white space in the regular expression (note
2068 the ' and " delimiters). For this to match, the mail's subject must
2069 match the “<span class="quote">^Junk +From +Me$</span>” and it must be from either “<span class="quote">Jim +Somebody</span>”
2070 or “<span class="quote">Ed +SomeoneElse</span>”:
2071 </p><pre class="screen">
2072 '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
2073 </pre><div class="note"><h3 class="title">Note</h3><p>
2074 If a regular expression contains parenthesis, or a vertical bar
2075 ("|"), you <span class="bold"><strong>must</strong></span> enclose the expression in double or single quotes since
2076 those characters are also used to separate different parts of Mutt's
2077 pattern language. For example: <code class="literal">~f "me@(mutt\.org|cs\.hmc\.edu)"</code>
2079 Without the quotes, the parenthesis wouldn't end.
2080 This would be separated to two OR'd patterns: <span class="emphasis"><em>˜f me@(mutt\.org</em></span>
2081 and <span class="emphasis"><em>cs\.hmc\.edu)</em></span>. They are never what you want.
2082 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="date-patterns"></a>2.4. Searching by Date</h3></div></div></div><p>
2083 Mutt supports two types of dates, <span class="emphasis"><em>absolute</em></span> and <span class="emphasis"><em>relative</em></span>.
2085 <span class="bold"><strong>Absolute</strong></span>. Dates <span class="bold"><strong>must</strong></span> be in DD/MM/YY format (month and year are
2086 optional, defaulting to the current month and year). An example of a valid
2088 </p><pre class="screen">
2089 Limit to messages matching: ~d 20/1/95-31/10
2091 If you omit the minimum (first) date, and just specify “<span class="quote">-DD/MM/YY</span>”, all
2092 messages <span class="emphasis"><em>before</em></span> the given date will be selected. If you omit the maximum
2093 (second) date, and specify “<span class="quote">DD/MM/YY-</span>”, all messages <span class="emphasis"><em>after</em></span> the given
2094 date will be selected. If you specify a single date with no dash (“<span class="quote">-</span>”),
2095 only messages sent on the given date will be selected.
2097 <span class="bold"><strong>Error Margins</strong></span>. You can add error margins to absolute dates.
2098 An error margin is a sign (+ or -), followed by a digit, followed by
2099 one of the units in <a class="xref" href="#tab-date-units" title="Table 4.6. Date units">Table 4.6, “Date units”</a>. As a special case, you can replace the
2100 sign by a “<span class="quote">*</span>” character, which is equivalent to giving identical plus and minus error margins.
2101 </p><div class="table"><a id="tab-date-units"></a><p class="title"><b>Table 4.6. Date units</b></p><div class="table-contents"><table summary="Date units" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Unit</th><th>Description</th></tr></thead><tbody><tr><td>y</td><td>Years</td></tr><tr><td>m</td><td>Months</td></tr><tr><td>w</td><td>Weeks</td></tr><tr><td>d</td><td>Days</td></tr></tbody></table></div></div><br class="table-break" /><p>
2102 Example: To select any messages two weeks around January 15, 2001,
2103 you'd use the following pattern:
2104 </p><pre class="screen">
2105 Limit to messages matching: ~d 15/1/2001*2w
2107 <span class="bold"><strong>Relative</strong></span>. This type of date is relative to the current date, and may
2109 </p><div class="itemizedlist"><ul type="disc"><li><p>
2110 ><span class="emphasis"><em>offset</em></span> (messages older than <span class="emphasis"><em>offset</em></span> units)
2112 <<span class="emphasis"><em>offset</em></span> (messages newer than <span class="emphasis"><em>offset</em></span> units)
2114 =<span class="emphasis"><em>offset</em></span> (messages exactly <span class="emphasis"><em>offset</em></span> units old)
2115 </p></li></ul></div><p>
2116 <span class="emphasis"><em>offset</em></span> is specified as a positive number with one of the units from <a class="xref" href="#tab-date-units" title="Table 4.6. Date units">Table 4.6, “Date units”</a>.
2118 Example: to select messages less than 1 month old, you would use
2119 </p><pre class="screen">
2120 Limit to messages matching: ~d <1m
2121 </pre><div class="note"><h3 class="title">Note</h3><p>
2122 All dates used when searching are relative to the
2123 <span class="bold"><strong>local</strong></span> time zone, so unless you change the setting of your <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> to include a
2124 <code class="literal">%[...]</code> format, these are <span class="bold"><strong>not</strong></span> the dates shown
2126 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tags"></a>3. Using Tags</h2></div></div></div><p>
2127 Sometimes it is desirable to perform an operation on a group of
2128 messages all at once rather than one at a time. An example might be
2129 to save messages to a mailing list to a separate folder, or to
2130 delete all messages with a given subject. To tag all messages
2131 matching a pattern, use the <code class="literal"><tag-pattern></code> function, which is bound to
2132 “<span class="quote">shift-T</span>” by default. Or you can select individual messages by
2133 hand using the <code class="literal"><tag-message></code> function, which is bound to “<span class="quote">t</span>” by
2134 default. See <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> for Mutt's pattern
2137 Once you have tagged the desired messages, you can use the
2138 “<span class="quote">tag-prefix</span>” operator, which is the “<span class="quote">;</span>” (semicolon) key by default.
2139 When the “<span class="quote">tag-prefix</span>” operator is used, the <span class="bold"><strong>next</strong></span> operation will
2140 be applied to all tagged messages if that operation can be used in that
2141 manner. If the <a class="link" href="#auto-tag" title="3.18. auto_tag">$auto_tag</a>
2142 variable is set, the next operation applies to the tagged messages
2143 automatically, without requiring the “<span class="quote">tag-prefix</span>”.
2145 In <a class="link" href="#macro" title="8. Keyboard macros">macros</a> or <a class="link" href="#push" title="22. Adding key sequences to the keyboard buffer">push</a> commands,
2146 you can use the “<span class="quote">tag-prefix-cond</span>” operator. If there are no tagged
2147 messages, mutt will "eat" the rest of the macro to abort it's execution.
2148 Mutt will stop "eating" the macro when it encounters the “<span class="quote">end-cond</span>”
2149 operator; after this operator the rest of the macro will be executed as
2151 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="hooks"></a>4. Using Hooks</h2></div></div></div><p>
2152 A <span class="emphasis"><em>hook</em></span> is a concept found in many other programs which allows you to
2153 execute arbitrary commands before performing some operation. For example,
2154 you may wish to tailor your configuration based upon which mailbox you are
2155 reading, or to whom you are sending mail. In the Mutt world, a <span class="emphasis"><em>hook</em></span>
2156 consists of a <a class="link" href="#regexp" title="1. Regular Expressions">regular expression</a> or
2157 <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">pattern</a> along with a
2158 configuration option/command. See
2160 </p><div class="itemizedlist"><ul type="disc"><li><p>
2161 <a class="link" href="#folder-hook" title="7. Setting variables based upon mailbox">folder-hook</a>
2163 <a class="link" href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a>
2165 <a class="link" href="#message-hook" title="20. Change settings before formatting a message">message-hook</a>
2167 <a class="link" href="#save-hook" title="16. Specify default save mailbox">save-hook</a>
2169 <a class="link" href="#mbox-hook" title="13. Using Multiple spool mailboxes">mbox-hook</a>
2171 <a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>
2173 <a class="link" href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a>
2174 </p></li></ul></div><p>
2176 for specific details on each type of <span class="emphasis"><em>hook</em></span> available.
2177 </p><div class="note"><h3 class="title">Note</h3><p>
2178 If a hook changes configuration settings, these changes remain
2179 effective until the end of the current mutt session. As this is generally
2180 not desired, a default hook needs to be added before all other hooks to
2181 restore configuration defaults. Here is an example with send-hook and the
2183 </p></div><div class="example"><a id="ex-send-hook-my-hdr"></a><p class="title"><b>Example 4.2. Combining <code class="literal">send-hook</code> and <code class="literal">my_hdr</code></b></p><div class="example-contents"><pre class="screen">
2184 send-hook . 'unmy_hdr From:'
2185 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
2186 </pre></div></div><br class="example-break" /><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pattern-hook"></a>4.1. Message Matching in Hooks</h3></div></div></div><p>
2187 Hooks that act upon messages (<code class="literal">message-hook, reply-hook,
2188 send-hook, send2-hook, save-hook, fcc-hook</code>) are evaluated in a
2189 slightly different manner. For the other
2190 types of hooks, a <a class="link" href="#regexp" title="1. Regular Expressions">regular expression</a> is
2191 sufficient. But in dealing with messages a finer grain of control is
2192 needed for matching since for different purposes you want to match
2195 Mutt allows the use of the <a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">search pattern</a>
2196 language for matching messages in hook commands. This works in
2197 exactly the same way as it would when <span class="emphasis"><em>limiting</em></span> or
2198 <span class="emphasis"><em>searching</em></span> the mailbox, except that you are restricted to those
2199 operators which match information mutt extracts from the header of
2200 the message (i.e., from, to, cc, date, subject, etc.).
2202 For example, if you wanted to set your return address based upon sending
2203 mail to a specific address, you could do something like:
2204 </p><pre class="screen">
2205 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
2207 which would execute the given command when sending mail to
2208 <span class="emphasis"><em>me@cs.hmc.edu</em></span>.
2210 However, it is not required that you write the pattern to match using the
2211 full searching language. You can still specify a simple <span class="emphasis"><em>regular
2212 expression</em></span> like the other hooks, in which case Mutt will translate your
2213 pattern into the full language, using the translation specified by the
2214 <a class="link" href="#default-hook" title="3.41. default_hook">$default_hook</a> variable. The
2215 pattern is translated at the time the hook is declared, so the value of
2216 <a class="link" href="#default-hook" title="3.41. default_hook">$default_hook</a> that is in effect
2217 at that time will be used.
2218 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="query"></a>5. External Address Queries</h2></div></div></div><p>
2219 Mutt supports connecting to external directory databases such as LDAP,
2220 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
2221 using a simple interface. Using the <a class="link" href="#query-command" title="3.232. query_command">$query_command</a> variable, you specify the wrapper
2222 command to use. For example:
2223 </p><pre class="screen">
2224 set query_command = "mutt_ldap_query.pl '%s'"
2226 The wrapper script should accept the query on the command-line. It
2227 should return a one line message, then each matching response on a
2228 single line, each line containing a tab separated address then name then
2229 some other optional information. On error, or if there are no matching
2230 addresses, return a non-zero exit code and a one line error message.
2232 An example multiple response output:
2233 </p><pre class="screen">
2234 Searching database ... 20 entries ... 3 matching:
2235 me@cs.hmc.edu Michael Elkins mutt dude
2236 blong@fiction.net Brandon Long mutt and more
2237 roessler@does-not-exist.org Thomas Roessler mutt pgp
2239 There are two mechanisms for accessing the query function of mutt. One
2240 is to do a query from the index menu using the <code class="literal"><query></code> function (default: Q).
2241 This will prompt for a query, then bring up the query menu which will
2242 list the matching responses. From the query menu, you can select
2243 addresses to create aliases, or to mail. You can tag multiple addresses
2244 to mail, start a new query, or have a new query appended to the current
2247 The other mechanism for accessing the query function is for address
2248 completion, similar to the alias completion. In any prompt for address
2249 entry, you can use the <code class="literal"><complete-query></code> function (default: ^T) to run a
2250 query based on the current address you have typed. Like aliases, mutt
2251 will look for what you have typed back to the last space or comma. If
2252 there is a single response for that query, mutt will expand the address
2253 in place. If there are multiple responses, mutt will activate the query
2254 menu. At the query menu, you can select one or more addresses to be
2255 added to the prompt.
2256 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailbox-formats"></a>6. Mailbox Formats</h2></div></div></div><p>
2257 Mutt supports reading and writing of four different mailbox formats:
2258 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
2259 is no need to use a flag for different mailbox types. When creating new
2260 mailboxes, Mutt uses the default specified with the <a class="link" href="#mbox-type" title="3.117. mbox_type">$mbox_type</a> variable.
2262 <span class="bold"><strong>mbox</strong></span>. This is the most widely used mailbox format for UNIX. All
2263 messages are stored in a single file. Each message has a line of the form:
2264 </p><pre class="screen">
2265 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
2267 to denote the start of a new message (this is often referred to as the
2268 “<span class="quote">From_</span>” line).
2270 <span class="bold"><strong>MMDF</strong></span>. This is a variant of the <span class="emphasis"><em>mbox</em></span> format. Each message is
2271 surrounded by lines containing “<span class="quote">^A^A^A^A</span>” (four control-A's).
2273 <span class="bold"><strong>MH</strong></span>. A radical departure from <span class="emphasis"><em>mbox</em></span> and <span class="emphasis"><em>MMDF</em></span>, a mailbox
2274 consists of a directory and each message is stored in a separate file.
2275 The filename indicates the message number (however, this is may not
2276 correspond to the message number Mutt displays). Deleted messages are
2277 renamed with a comma (,) prepended to the filename. Mutt
2278 detects this type of mailbox by looking for either <code class="literal">.mh_sequences</code>
2279 or <code class="literal">.xmhcache</code> (needed to distinguish normal directories from MH
2282 <span class="bold"><strong>Maildir</strong></span>. The newest of the mailbox formats, used by the Qmail MTA (a
2283 replacement for sendmail). Similar to <span class="emphasis"><em>MH</em></span>, except that it adds three
2284 subdirectories of the mailbox: <span class="emphasis"><em>tmp</em></span>, <span class="emphasis"><em>new</em></span> and <span class="emphasis"><em>cur</em></span>. Filenames
2285 for the messages are chosen in such a way they are unique, even when two
2286 programs are writing the mailbox over NFS, which means that no file locking
2288 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="shortcuts"></a>7. Mailbox Shortcuts</h2></div></div></div><p>
2289 There are a number of built in shortcuts which refer to specific mailboxes.
2290 These shortcuts can be used anywhere you are prompted for a file or mailbox
2292 </p><div class="itemizedlist"><ul type="disc"><li><p>
2293 ! -- refers to your <a class="link" href="#spoolfile" title="3.277. spoolfile">$spoolfile</a> (incoming) mailbox
2295 > -- refers to your <a class="link" href="#mbox" title="3.116. mbox">$mbox</a> file
2297 < -- refers to your <a class="link" href="#record" title="3.240. record">$record</a> file
2299 ^ -- refers to the current mailbox
2301 - or !! -- refers to the file you've last visited
2303 ˜ -- refers to your home directory
2305 = or + -- refers to your <a class="link" href="#folder" title="3.58. folder">$folder</a> directory
2307 @<span class="emphasis"><em>alias</em></span> -- refers to the <a class="link" href="#save-hook" title="16. Specify default save mailbox">default save folder</a> as determined by the address of the alias
2308 </p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-lists"></a>8. Handling Mailing Lists</h2></div></div></div><p>
2309 Mutt has a few configuration options that make dealing with large
2310 amounts of mail easier. The first thing you must do is to let Mutt
2311 know what addresses you consider to be mailing lists (technically
2312 this does not have to be a mailing list, but that is what it is most
2313 often used for), and what lists you are subscribed to. This is
2314 accomplished through the use of the <a class="link" href="#lists" title="12. Mailing lists">lists and subscribe</a> commands in your muttrc.
2316 Now that Mutt knows what your mailing lists are, it can do several
2317 things, the first of which is the ability to show the name of a list
2318 through which you received a message (i.e., of a subscribed list) in
2319 the <span class="emphasis"><em>index</em></span> menu display. This is useful to distinguish between
2320 personal and list mail in the same mailbox. In the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> variable, the escape “<span class="quote">%L</span>”
2321 will return the string “<span class="quote">To <list></span>” when “<span class="quote">list</span>” appears in the
2322 “<span class="quote">To</span>” field, and “<span class="quote">Cc <list></span>” when it appears in the “<span class="quote">Cc</span>”
2323 field (otherwise it returns the name of the author).
2325 Often times the “<span class="quote">To</span>” and “<span class="quote">Cc</span>” fields in mailing list messages
2326 tend to get quite large. Most people do not bother to remove the
2327 author of the message they reply to from the list, resulting in
2328 two or more copies being sent to that person. The <code class="literal"><list-reply></code>
2329 function, which by default is bound to “<span class="quote">L</span>” in the <span class="emphasis"><em>index</em></span> menu
2330 and <span class="emphasis"><em>pager</em></span>, helps reduce the clutter by only replying to the
2331 known mailing list addresses instead of all recipients (except as
2332 specified by <code class="literal">Mail-Followup-To</code>, see below).
2334 Mutt also supports the <code class="literal">Mail-Followup-To</code> header. When you send
2335 a message to a list of recipients which includes one or several
2336 subscribed mailing lists, and if the <a class="link" href="#followup-to" title="3.60. followup_to">$followup_to</a> option is set, mutt will generate
2337 a Mail-Followup-To header which contains all the recipients to whom
2338 you send this message, but not your address. This indicates that
2339 group-replies or list-replies (also known as “<span class="quote">followups</span>”) to this
2340 message should only be sent to the original recipients of the
2341 message, and not separately to you - you'll receive your copy through
2342 one of the mailing lists you are subscribed to.
2344 Conversely, when group-replying or list-replying to a message which
2345 has a <code class="literal">Mail-Followup-To</code> header, mutt will respect this header if
2346 the <a class="link" href="#honor-followup-to" title="3.79. honor_followup_to">$honor_followup_to</a> configuration
2347 variable is set. Using list-reply will in this case also make sure
2348 that the reply goes to the mailing list, even if it's not specified
2349 in the list of recipients in the <code class="literal">Mail-Followup-To</code>.
2350 </p><div class="note"><h3 class="title">Note</h3><p>
2351 When header editing is enabled, you can create a
2352 <code class="literal">Mail-Followup-To</code> header manually. Mutt will only auto-generate
2353 this header if it doesn't exist when you send the message.
2355 The other method some mailing list admins use is to generate a
2356 “<span class="quote">Reply-To</span>” field which points back to the mailing list address rather
2357 than the author of the message. This can create problems when trying
2358 to reply directly to the author in private, since most mail clients
2359 will automatically reply to the address given in the “<span class="quote">Reply-To</span>”
2360 field. Mutt uses the <a class="link" href="#reply-to" title="3.243. reply_to">$reply_to</a>
2361 variable to help decide which address to use. If set to <span class="emphasis"><em>ask-yes</em></span> or
2362 <span class="emphasis"><em>ask-no</em></span>, you will be
2363 prompted as to whether or not you would like to use the address given in
2364 the “<span class="quote">Reply-To</span>” field, or reply directly to the address given in the
2365 “<span class="quote">From</span>” field. When set to <span class="emphasis"><em>yes</em></span>, the “<span class="quote">Reply-To</span>” field will be used when
2368 The “<span class="quote">X-Label:</span>” header field can be used to further identify mailing
2369 lists or list subject matter (or just to annotate messages
2370 individually). The <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> variable's “<span class="quote">%y</span>” and
2371 “<span class="quote">%Y</span>” escapes can be used to expand “<span class="quote">X-Label:</span>” fields in the
2372 index, and Mutt's pattern-matcher can match regular expressions to
2373 “<span class="quote">X-Label:</span>” fields with the “<span class="quote">˜y</span>” selector. “<span class="quote">X-Label:</span>” is not a
2374 standard message header field, but it can easily be inserted by procmail
2375 and other mail filtering agents.
2377 Lastly, Mutt has the ability to <a class="link" href="#sort" title="3.271. sort">sort</a> the mailbox into
2378 <a class="link" href="#threads" title="4.3. Threaded Mode">threads</a>. A thread is a group of messages which all relate to the same
2379 subject. This is usually organized into a tree-like structure where a
2380 message and all of its replies are represented graphically. If you've ever
2381 used a threaded news client, this is the same concept. It makes dealing
2382 with large volume mailing lists easier because you can easily delete
2383 uninteresting threads and quickly find topics of value.
2384 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="handling-folders"></a>9. Handling multiple folders</h2></div></div></div><p>
2385 Mutt supports setups with multiple folders, allowing all of them to
2386 be monitored for new mail (see <a class="xref" href="#mailboxes" title="14. Monitoring incoming mail">Section 14, “Monitoring incoming mail”</a> for details).
2388 When in the index menu and being idle (also see
2389 <a class="link" href="#timeout" title="3.288. timeout">$timeout</a>), Mutt periodically checks
2390 for new mail in all folders which have been configured via the
2391 <code class="literal">mailboxes</code> command. The interval depends on the folder
2392 type: for local/IMAP folders it consults
2393 <a class="link" href="#mail-check" title="3.105. mail_check">$mail_check</a> and
2394 <a class="link" href="#pop-checkinterval" title="3.216. pop_checkinterval">$pop_checkinterval</a>
2397 Outside the index menu the directory browser supports checking
2398 for new mail using the <code class="literal"><check-new></code> function which is
2399 unbound by default. Pressing TAB will bring up a
2400 menu showing the files specified by the <code class="literal">mailboxes</code> command,
2401 and indicate which contain new messages. Mutt will automatically enter this
2402 mode when invoked from the command line with the <code class="literal">-y</code> option.
2404 For the pager, index and directory browser menus, Mutt contains the
2405 <code class="literal"><buffy-list></code> function (bound to “<span class="quote">.</span>” by default)
2406 which will print a list of folders with new mail in the command line at
2407 the bottom of the screen.
2409 For the index, by default Mutt displays the number of mailboxes with new
2410 mail in the status bar, please refer to the
2411 <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>
2412 variable for details.
2414 When changing folders, Mutt fills the prompt with the first folder from
2415 the mailboxes list containing new mail (if any), pressing
2416 <span class="emphasis"><em>space</em></span> will cycle through folders with new mail.
2417 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing-threads"></a>10. Editing threads</h2></div></div></div><p>
2418 Mutt has the ability to dynamically restructure threads that are broken
2419 either by misconfigured software or bad behavior from some
2420 correspondents. This allows to clean your mailboxes formats) from these
2421 annoyances which make it hard to follow a discussion.
2422 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="link-threads"></a>10.1. Linking threads</h3></div></div></div><p>
2423 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
2424 "References:" headers when replying to a message. This results in broken
2425 discussions because Mutt has not enough information to guess the correct
2427 You can fix this by tagging the reply, then moving to the parent message
2428 and using the <code class="literal"><link-threads></code> function (bound to & by default). The
2429 reply will then be connected to this "parent" message.
2431 You can also connect multiple children at once, tagging them and using the
2432 tag-prefix command (';') or the auto_tag option.
2433 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="break-threads"></a>10.2. Breaking threads</h3></div></div></div><p>
2434 On mailing lists, some people are in the bad habit of starting a new
2435 discussion by hitting "reply" to any message from the list and changing
2436 the subject to a totally unrelated one.
2437 You can fix such threads by using the <code class="literal"><break-thread></code> function (bound
2438 by default to #), which will turn the subthread starting from the
2439 current message into a whole different thread.
2440 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="dsn"></a>11. Delivery Status Notification (DSN) Support</h2></div></div></div><p>
2441 RFC1894 defines a set of MIME content types for relaying information
2442 about the status of electronic mail messages. These can be thought of as
2443 “<span class="quote">return receipts.</span>”
2445 To support DSN, there are two variables. <a class="link" href="#dsn-notify" title="3.47. dsn_notify">$dsn_notify</a> is used to request receipts for
2446 different results (such as failed message, message delivered, etc.).
2447 <a class="link" href="#dsn-return" title="3.48. dsn_return">$dsn_return</a> requests how much
2448 of your message should be returned with the receipt (headers or full
2451 When using <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> for mail
2452 delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA
2453 supporting DSN command line options compatible to Sendmail: The -N and -R
2454 options can be used by the mail client to make requests as to what type of
2455 status messages should be returned. Please consider your MTA documentation
2456 whether DSN is supported.
2458 For SMTP delivery using <a class="link" href="#smtp-url" title="3.270. smtp_url">$smtp_url</a>, it depends on the
2459 capabilities announced by the server whether mutt will attempt to
2461 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="urlview"></a>12. Start a WWW Browser on URLs</h2></div></div></div><p>
2462 If a message contains URLs, it is efficient to get
2463 a menu with all the URLs and start a WWW browser on one of them. This
2464 functionality is provided by the external urlview program which can be
2466 <a class="ulink" href="ftp://ftp.mutt.org/mutt/contrib/" target="_top">ftp://ftp.mutt.org/mutt/contrib/</a>
2467 and the configuration commands:
2468 </p><pre class="screen">
2469 macro index \cb |urlview\n
2470 macro pager \cb |urlview\n
2471 </pre></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="mimesupport"></a>Chapter 5. Mutt's MIME Support</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#using-mime">1. Using MIME in Mutt</a></span></dt><dd><dl><dt><span class="sect2"><a href="#mime-pager">1.1. Viewing MIME messages in the pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.2. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.3. The Compose Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#mime-types">2. MIME Type configuration with <code class="literal">mime.types</code></a></span></dt><dt><span class="sect1"><a href="#mailcap">3. MIME Viewer configuration with <code class="literal">mailcap</code></a></span></dt><dd><dl><dt><span class="sect2"><a href="#mailcap-basics">3.1. The Basics of the mailcap file</a></span></dt><dt><span class="sect2"><a href="#secure-mailcap">3.2. Secure use of mailcap</a></span></dt><dt><span class="sect2"><a href="#advanced-mailcap">3.3. Advanced mailcap Usage</a></span></dt><dt><span class="sect2"><a href="#mailcap-example">3.4. Example mailcap files</a></span></dt></dl></dd><dt><span class="sect1"><a href="#auto-view">4. MIME Autoview</a></span></dt><dt><span class="sect1"><a href="#alternative-order">5. MIME Multipart/Alternative</a></span></dt><dt><span class="sect1"><a href="#attachments">6. Attachment Searching and Counting</a></span></dt><dt><span class="sect1"><a href="#mime-lookup">7. MIME Lookup</a></span></dt></dl></div><p>
2472 Quite a bit of effort has been made to make Mutt the premier text-mode
2473 MIME MUA. Every effort has been made to provide the functionality that
2474 the discerning MIME user requires, and the conformance to the standards
2475 wherever possible. When configuring Mutt for MIME, there are two extra
2476 types of configuration files which Mutt uses. One is the
2477 <code class="literal">mime.types</code> file, which contains the mapping of file extensions to
2478 IANA MIME types. The other is the <code class="literal">mailcap</code> file, which specifies
2479 the external commands to use for handling specific MIME types.
2480 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-mime"></a>1. Using MIME in Mutt</h2></div></div></div><p>
2481 There are three areas/menus in Mutt which deal with MIME, they are the
2482 pager (while viewing a message), the attachment menu and the compose
2484 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-pager"></a>1.1. Viewing MIME messages in the pager</h3></div></div></div><p>
2485 When you select a message from the index and view it in the pager, Mutt
2486 decodes the message to a text representation. Mutt internally supports
2487 a number of MIME types, including <code class="literal">text/plain, text/enriched,
2488 message/rfc822, and message/news</code>. In addition, the export
2489 controlled version of Mutt recognizes a variety of PGP MIME types,
2490 including PGP/MIME and application/pgp.
2492 Mutt will denote attachments with a couple lines describing them.
2493 These lines are of the form:
2494 </p><pre class="screen">
2495 [-- Attachment #1: Description --]
2496 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
2498 Where the <code class="literal">Description</code> is the description or filename given for the
2499 attachment, and the <code class="literal">Encoding</code> is one of
2500 <code class="literal">7bit/8bit/quoted-printable/base64/binary</code>.
2502 If Mutt cannot deal with a MIME type, it will display a message like:
2503 </p><pre class="screen">
2504 [-- image/gif is unsupported (use 'v' to view this part) --]
2505 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-menu"></a>1.2. The Attachment Menu</h3></div></div></div><p>
2506 The default binding for <code class="literal">view-attachments</code> is `v', which displays the
2507 attachment menu for a message. The attachment menu displays a list of
2508 the attachments in a message. From the attachment menu, you can save,
2509 print, pipe, delete, and view attachments. You can apply these
2510 operations to a group of attachments at once, by tagging the attachments
2511 and by using the “<span class="quote">tag-prefix</span>” operator. You can also reply to the
2512 current message from this menu, and only the current attachment (or the
2513 attachments tagged) will be quoted in your reply. You can view
2514 attachments as text, or view them using the mailcap viewer definition.
2516 Finally, you can apply the usual message-related functions (like
2517 <a class="link" href="#resend-message"><code class="literal"><resend-message></code></a>, and the
2518 <code class="literal"><reply></code> and <code class="literal"><forward></code>
2519 functions) to attachments of type <code class="literal">message/rfc822</code>.
2521 See the help on the attachment menu for more information.
2522 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-menu"></a>1.3. The Compose Menu</h3></div></div></div><p>
2523 The compose menu is the menu you see before you send a message. It
2524 allows you to edit the recipient list, the subject, and other aspects
2525 of your message. It also contains a list of the attachments of your
2526 message, including the main body. From this menu, you can print, copy,
2527 filter, pipe, edit, compose, review, and rename an attachment or a
2528 list of tagged attachments. You can also modifying the attachment
2529 information, notably the type, encoding and description.
2531 Attachments appear as follows:
2532 </p><pre class="screen">
2533 - 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
2534 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
2536 The '-' denotes that Mutt will delete the file after sending (or
2537 postponing, or canceling) the message. It can be toggled with the
2538 <code class="literal">toggle-unlink</code> command (default: u). The next field is the MIME
2539 content-type, and can be changed with the <code class="literal">edit-type</code> command
2540 (default: ^T). The next field is the encoding for the attachment,
2541 which allows a binary message to be encoded for transmission on 7bit
2542 links. It can be changed with the <code class="literal">edit-encoding</code> command
2543 (default: ^E). The next field is the size of the attachment,
2544 rounded to kilobytes or megabytes. The next field is the filename,
2545 which can be changed with the <code class="literal">rename-file</code> command (default: R).
2546 The final field is the description of the attachment, and can be
2547 changed with the <code class="literal">edit-description</code> command (default: d).
2548 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-types"></a>2. MIME Type configuration with <code class="literal">mime.types</code></h2></div></div></div><p>
2549 When you add an attachment to your mail message, Mutt searches your
2550 personal mime.types file at <code class="literal">${HOME}/.mime.types</code>, and then
2551 the system mime.types file at <code class="literal">/usr/local/share/mutt/mime.types</code> or
2552 <code class="literal">/etc/mime.types</code>
2554 The mime.types file consist of lines containing a MIME type and a space
2555 separated list of extensions. For example:
2556 </p><pre class="screen">
2557 application/postscript ps eps
2559 audio/x-aiff aif aifc aiff
2561 A sample <code class="literal">mime.types</code> file comes with the Mutt distribution, and
2562 should contain most of the MIME types you are likely to use.
2564 If Mutt can not determine the mime type by the extension of the file you
2565 attach, it will look at the file. If the file is free of binary
2566 information, Mutt will assume that the file is plain text, and mark it
2567 as <code class="literal">text/plain</code>. If the file contains binary information, then Mutt will
2568 mark it as <code class="literal">application/octet-stream</code>. You can change the MIME
2569 type that Mutt assigns to an attachment by using the <code class="literal">edit-type</code>
2570 command from the compose menu (default: ^T). The MIME type is actually a
2571 major mime type followed by the sub-type, separated by a '/'. 6 major
2572 types: application, text, image, video, audio, and model have been approved
2573 after various internet discussions. Mutt recognizes all of these if the
2574 appropriate entry is found in the mime.types file. It also recognizes other
2575 major mime types, such as the chemical type that is widely used in the
2576 molecular modeling community to pass molecular data in various forms to
2577 various molecular viewers. Non-recognized mime types should only be used
2578 if the recipient of the message is likely to be expecting such attachments.
2579 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailcap"></a>3. MIME Viewer configuration with <code class="literal">mailcap</code></h2></div></div></div><p>
2580 Mutt supports RFC 1524 MIME Configuration, in particular the Unix
2581 specific format specified in Appendix A of RFC 1524. This file format
2582 is commonly referred to as the mailcap format. Many MIME compliant
2583 programs utilize the mailcap format, allowing you to specify handling
2584 for all MIME types in one place for all programs. Programs known to
2585 use this format include Netscape, XMosaic, lynx and metamail.
2587 In order to handle various MIME types that Mutt can not handle
2588 internally, Mutt parses a series of external configuration files to
2589 find an external handler. The default search string for these files
2590 is a colon delimited list containing the following files:
2591 </p><div class="orderedlist"><ol type="1"><li><p><code class="literal">$HOME/.mailcap</code></p></li><li><p><code class="literal">$PKGDATADIR/mailcap</code></p></li><li><p><code class="literal">$SYSCONFDIR/mailcap</code></p></li><li><p><code class="literal">/etc/mailcap</code></p></li><li><p><code class="literal">/usr/etc/mailcap</code></p></li><li><p><code class="literal">/usr/local/etc/mailcap</code></p></li></ol></div><p>
2592 where <code class="literal">$HOME</code> is your home directory. The
2593 <code class="literal">$PKGDATADIR</code> and the
2594 <code class="literal">$SYSCONFDIR</code> directories depend on where mutt
2595 is installed: the former is the default for shared data, the
2596 latter for system configuration files.
2598 The default search path can be obtained by running the following
2600 </p><pre class="screen">
2601 mutt -nF /dev/null -Q mailcap_path
2603 In particular, the metamail distribution will install a mailcap file,
2604 usually as <code class="literal">/usr/local/etc/mailcap</code>, which contains some baseline
2606 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-basics"></a>3.1. The Basics of the mailcap file</h3></div></div></div><p>
2607 A mailcap file consists of a series of lines which are comments, blank,
2610 A comment line consists of a # character followed by anything you want.
2612 A blank line is blank.
2614 A definition line consists of a content type, a view command, and any
2615 number of optional fields. Each field of a definition line is divided
2616 by a semicolon ';' character.
2618 The content type is specified in the MIME standard type/subtype method.
2620 <code class="literal">text/plain, text/html, image/gif, </code>
2621 etc. In addition, the mailcap format includes two formats for
2622 wildcards, one using the special '*' subtype, the other is the implicit
2623 wild, where you only include the major type. For example, <code class="literal">image/*</code>, or
2624 <code class="literal">video,</code> will match all image types and video types,
2627 The view command is a Unix command for viewing the type specified. There
2628 are two different types of commands supported. The default is to send
2629 the body of the MIME message to the command on stdin. You can change
2630 this behavior by using %s as a parameter to your view command.
2631 This will cause Mutt to save the body of the MIME message to a temporary
2632 file, and then call the view command with the %s replaced by
2633 the name of the temporary file. In both cases, Mutt will turn over the
2634 terminal to the view program until the program quits, at which time Mutt
2635 will remove the temporary file if it exists.
2637 So, in the simplest form, you can send a text/plain message to the
2638 external pager more on stdin:
2639 </p><pre class="screen">
2642 Or, you could send the message as a file:
2643 </p><pre class="screen">
2646 Perhaps you would like to use lynx to interactively view a text/html
2648 </p><pre class="screen">
2651 In this case, lynx does not support viewing a file from stdin, so you
2652 must use the %s syntax.
2653 </p><div class="note"><h3 class="title">Note</h3><p>
2654 <span class="emphasis"><em>Some older versions of lynx contain a bug where they
2655 will check the mailcap file for a viewer for text/html. They will find
2656 the line which calls lynx, and run it. This causes lynx to continuously
2657 spawn itself to view the object.</em></span>
2659 On the other hand, maybe you don't want to use lynx interactively, you
2660 just want to have it convert the text/html to text/plain, then you can
2662 </p><pre class="screen">
2663 text/html; lynx -dump %s | more
2665 Perhaps you wish to use lynx to view text/html files, and a pager on
2666 all other text formats, then you would use the following:
2667 </p><pre class="screen">
2671 This is the simplest form of a mailcap file.
2672 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="secure-mailcap"></a>3.2. Secure use of mailcap</h3></div></div></div><p>
2673 The interpretation of shell meta-characters embedded in MIME parameters
2674 can lead to security problems in general. Mutt tries to quote parameters
2675 in expansion of %s syntaxes properly, and avoids risky characters by
2676 substituting them, see the <a class="link" href="#mailcap-sanitize" title="3.107. mailcap_sanitize">$mailcap_sanitize</a> variable.
2678 Although mutt's procedures to invoke programs with mailcap seem to be
2679 safe, there are other applications parsing mailcap, maybe taking less care
2680 of it. Therefore you should pay attention to the following rules:
2682 <span class="emphasis"><em>Keep the %-expandos away from shell quoting.</em></span>
2683 Don't quote them with single or double quotes. Mutt does this for
2684 you, the right way, as should any other program which interprets
2685 mailcap. Don't put them into backtick expansions. Be highly careful
2686 with eval statements, and avoid them if possible at all. Trying to fix
2687 broken behavior with quotes introduces new leaks - there is no
2688 alternative to correct quoting in the first place.
2690 If you have to use the %-expandos' values in context where you need
2691 quoting or backtick expansions, put that value into a shell variable
2692 and reference the shell variable where necessary, as in the following
2693 example (using <code class="literal">$charset</code> inside the backtick expansion is safe,
2694 since it is not itself subject to any further expansion):
2695 </p><pre class="screen">
2696 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
2697 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
2698 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="advanced-mailcap"></a>3.3. Advanced mailcap Usage</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="optional-mailcap-fields"></a>3.3.1. Optional Fields</h4></div></div></div><p>
2699 In addition to the required content-type and view command fields, you
2700 can add semi-colon ';' separated fields to set flags and other options.
2701 Mutt recognizes the following optional fields:
2702 </p><div class="variablelist"><dl><dt><span class="term">copiousoutput</span></dt><dd><p>
2703 This flag tells Mutt that the command passes possibly large amounts of
2704 text on stdout. This causes Mutt to invoke a pager (either the internal
2705 pager or the external pager defined by the pager variable) on the output
2706 of the view command. Without this flag, Mutt assumes that the command
2707 is interactive. One could use this to replace the pipe to <code class="literal">more</code>
2708 in the <code class="literal">lynx -dump</code> example in the Basic section:
2709 </p><pre class="screen">
2710 text/html; lynx -dump %s ; copiousoutput
2712 This will cause lynx to format the text/html output as text/plain
2713 and Mutt will use your standard pager to display the results.
2714 </p></dd><dt><span class="term">needsterminal</span></dt><dd><p>
2715 Mutt uses this flag when viewing attachments with <a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a>, in order to decide whether it should honor the setting
2716 of the <a class="link" href="#wait-key" title="3.300. wait_key">$wait_key</a> variable or
2717 not. When an attachment is viewed using an interactive program, and the
2718 corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag, Mutt will use
2719 <a class="link" href="#wait-key" title="3.300. wait_key">$wait_key</a> and the exit status
2720 of the program to decide if it will ask you to press a key after the
2721 external program has exited. In all other situations it will not prompt
2723 </p></dd><dt><span class="term">compose=<command></span></dt><dd><p>
2724 This flag specifies the command to use to create a new attachment of a
2725 specific MIME type. Mutt supports this from the compose menu.
2726 </p></dd><dt><span class="term">composetyped=<command></span></dt><dd><p>
2727 This flag specifies the command to use to create a new attachment of a
2728 specific MIME type. This command differs from the compose command in
2729 that mutt will expect standard MIME headers on the data. This can be
2730 used to specify parameters, filename, description, etc. for a new
2731 attachment. Mutt supports this from the compose menu.
2732 </p></dd><dt><span class="term">print=<command></span></dt><dd><p>
2733 This flag specifies the command to use to print a specific MIME type.
2734 Mutt supports this from the attachment and compose menus.
2735 </p></dd><dt><span class="term">edit=<command></span></dt><dd><p>
2736 This flag specifies the command to use to edit a specific MIME type.
2737 Mutt supports this from the compose menu, and also uses it to compose
2738 new attachments. Mutt will default to the defined editor for text
2740 </p></dd><dt><span class="term">nametemplate=<template></span></dt><dd><p>
2741 This field specifies the format for the file denoted by %s in the
2742 command fields. Certain programs will require a certain file extension,
2743 for instance, to correctly view a file. For instance, lynx will only
2744 interpret a file as <code class="literal">text/html</code> if the file ends in <code class="literal">.html</code>.
2745 So, you would specify lynx as a <code class="literal">text/html</code> viewer with a line in
2746 the mailcap file like:
2747 </p><pre class="screen">
2748 text/html; lynx %s; nametemplate=%s.html
2749 </pre></dd><dt><span class="term">test=<command></span></dt><dd><p>
2750 This field specifies a command to run to test whether this mailcap
2751 entry should be used. The command is defined with the command expansion
2752 rules defined in the next section. If the command returns 0, then the
2753 test passed, and Mutt uses this entry. If the command returns non-zero,
2754 then the test failed, and Mutt continues searching for the right entry.
2755 Note that the content-type must match before Mutt performs the test.
2757 </p><pre class="screen">
2758 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
2761 In this example, Mutt will run the program RunningX which will return 0
2762 if the X Window manager is running, and non-zero if it isn't. If
2763 RunningX returns 0, then Mutt will call netscape to display the
2764 text/html object. If RunningX doesn't return 0, then Mutt will go on
2765 to the next entry and use lynx to display the text/html object.
2766 </p></dd></dl></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="mailcap-search-order"></a>3.3.2. Search Order</h4></div></div></div><p>
2767 When searching for an entry in the mailcap file, Mutt will search for
2768 the most useful entry for its purpose. For instance, if you are
2769 attempting to print an <code class="literal">image/gif</code>, and you have the following
2770 entries in your mailcap file, Mutt will search for an entry with the
2772 </p><pre class="screen">
2774 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
2777 Mutt will skip the <code class="literal">image/*</code> entry and use the <code class="literal">image/gif</code>
2778 entry with the print command.
2780 In addition, you can use this with <a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a>
2781 to denote two commands for viewing an attachment, one to be viewed
2782 automatically, the other to be viewed interactively from the attachment
2783 menu. In addition, you can then use the test feature to determine which
2784 viewer to use interactively depending on your environment.
2785 </p><pre class="screen">
2786 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
2787 text/html; lynx %s; nametemplate=%s.html
2788 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
2790 For <a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a>, Mutt will choose the third
2791 entry because of the copiousoutput tag. For interactive viewing, Mutt
2792 will run the program RunningX to determine if it should use the first
2793 entry. If the program returns non-zero, Mutt will use the second entry
2794 for interactive viewing.
2795 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="mailcap-command-expansion"></a>3.3.3. Command Expansion</h4></div></div></div><p>
2796 The various commands defined in the mailcap files are passed to the
2797 <code class="literal">/bin/sh</code> shell using the system() function. Before the
2798 command is passed to <code class="literal">/bin/sh -c</code>, it is parsed to expand
2799 various special parameters with information from Mutt. The keywords
2801 </p><div class="variablelist"><dl><dt><span class="term">%s</span></dt><dd><p>
2802 As seen in the basic mailcap section, this variable is expanded
2803 to a filename specified by the calling program. This file contains
2804 the body of the message to view/print/edit or where the composing
2805 program should place the results of composition. In addition, the
2806 use of this keyword causes Mutt to not pass the body of the message
2807 to the view/print/edit program on stdin.
2808 </p></dd><dt><span class="term">%t</span></dt><dd><p>
2809 Mutt will expand %t to the text representation of the content
2810 type of the message in the same form as the first parameter of the
2811 mailcap definition line, ie <code class="literal">text/html</code> or
2812 <code class="literal">image/gif</code>.
2813 </p></dd><dt><span class="term">%{<parameter>}</span></dt><dd><p>
2814 Mutt will expand this to the value of the specified parameter
2815 from the Content-Type: line of the mail message. For instance, if
2816 Your mail message contains:
2817 </p><pre class="screen">
2818 Content-Type: text/plain; charset=iso-8859-1
2820 then Mutt will expand %{charset} to iso-8859-1. The default metamail
2821 mailcap file uses this feature to test the charset to spawn an xterm
2822 using the right charset to view the message.
2823 </p></dd><dt><span class="term">\%</span></dt><dd><p>
2824 This will be replaced by a %
2825 </p></dd></dl></div><p>
2826 Mutt does not currently support the %F and %n keywords
2827 specified in RFC 1524. The main purpose of these parameters is for
2828 multipart messages, which is handled internally by Mutt.
2829 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-example"></a>3.4. Example mailcap files</h3></div></div></div><p>
2830 This mailcap file is fairly simple and standard:
2831 </p><pre class="screen">
2832 # I'm always running X :)
2833 video/*; xanim %s > /dev/null
2834 image/*; xv %s > /dev/null
2836 # I'm always running netscape (if my computer had more memory, maybe)
2837 text/html; netscape -remote 'openURL(%s)'
2839 This mailcap file shows quite a number of examples:
2840 </p><pre class="screen">
2841 # Use xanim to view all videos Xanim produces a header on startup,
2842 # send that to /dev/null so I don't see it
2843 video/*; xanim %s > /dev/null
2845 # Send html to a running netscape by remote
2846 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
2848 # If I'm not running netscape but I am running X, start netscape on the
2850 text/html; netscape %s; test=RunningX
2852 # Else use lynx to view it as text
2855 # This version would convert the text/html to text/plain
2856 text/html; lynx -dump %s; copiousoutput
2858 # I use enscript to print text in two columns to a page
2859 text/*; more %s; print=enscript -2Gr %s
2861 # Netscape adds a flag to tell itself to view jpegs internally
2862 image/jpeg;xv %s; x-mozilla-flags=internal
2864 # Use xv to view images if I'm running X
2865 # In addition, this uses the \ to extend the line and set my editor
2867 image/*;xv %s; test=RunningX; \
2870 # Convert images to text using the netpbm tools
2871 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
2872 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
2874 # Send excel spreadsheets to my NT box
2875 application/ms-excel; open.pl %s
2876 </pre></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="auto-view"></a>4. MIME Autoview</h2></div></div></div><p>
2877 In addition to explicitly telling Mutt to view an attachment with the
2878 MIME viewer defined in the mailcap file, Mutt has support for
2879 automatically viewing MIME attachments while in the pager.
2881 To work, you must define a viewer in the mailcap file which uses the
2882 <code class="literal">copiousoutput</code> option to denote that it is non-interactive.
2883 Usually, you also use the entry to convert the attachment to a text
2884 representation which you can view in the pager.
2886 You then use the <code class="literal">auto_view</code> muttrc command to list the
2887 content-types that you wish to view automatically.
2889 For instance, if you set auto_view to:
2890 </p><pre class="screen">
2891 auto_view text/html application/x-gunzip \
2892 application/postscript image/gif application/x-tar-gz
2894 Mutt could use the following mailcap entries to automatically view
2895 attachments of these types.
2896 </p><pre class="screen">
2897 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
2898 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | \
2899 pgmtopbm | pbmtoascii ; copiousoutput
2900 application/x-gunzip; gzcat; copiousoutput
2901 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
2902 application/postscript; ps2ascii %s; copiousoutput
2904 “<span class="quote">unauto_view</span>” can be used to remove previous entries from the autoview list.
2905 This can be used with message-hook to autoview messages based on size, etc.
2906 “<span class="quote">unauto_view *</span>” will remove all previous entries.
2907 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alternative-order"></a>5. MIME Multipart/Alternative</h2></div></div></div><p>
2908 Mutt has some heuristics for determining which attachment of a
2909 multipart/alternative type to display. First, mutt will check the
2910 alternative_order list to determine if one of the available types
2911 is preferred. The alternative_order list consists of a number of
2912 mimetypes in order, including support for implicit and explicit
2913 wildcards, for example:
2914 </p><pre class="screen">
2915 alternative_order text/enriched text/plain text application/postscript image/*
2917 Next, mutt will check if any of the types have a defined
2918 <a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a>, and use that. Failing
2919 that, Mutt will look for any text type. As a last attempt, mutt will
2920 look for any type it knows how to handle.
2922 To remove a MIME type from the <code class="literal">alternative_order</code> list, use the
2923 <code class="literal">unalternative_order</code> command.
2924 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="attachments"></a>6. Attachment Searching and Counting</h2></div></div></div><p>
2925 If you ever lose track of attachments in your mailboxes, Mutt's
2926 attachment-counting and -searching support might be for you. You can
2927 make your message index display the number of qualifying attachments in
2928 each message, or search for messages by attachment count. You also can
2929 configure what kinds of attachments qualify for this feature with the
2930 attachments and unattachments commands.
2932 In order to provide this information, mutt needs to fully MIME-parse
2933 all messages affected first. This can slow down operation especially for
2934 remote mail folders such as IMAP because all messages have to be
2935 downloaded first regardless whether the user really wants to view them
2939 </p><pre class="screen">
2940 attachments {+|-}disposition mime-type
2941 unattachments {+|-}disposition mime-type
2944 Disposition is the attachment's Content-disposition type -- either
2945 <code class="literal">inline</code> or <code class="literal">attachment</code>.
2946 You can abbreviate this to <code class="literal">I</code> or <code class="literal">A</code>.
2948 Disposition is prefixed by either a + symbol or a - symbol. If it's
2949 a +, you're saying that you want to allow this disposition and MIME
2950 type to qualify. If it's a -, you're saying that this disposition
2951 and MIME type is an exception to previous + rules. There are examples
2952 below of how this is useful.
2954 Mime-type is, unsurprisingly, the MIME type of the attachment you want
2955 to affect. A MIME type is always of the format <code class="literal">major/minor</code>, where
2956 <code class="literal">major</code> describes the broad category of document you're looking at, and
2957 <code class="literal">minor</code> describes the specific type within that category. The major
2958 part of mime-type must be literal text (or the special token “<span class="quote"><code class="literal">*</code></span>”), but
2959 the minor part may be a regular expression. (Therefore, “<span class="quote"><code class="literal">*/.*</code></span>” matches
2962 The MIME types you give to the attachments directive are a kind of
2963 pattern. When you use the attachments directive, the patterns you
2964 specify are added to a list. When you use unattachments, the pattern
2965 is removed from the list. The patterns are not expanded and matched
2966 to specific MIME types at this time -- they're just text in a list.
2967 They're only matched when actually evaluating a message.
2969 Some examples might help to illustrate. The examples that are not
2970 commented out define the default configuration of the lists.
2971 </p><div class="example"><a id="ex-attach-count"></a><p class="title"><b>Example 5.1. Attachment counting</b></p><div class="example-contents"><pre class="screen">
2972 ## Removing a pattern from a list removes that pattern literally. It
2973 ## does not remove any type matching the pattern.
2975 ## attachments +A */.*
2976 ## attachments +A image/jpeg
2977 ## unattachments +A */.*
2979 ## This leaves "attached" image/jpeg files on the allowed attachments
2980 ## list. It does not remove all items, as you might expect, because the
2981 ## second */.* is not a matching expression at this time.
2983 ## Remember: "unattachments" only undoes what "attachments" has done!
2984 ## It does not trigger any matching on actual messages.
2987 ## Qualify any MIME part with an "attachment" disposition, EXCEPT for
2988 ## text/x-vcard and application/pgp parts. (PGP parts are already known
2989 ## to mutt, and can be searched for with ~g, ~G, and ~k.)
2991 ## I've added x-pkcs7 to this, since it functions (for S/MIME)
2992 ## analogously to PGP signature attachments. S/MIME isn't supported
2993 ## in a stock mutt build, but we can still treat it specially here.
2996 attachments -A text/x-vcard application/pgp.*
2997 attachments -A application/x-pkcs7-.*
2999 ## Discount all MIME parts with an "inline" disposition, unless they're
3000 ## text/plain. (Why inline a text/plain part unless it's external to the
3003 attachments +I text/plain
3005 ## These two lines make Mutt qualify MIME containers. (So, for example,
3006 ## a message/rfc822 forward will count as an attachment.) The first
3007 ## line is unnecessary if you already have "attach-allow */.*", of
3008 ## course. These are off by default! The MIME elements contained
3009 ## within a message/* or multipart/* are still examined, even if the
3010 ## containers themseves don't qualify.
3012 #attachments +A message/.* multipart/.*
3013 #attachments +I message/.* multipart/.*
3015 ## You probably don't really care to know about deleted attachments.
3016 attachments -A message/external-body
3017 attachments -I message/external-body
3018 </pre></div></div><br class="example-break" /><p>
3019 Entering the command “<span class="quote"><code class="literal">attachments ?</code></span>”
3020 as a command will list your current settings in Muttrc format, so that
3021 it can be pasted elsewhere.
3022 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-lookup"></a>7. MIME Lookup</h2></div></div></div><p>
3023 Mutt's mime_lookup list specifies a list of mime-types that should not
3024 be treated according to their mailcap entry. This option is designed to
3025 deal with binary types such as application/octet-stream. When an attachment's
3026 mime-type is listed in mime_lookup, then the extension of the filename will
3027 be compared to the list of extensions in the mime.types file. The mime-type
3028 associated with this extension will then be used to process the attachment
3029 according to the rules in the mailcap file and according to any other configuration
3030 options (such as auto_view) specified. Common usage would be:
3031 </p><pre class="screen">
3032 mime_lookup application/octet-stream application/X-Lotus-Manuscript
3034 In addition, the unmime_lookup command may be used to disable this feature
3035 for any particular mime-type if it had been set, for example, in a global
3037 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="optionalfeatures"></a>Chapter 6. Optional features</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#optionalfeatures-notes">1. General notes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#compile-time-features">1.1. Enabling/disabling features</a></span></dt><dt><span class="sect2"><a href="#url-syntax">1.2. URL syntax</a></span></dt></dl></dd><dt><span class="sect1"><a href="#ssl">2. SSL/TLS Support</a></span></dt><dt><span class="sect1"><a href="#pop">3. POP3 Support</a></span></dt><dt><span class="sect1"><a href="#imap">4. IMAP Support</a></span></dt><dd><dl><dt><span class="sect2"><a href="#imap-browser">4.1. The Folder Browser</a></span></dt><dt><span class="sect2"><a href="#imap-authentication">4.2. Authentication</a></span></dt></dl></dd><dt><span class="sect1"><a href="#smtp">5. SMTP Support</a></span></dt><dt><span class="sect1"><a href="#account-hook">6. Managing multiple accounts</a></span></dt><dt><span class="sect1"><a href="#caching">7. Local caching</a></span></dt><dd><dl><dt><span class="sect2"><a href="#header-caching">7.1. Header caching</a></span></dt><dt><span class="sect2"><a href="#body-caching">7.2. Body caching</a></span></dt><dt><span class="sect2"><a href="#maint-cache">7.3. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact address generation</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="optionalfeatures-notes"></a>1. General notes</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compile-time-features"></a>1.1. Enabling/disabling features</h3></div></div></div><p>
3038 Mutt supports several of optional features which can be enabled or
3039 disabled at compile-time by giving the <span class="emphasis"><em>configure</em></span> script
3040 certain arguments. These are listed in the “<span class="quote">Optional features</span>” section of
3041 the <span class="emphasis"><em>configure --help</em></span> output.
3043 Which features are enabled or disabled can later be determined from the
3044 output of <code class="literal">mutt -v</code>. If a compile option starts with
3045 “<span class="quote">+</span>” it is enabled and disabled if prefixed with “<span class="quote">-</span>”. For example, if
3046 mutt was compiled using GnuTLS for encrypted communication instead of
3047 OpenSSL, <code class="literal">mutt -v</code> would contain:
3048 </p><pre class="screen">
3049 -USE_SSL_OPENSSL +USE_SSL_GNUTLS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="url-syntax"></a>1.2. URL syntax</h3></div></div></div><p>
3050 Mutt optionally supports the IMAP, POP3 and SMTP protocols which require
3051 to access servers using URLs. The canonical syntax for specifying URLs
3052 in mutt is (an item enclosed in <code class="literal">[]</code> means it is optional and
3054 </p><pre class="screen">
3055 proto[s]://[username[:password]@]server[:port]/[path]
3057 <code class="literal">proto</code> is the communication protocol:
3058 <code class="literal">imap</code> for IMAP, <code class="literal">pop</code> for POP3 and
3059 <code class="literal">smtp</code> for SMTP. If “<span class="quote">s</span>” for “<span class="quote">secure communication</span>”
3060 is appended, mutt will attempt to establish an encrypted communication
3061 using SSL or TLS. If no explicit port is given, mutt will use the
3062 system's default for the given protocol.
3064 Since all protocols by mutt support authentication, the username may be
3065 given directly in the URL instead of using the <code class="literal">pop_user</code> or
3066 <code class="literal">imap_user</code> variables. It may contain the “<span class="quote">@</span>” symbol
3067 being used by many mail systems as part of the login name. A password can be
3068 given, too but is not recommended if the URL is specified in a configuration
3071 The optional path is only relevant for IMAP.
3073 For IMAP for example, you can select an alternative port by specifying it with the
3074 server: <code class="literal">imap://imapserver:port/INBOX</code>. You can also specify different
3075 username for each folder: <code class="literal">imap://username@imapserver[:port]/INBOX</code>
3076 or <code class="literal">imap://username2@imapserver[:port]/path/to/folder</code>.
3077 Replacing <code class="literal">imap://</code> by <code class="literal">imaps://</code>
3078 would make mutt attempt to connect using SSL or TLS on a different port
3079 to encrypt the communication.
3080 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ssl"></a>2. SSL/TLS Support</h2></div></div></div><p>
3081 If mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
3082 compiled with support for SSL or TLS using either OpenSSL or GnuTLS (
3083 by running the <span class="emphasis"><em>configure</em></span> script with the
3084 <span class="emphasis"><em>--enable-ssl=...</em></span> option for OpenSSL or
3085 <span class="emphasis"><em>--enable-gnutls=...</em></span> for GnuTLS). Mutt can then
3086 attempt to encrypt communication with remote servers if these protocols
3087 are suffixed with “<span class="quote">s</span>” for “<span class="quote">secure communication</span>”.
3088 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="pop"></a>3. POP3 Support</h2></div></div></div><p>
3089 If Mutt was compiled with POP3 support (by running the <span class="emphasis"><em>configure</em></span>
3090 script with the <span class="emphasis"><em>--enable-pop</em></span> flag), it has the ability to work
3091 with mailboxes located on a remote POP3 server and fetch mail for local
3094 Remote POP3 servers can be accessed using URLs with the <code class="literal">pop</code> protocol
3095 for unencrypted and <code class="literal">pops</code> for encrypted
3096 communication, see <a class="xref" href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a> for details.
3098 Polling for new mail is more expensive over POP3 than locally. For this
3099 reason the frequency at which Mutt will check for mail remotely can be
3101 <a class="link" href="#pop-checkinterval" title="3.216. pop_checkinterval">$pop_checkinterval</a>
3102 variable, which defaults to every 60 seconds.
3103 </p><a id="fetch-mail"></a><p>
3104 Another way to access your POP3 mail is the <code class="literal"><fetch-mail$</code> function
3105 (default: G). It allows to connect to <a class="link" href="#pop-host" title="3.218. pop_host">$pop_host</a>, fetch all your new mail and place it in the
3106 local <a class="link" href="#spoolfile" title="3.277. spoolfile">$spoolfile</a>. After this
3107 point, Mutt runs exactly as if the mail had always been local.
3108 </p><div class="note"><h3 class="title">Note</h3><p>
3109 If you only need to fetch all messages to a
3110 local mailbox you should consider using a specialized program, such as
3111 <code class="literal">fetchmail</code>, <code class="literal">getmail</code> or similar.
3112 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="imap"></a>4. IMAP Support</h2></div></div></div><p>
3113 If Mutt was compiled with IMAP support (by running the <span class="emphasis"><em>configure</em></span>
3114 script with the <span class="emphasis"><em>--enable-imap</em></span> flag), it has the ability to work
3115 with folders located on a remote IMAP server.
3117 You can access the remote inbox by selecting the folder by its URL
3118 (see <a class="xref" href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a> for details) using the
3119 <code class="literal">imap</code> or <code class="literal">imaps</code> protocol.
3120 Alternatively, a pine-compatible notation is also supported, ie
3121 <code class="literal">{[username@]imapserver[:port][/ssl]}path/to/folder</code>
3123 Note that not all servers use “<span class="quote">/</span>” as the hierarchy separator. Mutt should
3124 correctly notice which separator is being used by the server and convert
3127 When browsing folders on an IMAP server, you can toggle whether to look
3128 at only the folders you are subscribed to, or all folders with the
3129 <span class="emphasis"><em>toggle-subscribed</em></span> command. See also the
3130 <a class="link" href="#imap-list-subscribed" title="3.89. imap_list_subscribed">$imap_list_subscribed</a> variable.
3132 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
3133 want to carefully tune the
3134 <a class="link" href="#mail-check" title="3.105. mail_check">$mail_check</a>
3136 <a class="link" href="#timeout" title="3.288. timeout">$timeout</a>
3137 variables. Personally I use
3138 </p><pre class="screen">
3142 with relatively good results over my slow modem line.
3143 </p><div class="note"><h3 class="title">Note</h3><p>
3144 Note that if you are using mbox as the mail store on UW servers prior to
3145 v12.250, the server has been reported to disconnect a client if another client
3146 selects the same folder.
3147 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-browser"></a>4.1. The Folder Browser</h3></div></div></div><p>
3148 As of version 1.2, mutt supports browsing mailboxes on an IMAP
3149 server. This is mostly the same as the local file browser, with the
3150 following differences:
3151 </p><div class="itemizedlist"><ul type="disc"><li><p>
3152 In lieu of file permissions, mutt displays the string "IMAP",
3153 possibly followed by the symbol "+", indicating
3154 that the entry contains both messages and subfolders. On
3155 Cyrus-like servers folders will often contain both messages and
3158 For the case where an entry can contain both messages and
3159 subfolders, the selection key (bound to <code class="literal">enter</code> by default)
3160 will choose to descend into the subfolder view. If you wish to view
3161 the messages in that folder, you must use <code class="literal">view-file</code> instead
3162 (bound to <code class="literal">space</code> by default).
3164 You can create, delete and rename mailboxes with the
3165 <code class="literal">create-mailbox</code>, <code class="literal">delete-mailbox</code>, and
3166 <code class="literal">rename-mailbox</code> commands (default bindings: <code class="literal">C</code>,
3167 <code class="literal">d</code> and <code class="literal">r</code>, respectively). You may also
3168 <code class="literal">subscribe</code> and <code class="literal">unsubscribe</code> to mailboxes (normally
3169 these are bound to <code class="literal">s</code> and <code class="literal">u</code>, respectively).
3170 </p></li></ul></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-authentication"></a>4.2. Authentication</h3></div></div></div><p>
3171 Mutt supports four authentication methods with IMAP servers: SASL,
3172 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
3173 NTLM authentication for you poor exchange users out there, but it has
3174 yet to be integrated into the main tree). There is also support for
3175 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
3176 IMAP server without having an account. To use ANONYMOUS, simply make
3177 your username blank or "anonymous".
3179 SASL is a special super-authenticator, which selects among several protocols
3180 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
3181 method available on your host and the server. Using some of these methods
3182 (including DIGEST-MD5 and possibly GSSAPI), your entire session will be
3183 encrypted and invisible to those teeming network snoops. It is the best
3184 option if you have it. To use it, you must have the Cyrus SASL library
3185 installed on your system and compile mutt with the <span class="emphasis"><em>--with-sasl</em></span> flag.
3187 Mutt will try whichever methods are compiled in and available on the server,
3188 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
3190 There are a few variables which control authentication:
3191 </p><div class="itemizedlist"><ul type="disc"><li><p>
3192 <a class="link" href="#imap-user" title="3.96. imap_user">$imap_user</a> - controls
3193 the username under which you request authentication on the IMAP server,
3194 for all authenticators. This is overridden by an explicit username in
3195 the mailbox path (ie by using a mailbox name of the form
3196 <code class="literal">{user@host}</code>).
3198 <a class="link" href="#imap-pass" title="3.91. imap_pass">$imap_pass</a> - a
3199 password which you may preset, used by all authentication methods where
3200 a password is needed.
3202 <a class="link" href="#imap-authenticators" title="3.83. imap_authenticators">$imap_authenticators</a> - a colon-delimited list of IMAP
3203 authentication methods to try, in the order you wish to try them. If
3204 specified, this overrides mutt's default (attempt everything, in the order
3206 </p></li></ul></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="smtp"></a>5. SMTP Support</h2></div></div></div><p>
3207 Besides supporting traditional mail delivery through a
3208 sendmail-compatible program, mutt supports delivery through SMTP if it
3209 was configured and built with <code class="literal">--enable-smtp</code>.
3211 If the configuration variable
3212 <a class="link" href="#smtp-url" title="3.270. smtp_url">$smtp_url</a> is set, mutt
3213 will contact the given SMTP server to deliver messages; if it is unset,
3214 mutt will use the program specified by <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a>.
3216 For details on the URL syntax, please see <a class="xref" href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a>.
3218 The built-in SMTP support supports encryption (the <code class="literal">smtps</code> protocol
3219 using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms
3220 for SASL are specified in <a class="link" href="#smtp-authenticators" title="3.268. smtp_authenticators">$smtp_authenticators</a>
3221 defaulting to an empty list which makes mutt try all available methods
3222 from most-secure to least-secure.
3223 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="account-hook"></a>6. Managing multiple accounts</h2></div></div></div><p>
3224 If you happen to have accounts on multiple IMAP, POP and/or SMTP servers,
3225 you may find managing all the authentication settings inconvenient and
3226 error-prone. The account-hook command may help. This hook works like
3227 folder-hook but is invoked whenever you access a remote mailbox
3228 (including inside the folder browser), not just when you open the
3229 mailbox which includes (for example) polling for new mail, storing Fcc
3230 messages and saving messages to a folder. As a consequence,
3231 account-hook should only be used to set connection-related settings such
3232 as passwords or tunnel commands but not settings such as sender
3233 address or name (because in general it should be considered unpredictable
3234 which account-hook was last used).
3237 </p><pre class="screen">
3238 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
3239 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
3240 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
3241 account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
3242 </pre></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="caching"></a>7. Local caching</h2></div></div></div><p>
3243 Mutt contains two types of local caching: <span class="emphasis"><em>(1)</em></span>
3244 the so-called “<span class="quote">header caching</span>” and <span class="emphasis"><em>(2)</em></span> the
3245 so-called “<span class="quote">body caching</span>” which are both described in this section.
3247 Header caching is optional as it depends on external libraries, body
3248 caching is always enabled if mutt is compiled with POP and/or IMAP
3249 support as these use it (body caching requires no external library).
3250 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-caching"></a>7.1. Header caching</h3></div></div></div><p>
3251 Mutt provides optional support for caching message headers for the
3252 following types of folders: IMAP, POP, Maildir and MH. Header caching
3253 greatly improves speed because for remote folders, headers
3254 usually only need to be downloaded once. For Maildir and MH, reading the
3255 headers from a single file is much faster than looking at possibly
3256 thousands of single files (since Maildir and MH use one file per message.)
3258 Header caching can be enabled via the configure script and the
3259 <span class="emphasis"><em>--enable-hcache</em></span> option. It's not turned on
3260 by default because external database libraries are required: one
3261 of tokyocabinet, qdbm, gdbm or bdb must be present.
3263 If enabled, <a class="link" href="#header-cache" title="3.108. header_cache">$header_cache</a> can be
3264 used to either point to a file or a directory. If set to point to
3265 a file, one database file for all folders will be used (which may
3266 result in lower performance), but one file per folder if it points
3269 For the one-file-per-folder case, database files for remote folders
3270 will be named according to their URL while database files for local
3271 folders will be named by the MD5 checksums of their path. These database
3272 files may be safely removed if a system is short on space. You
3273 can compute the name of the header cache file for a particular local folder
3274 through a command like the following:
3275 </p><pre class="screen">
3276 $ printf '%s' '/path/to/folder' | md5sum
3278 The <code class="literal">md5sum</code> command may also be
3279 named <code class="literal">md5</code>, depending on your operating system.
3280 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="body-caching"></a>7.2. Body caching</h3></div></div></div><p>
3281 Both cache methods can be combined using the same directory for storage
3282 (and for IMAP/POP even provide meaningful file names) which simplifies
3283 manual maintenance tasks.
3285 In addition to caching message headers only, mutt can also cache
3286 whole message bodies. This results in faster display of messages
3287 for POP and IMAP folders because messages usually have to be
3288 downloaded only once.
3290 For configuration, the variable <a class="link" href="#message-cachedir" title="3.133. message_cachedir">$message_cachedir</a> must point to a
3291 directory. There, mutt will create a hierarchy of subdirectories
3292 named like: <code class="literal">proto:user@hostname</code> where
3293 <code class="literal">proto</code> is either “<span class="quote">pop</span>” or “<span class="quote">imap.</span>” Within
3294 there for each folder, mutt stores messages in single files (just
3295 like Maildir) so that with manual symlink creation these cache
3296 directories can be examined with mutt as read-only Maildir folders.
3298 All files can be removed as needed if the consumed disk space
3299 becomes an issue as mutt will silently fetch missing items again.
3300 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maint-cache"></a>7.3. Maintenance</h3></div></div></div><p>
3301 Mutt does not (yet) support maintenance features for header cache
3302 database files so that files have to be removed in case they grow too
3303 big. It depends on the database library used for header caching whether
3304 disk space freed by removing messages is re-used.
3306 For body caches, mutt can keep the local cache in sync with the
3307 remote mailbox if the
3308 <a class="link" href="#message-cache-clean" title="3.134. message_cache_clean">$message_cache_clean</a>
3309 variable is set. Cleaning means to remove messages from the cache which
3310 are no longer present in the mailbox which only happens when other mail
3311 clients or instances of mutt using a different body cache location
3312 delete messages (Mutt itself removes deleted messages from the cache
3313 when syncing a mailbox). As cleaning can take a noticeable amount of time,
3314 it should not be set in general but only occasionally.
3315 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="exact-address"></a>8. Exact address generation</h2></div></div></div><p>
3316 Mutt supports the “<span class="quote">Name <user@host></span>” address syntax for reading and
3317 writing messages, the older “<span class="quote">user@host (Name)</span>” syntax is only supported when
3318 reading messages. The <span class="emphasis"><em>--enable-exact-address</em></span>
3319 switch can be given to configure to build it with write-support
3320 for the latter syntax. <code class="literal">EXACT_ADDRESS</code> in the output of
3321 <code class="literal">mutt -v</code> indicates whether it's supported.
3322 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="tuning"></a>Chapter 7. Performance tuning</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#tuning-mailboxes">1. Reading and writing mailboxes</a></span></dt><dt><span class="sect1"><a href="#tuning-messages">2. Reading messages from remote folders</a></span></dt><dt><span class="sect1"><a href="#tuning-search">3. Searching and limiting</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-mailboxes"></a>1. Reading and writing mailboxes</h2></div></div></div><p>
3323 Mutt's performance when reading mailboxes can be improved in two ways:
3324 </p><div class="orderedlist"><ol type="1"><li><p>
3325 For remote folders (IMAP and POP) as well as folders using
3326 one-file-per message storage (Maildir and MH), mutt's
3327 performance can be greatly improved using
3328 <a class="link" href="#header-caching" title="7.1. Header caching">header caching</a>.
3329 Using a single database per folder may further increase
3332 Mutt provides the <a class="link" href="#read-inc" title="3.236. read_inc">$read_inc</a>
3333 and <a class="link" href="#write-inc" title="3.305. write_inc">$write_inc</a>
3334 variables to specify at which rate to update progress
3335 counters. If these values are too low, mutt may spend more
3336 time on updating the progress counter than it spends on
3337 actually reading/writing folders.
3339 For example, when opening a maildir folder with a few
3340 thousand messages, the default value for
3341 <a class="link" href="#read-inc" title="3.236. read_inc">$read_inc</a>
3342 may be too low. It can be tuned on on a folder-basis using
3343 <a class="link" href="#folder-hook" title="7. Setting variables based upon mailbox">folder-hooks</a>:
3344 </p><pre class="screen">
3345 # use very high $read_inc to speed up reading hcache'd maildirs
3346 folder-hook . 'set read_inc=1000'
3347 # use lower value for reading slower remote IMAP folders
3348 folder-hook ^imap 'set read_inc=100'
3349 # use even lower value for reading even slower remote POP folders
3350 folder-hook ^pop 'set read_inc=1'</pre></li></ol></div><p>These settings work on a per-message basis. However, as messages may
3351 greatly differ in size and certain operations are much faster than others,
3352 even per-folder settings of the increment variables may not be
3353 desirable as they produce either too few or too much progress updates.
3354 Thus, Mutt allows to limit the number of progress updates per second it'll
3355 actually send to the terminal using the
3356 <a class="link" href="#time-inc" title="3.287. time_inc">$time_inc</a> variable.</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-messages"></a>2. Reading messages from remote folders</h2></div></div></div><p>
3357 Reading messages from remote folders such as IMAP an POP can be
3358 slow especially for large mailboxes since mutt only caches a very
3359 limited number of recently viewed messages (usually 10) per
3360 session (so that it will be gone for the next session.)
3362 To improve performance and permanently cache whole messages,
3363 please refer to mutt's so-called
3364 <a class="link" href="#body-caching" title="7.2. Body caching">body caching</a> for details.
3365 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-search"></a>3. Searching and limiting</h2></div></div></div><p>
3366 When searching mailboxes either via a search or a limit action, for
3367 some patterns mutt distinguishes between regular expression and string
3368 searches. For regular expressions, patterns are prefixed with
3369 “<span class="quote">˜</span>” and with “<span class="quote">=</span>” for string searches.
3371 Even though a regular expression search is fast, it's several times
3372 slower than a pure string search which is noticeable especially on large
3373 folders. As a consequence, a string search should be used instead of a
3374 regular expression search if the user already knows enough about the
3377 For example, when limiting a large folder to all messages sent to or by
3378 an author, it's much faster to search for the initial part of an e-mail
3379 address via <code class="literal">=Luser@</code> instead of
3380 <code class="literal">˜Luser@</code>. This is especially true for searching
3381 message bodies since a larger amount of input has to be searched.
3383 Please note that string search is an exact case-sensitive search
3384 while a regular expression search with only lower-case letters performs
3385 a case-insensitive search.
3386 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="reference"></a>Chapter 8. Reference</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#commandline">1. Command line options</a></span></dt><dt><span class="sect1"><a href="#commands">2. Configuration Commands</a></span></dt><dt><span class="sect1"><a href="#variables">3. Configuration variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#abort-nosubject">3.1. abort_nosubject</a></span></dt><dt><span class="sect2"><a href="#abort-unmodified">3.2. abort_unmodified</a></span></dt><dt><span class="sect2"><a href="#alias-file">3.3. alias_file</a></span></dt><dt><span class="sect2"><a href="#alias-format">3.4. alias_format</a></span></dt><dt><span class="sect2"><a href="#allow-8bit">3.5. allow_8bit</a></span></dt><dt><span class="sect2"><a href="#allow-ansi">3.6. allow_ansi</a></span></dt><dt><span class="sect2"><a href="#arrow-cursor">3.7. arrow_cursor</a></span></dt><dt><span class="sect2"><a href="#ascii-chars">3.8. ascii_chars</a></span></dt><dt><span class="sect2"><a href="#askbcc">3.9. askbcc</a></span></dt><dt><span class="sect2"><a href="#askcc">3.10. askcc</a></span></dt><dt><span class="sect2"><a href="#assumed-charset">3.11. assumed_charset</a></span></dt><dt><span class="sect2"><a href="#attach-charset">3.12. attach_charset</a></span></dt><dt><span class="sect2"><a href="#attach-format">3.13. attach_format</a></span></dt><dt><span class="sect2"><a href="#attach-sep">3.14. attach_sep</a></span></dt><dt><span class="sect2"><a href="#attach-split">3.15. attach_split</a></span></dt><dt><span class="sect2"><a href="#attribution">3.16. attribution</a></span></dt><dt><span class="sect2"><a href="#autoedit">3.17. autoedit</a></span></dt><dt><span class="sect2"><a href="#auto-tag">3.18. auto_tag</a></span></dt><dt><span class="sect2"><a href="#beep">3.19. beep</a></span></dt><dt><span class="sect2"><a href="#beep-new">3.20. beep_new</a></span></dt><dt><span class="sect2"><a href="#bounce">3.21. bounce</a></span></dt><dt><span class="sect2"><a href="#bounce-delivered">3.22. bounce_delivered</a></span></dt><dt><span class="sect2"><a href="#braille-friendly">3.23. braille_friendly</a></span></dt><dt><span class="sect2"><a href="#check-mbox-size">3.24. check_mbox_size</a></span></dt><dt><span class="sect2"><a href="#charset">3.25. charset</a></span></dt><dt><span class="sect2"><a href="#check-new">3.26. check_new</a></span></dt><dt><span class="sect2"><a href="#collapse-unread">3.27. collapse_unread</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.28. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#compose-format">3.29. compose_format</a></span></dt><dt><span class="sect2"><a href="#config-charset">3.30. config_charset</a></span></dt><dt><span class="sect2"><a href="#confirmappend">3.31. confirmappend</a></span></dt><dt><span class="sect2"><a href="#confirmcreate">3.32. confirmcreate</a></span></dt><dt><span class="sect2"><a href="#connect-timeout">3.33. connect_timeout</a></span></dt><dt><span class="sect2"><a href="#content-type">3.34. content_type</a></span></dt><dt><span class="sect2"><a href="#copy">3.35. copy</a></span></dt><dt><span class="sect2"><a href="#crypt-use-gpgme">3.36. crypt_use_gpgme</a></span></dt><dt><span class="sect2"><a href="#crypt-use-pka">3.37. crypt_use_pka</a></span></dt><dt><span class="sect2"><a href="#crypt-autopgp">3.38. crypt_autopgp</a></span></dt><dt><span class="sect2"><a href="#crypt-autosmime">3.39. crypt_autosmime</a></span></dt><dt><span class="sect2"><a href="#date-format">3.40. date_format</a></span></dt><dt><span class="sect2"><a href="#default-hook">3.41. default_hook</a></span></dt><dt><span class="sect2"><a href="#delete">3.42. delete</a></span></dt><dt><span class="sect2"><a href="#delete-untag">3.43. delete_untag</a></span></dt><dt><span class="sect2"><a href="#digest-collapse">3.44. digest_collapse</a></span></dt><dt><span class="sect2"><a href="#display-filter">3.45. display_filter</a></span></dt><dt><span class="sect2"><a href="#dotlock-program">3.46. dotlock_program</a></span></dt><dt><span class="sect2"><a href="#dsn-notify">3.47. dsn_notify</a></span></dt><dt><span class="sect2"><a href="#dsn-return">3.48. dsn_return</a></span></dt><dt><span class="sect2"><a href="#duplicate-threads">3.49. duplicate_threads</a></span></dt><dt><span class="sect2"><a href="#edit-headers">3.50. edit_headers</a></span></dt><dt><span class="sect2"><a href="#editor">3.51. editor</a></span></dt><dt><span class="sect2"><a href="#encode-from">3.52. encode_from</a></span></dt><dt><span class="sect2"><a href="#envelope-from-address">3.53. envelope_from_address</a></span></dt><dt><span class="sect2"><a href="#escape">3.54. escape</a></span></dt><dt><span class="sect2"><a href="#fast-reply">3.55. fast_reply</a></span></dt><dt><span class="sect2"><a href="#fcc-attach">3.56. fcc_attach</a></span></dt><dt><span class="sect2"><a href="#fcc-clear">3.57. fcc_clear</a></span></dt><dt><span class="sect2"><a href="#folder">3.58. folder</a></span></dt><dt><span class="sect2"><a href="#folder-format">3.59. folder_format</a></span></dt><dt><span class="sect2"><a href="#followup-to">3.60. followup_to</a></span></dt><dt><span class="sect2"><a href="#force-name">3.61. force_name</a></span></dt><dt><span class="sect2"><a href="#forward-decode">3.62. forward_decode</a></span></dt><dt><span class="sect2"><a href="#forward-edit">3.63. forward_edit</a></span></dt><dt><span class="sect2"><a href="#forward-format">3.64. forward_format</a></span></dt><dt><span class="sect2"><a href="#forward-quote">3.65. forward_quote</a></span></dt><dt><span class="sect2"><a href="#from">3.66. from</a></span></dt><dt><span class="sect2"><a href="#gecos-mask">3.67. gecos_mask</a></span></dt><dt><span class="sect2"><a href="#hdrs">3.68. hdrs</a></span></dt><dt><span class="sect2"><a href="#header">3.69. header</a></span></dt><dt><span class="sect2"><a href="#help">3.70. help</a></span></dt><dt><span class="sect2"><a href="#hidden-host">3.71. hidden_host</a></span></dt><dt><span class="sect2"><a href="#hide-limited">3.72. hide_limited</a></span></dt><dt><span class="sect2"><a href="#hide-missing">3.73. hide_missing</a></span></dt><dt><span class="sect2"><a href="#hide-thread-subject">3.74. hide_thread_subject</a></span></dt><dt><span class="sect2"><a href="#hide-top-limited">3.75. hide_top_limited</a></span></dt><dt><span class="sect2"><a href="#hide-top-missing">3.76. hide_top_missing</a></span></dt><dt><span class="sect2"><a href="#history">3.77. history</a></span></dt><dt><span class="sect2"><a href="#history-file">3.78. history_file</a></span></dt><dt><span class="sect2"><a href="#honor-followup-to">3.79. honor_followup_to</a></span></dt><dt><span class="sect2"><a href="#hostname">3.80. hostname</a></span></dt><dt><span class="sect2"><a href="#ignore-linear-white-space">3.81. ignore_linear_white_space</a></span></dt><dt><span class="sect2"><a href="#ignore-list-reply-to">3.82. ignore_list_reply_to</a></span></dt><dt><span class="sect2"><a href="#imap-authenticators">3.83. imap_authenticators</a></span></dt><dt><span class="sect2"><a href="#imap-check-subscribed">3.84. imap_check_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-delim-chars">3.85. imap_delim_chars</a></span></dt><dt><span class="sect2"><a href="#imap-headers">3.86. imap_headers</a></span></dt><dt><span class="sect2"><a href="#imap-idle">3.87. imap_idle</a></span></dt><dt><span class="sect2"><a href="#imap-keepalive">3.88. imap_keepalive</a></span></dt><dt><span class="sect2"><a href="#imap-list-subscribed">3.89. imap_list_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-login">3.90. imap_login</a></span></dt><dt><span class="sect2"><a href="#imap-pass">3.91. imap_pass</a></span></dt><dt><span class="sect2"><a href="#imap-passive">3.92. imap_passive</a></span></dt><dt><span class="sect2"><a href="#imap-peek">3.93. imap_peek</a></span></dt><dt><span class="sect2"><a href="#imap-pipeline-depth">3.94. imap_pipeline_depth</a></span></dt><dt><span class="sect2"><a href="#imap-servernoise">3.95. imap_servernoise</a></span></dt><dt><span class="sect2"><a href="#imap-user">3.96. imap_user</a></span></dt><dt><span class="sect2"><a href="#implicit-autoview">3.97. implicit_autoview</a></span></dt><dt><span class="sect2"><a href="#include">3.98. include</a></span></dt><dt><span class="sect2"><a href="#include-onlyfirst">3.99. include_onlyfirst</a></span></dt><dt><span class="sect2"><a href="#indent-string">3.100. indent_string</a></span></dt><dt><span class="sect2"><a href="#index-format">3.101. index_format</a></span></dt><dt><span class="sect2"><a href="#ispell">3.102. ispell</a></span></dt><dt><span class="sect2"><a href="#keep-flagged">3.103. keep_flagged</a></span></dt><dt><span class="sect2"><a href="#locale">3.104. locale</a></span></dt><dt><span class="sect2"><a href="#mail-check">3.105. mail_check</a></span></dt><dt><span class="sect2"><a href="#mailcap-path">3.106. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.107. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#header-cache">3.108. header_cache</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.109. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#header-cache-pagesize">3.110. header_cache_pagesize</a></span></dt><dt><span class="sect2"><a href="#header-cache-compress">3.111. header_cache_compress</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.112. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.113. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.114. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.115. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.116. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.117. mbox_type</a></span></dt><dt><span class="sect2"><a href="#metoo">3.118. metoo</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.119. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.120. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.121. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.122. meta_key</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.123. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.124. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.125. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.126. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.127. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.128. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.129. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.130. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.131. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.132. move</a></span></dt><dt><span class="sect2"><a href="#message-cachedir">3.133. message_cachedir</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.134. message_cache_clean</a></span></dt><dt><span class="sect2"><a href="#message-format">3.135. message_format</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.136. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.137. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.138. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.139. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.140. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.141. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.142. pager_stop</a></span></dt><dt><span class="sect2"><a href="#crypt-autosign">3.143. crypt_autosign</a></span></dt><dt><span class="sect2"><a href="#crypt-autoencrypt">3.144. crypt_autoencrypt</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.145. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#crypt-replyencrypt">3.146. crypt_replyencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-replysign">3.147. crypt_replysign</a></span></dt><dt><span class="sect2"><a href="#crypt-replysignencrypted">3.148. crypt_replysignencrypted</a></span></dt><dt><span class="sect2"><a href="#crypt-timestamp">3.149. crypt_timestamp</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.150. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#crypt-verify-sig">3.151. crypt_verify_sig</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.152. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.153. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.154. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.155. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.156. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.157. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.158. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.159. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.160. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.161. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.162. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.163. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.164. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.165. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.166. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.167. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.168. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.169. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.170. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.171. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.172. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.173. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.174. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.175. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.176. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.177. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.178. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.179. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.180. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.181. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#forward-decrypt">3.182. forward_decrypt</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.183. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.184. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.185. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.186. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.187. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.188. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.189. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.190. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.191. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.192. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.193. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.194. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.195. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.196. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.197. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.198. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.199. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.200. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.201. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.202. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#certificate-file">3.203. certificate_file</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.204. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#entropy-file">3.205. entropy_file</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.206. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.207. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.208. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.209. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.210. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.211. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.212. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.213. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.214. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.215. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.216. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.217. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.218. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.219. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.220. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.221. pop_user</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.222. pop_pass</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.223. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.224. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.225. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.226. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.227. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.228. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.229. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.230. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.231. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.232. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.233. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.234. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.235. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.236. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.237. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.238. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.239. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.240. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.241. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.242. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.243. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.244. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.245. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.246. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.247. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.248. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.249. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.250. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.251. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.252. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.253. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.254. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.255. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.256. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.257. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.258. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.259. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.260. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.261. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.262. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.263. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.264. simple_search</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.265. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.266. smileys</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.267. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.268. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.269. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.270. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.271. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.272. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.273. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.274. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.275. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.276. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.277. spoolfile</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.278. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.279. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.280. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.281. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.282. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.283. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.284. thread_received</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.285. thorough_search</a></span></dt><dt><span class="sect2"><a href="#tilde">3.286. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.287. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.288. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.289. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.290. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.291. tunnel</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.292. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.293. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.294. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.295. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.296. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.297. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.298. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.299. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.300. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.301. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.302. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.303. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.304. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.305. write_inc</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.306. write_bcc</a></span></dt></dl></dd><dt><span class="sect1"><a href="#functions">4. Functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="#generic_map">4.1. generic menu</a></span></dt><dt><span class="sect2"><a href="#index_map">4.2. index menu</a></span></dt><dt><span class="sect2"><a href="#pager_map">4.3. pager menu</a></span></dt><dt><span class="sect2"><a href="#alias_map">4.4. alias menu</a></span></dt><dt><span class="sect2"><a href="#query_map">4.5. query menu</a></span></dt><dt><span class="sect2"><a href="#attach_map">4.6. attach menu</a></span></dt><dt><span class="sect2"><a href="#compose_map">4.7. compose menu</a></span></dt><dt><span class="sect2"><a href="#postpone_map">4.8. postpone menu</a></span></dt><dt><span class="sect2"><a href="#browser_map">4.9. browser menu</a></span></dt><dt><span class="sect2"><a href="#pgp_map">4.10. pgp menu</a></span></dt><dt><span class="sect2"><a href="#smime_map">4.11. smime menu</a></span></dt><dt><span class="sect2"><a href="#mix_map">4.12. mix menu</a></span></dt><dt><span class="sect2"><a href="#editor_map">4.13. editor menu</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commandline"></a>1. Command line options</h2></div></div></div><p>
3387 Running <code class="literal">mutt</code> with no arguments will make Mutt attempt to read your spool
3388 mailbox. However, it is possible to read other mailboxes and
3389 to send messages from the command line as well.
3390 </p><div class="table"><a id="tab-commandline-options"></a><p class="title"><b>Table 8.1. Command line options</b></p><div class="table-contents"><table summary="Command line options" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td>-A</td><td>expand an alias</td></tr><tr><td>-a</td><td>attach a file to a message</td></tr><tr><td>-b</td><td>specify a blind carbon-copy (BCC) address</td></tr><tr><td>-c</td><td>specify a carbon-copy (Cc) address</td></tr><tr><td>-D</td><td>print the value of all mutt variables to stdout</td></tr><tr><td>-e</td><td>specify a config command to be run after initialization files are read</td></tr><tr><td>-f</td><td>specify a mailbox to load</td></tr><tr><td>-F</td><td>specify an alternate file to read initialization commands</td></tr><tr><td>-h</td><td>print help on command line options</td></tr><tr><td>-H</td><td>specify a draft file from which to read a header and body</td></tr><tr><td>-i</td><td>specify a file to include in a message composition</td></tr><tr><td>-m</td><td>specify a default mailbox type</td></tr><tr><td>-n</td><td>do not read the system Muttrc</td></tr><tr><td>-p</td><td>recall a postponed message</td></tr><tr><td>-Q</td><td>query a configuration variable</td></tr><tr><td>-R</td><td>open mailbox in read-only mode</td></tr><tr><td>-s</td><td>specify a subject (enclose in quotes if it contains spaces)</td></tr><tr><td>-v</td><td>show version number and compile-time definitions</td></tr><tr><td>-x</td><td>simulate the mailx(1) compose mode</td></tr><tr><td>-y</td><td>show a menu containing the files specified by the mailboxes command</td></tr><tr><td>-z</td><td>exit immediately if there are no messages in the mailbox</td></tr><tr><td>-Z</td><td>open the first folder with new message,exit immediately if none</td></tr></tbody></table></div></div><br class="table-break" /><p>
3391 To read messages in a mailbox
3392 </p><div class="cmdsynopsis"><p><code class="command">mutt</code> [<code class="option">-nz</code>] [<code class="option">-F</code>
3393 <em class="replaceable"><code>muttrc</code></em>
3394 ] [<code class="option">-m</code>
3395 <em class="replaceable"><code>type</code></em>
3396 ] [<code class="option">-f</code>
3397 <em class="replaceable"><code>mailbox</code></em>
3399 To compose a new message
3400 </p><div class="cmdsynopsis"><p><code class="command">mutt</code> [<code class="option">-n</code>] [<code class="option">-F</code>
3401 <em class="replaceable"><code>muttrc</code></em>
3402 ] [<code class="option">-a</code>
3403 <em class="replaceable"><code>file</code></em>
3404 ] [<code class="option">-c</code>
3405 <em class="replaceable"><code>address</code></em>
3406 ] [<code class="option">-i</code>
3407 <em class="replaceable"><code>filename</code></em>
3408 ] [<code class="option">-s</code>
3409 <em class="replaceable"><code>subject</code></em>
3412 <em class="replaceable"><code>file</code></em>
3416 <em class="replaceable"><code>address</code></em>
3418 <em class="replaceable"><code>address</code></em>
3420 Mutt also supports a “<span class="quote">batch</span>” mode to send prepared messages. Simply redirect
3421 input from the file you wish to send. For example,
3423 <code class="literal">mutt -s "data set for run #2" professor@bigschool.edu
3424 < ˜/run2.dat</code>
3426 This command will send a message to “<span class="quote">professor@bigschool.edu</span>” with a subject
3427 of “<span class="quote">data set for run #2</span>”. In the body of the message will be the contents
3428 of the file “<span class="quote">˜/run2.dat</span>”.
3430 All files passed with -a <span class="emphasis"><em>file</em></span> will be attached as a MIME
3431 part to the message. To attach several files, use “<span class="quote">--</span>” to separate files and
3432 recipient addresses: <code class="literal">mutt -a *.png -- some@one.org</code>
3433 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commands"></a>2. Configuration Commands</h2></div></div></div><p>
3434 The following are the commands understood by mutt.
3435 </p><div class="itemizedlist"><ul type="disc"><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#account-hook" title="6. Managing multiple accounts">account-hook</a></code>
3436 <em class="replaceable"><code>pattern</code></em>
3437 <em class="replaceable"><code>command</code></em>
3438 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alias" title="4. Defining/Using aliases">alias</a></code> [
3439 <code class="option">-group</code>
3440 <em class="replaceable"><code>name</code></em>
3442 <em class="replaceable"><code>key</code></em>
3444 <em class="replaceable"><code>address</code></em>
3446 <em class="replaceable"><code>address</code></em>
3447 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alias" title="4. Defining/Using aliases">unalias</a></code> [
3448 <code class="option">-group</code>
3449 <em class="replaceable"><code>name</code></em>
3451 <em class="replaceable"><code>*</code></em>
3453 <em class="replaceable"><code>key</code></em>
3454 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></code> [
3455 <code class="option">-group</code>
3456 <em class="replaceable"><code>name</code></em>
3458 <em class="replaceable"><code>regexp</code></em>
3460 <em class="replaceable"><code>regexp</code></em>
3461 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternates" title="11. Alternative addresses">unalternates</a></code> [
3462 <code class="option">-group</code>
3463 <em class="replaceable"><code>name</code></em>
3465 <em class="replaceable"><code>*</code></em>
3467 <em class="replaceable"><code>regexp</code></em>
3468 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternative-order" title="5. MIME Multipart/Alternative">alternative-order</a></code>
3469 <em class="replaceable"><code>mimetype</code></em>
3471 <em class="replaceable"><code>mimetype</code></em>
3472 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternative-order" title="5. MIME Multipart/Alternative">unalternative-order</a></code> {
3473 <em class="replaceable"><code>*</code></em>
3475 <em class="replaceable"><code>mimetype</code></em>
3476 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#auto-view" title="4. MIME Autoview">auto-view</a></code>
3477 <em class="replaceable"><code>mimetype</code></em>
3479 <em class="replaceable"><code>mimetype</code></em>
3480 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#auto-view" title="4. MIME Autoview">unauto-view</a></code> {
3481 <em class="replaceable"><code>*</code></em>
3483 <em class="replaceable"><code>mimetype</code></em>
3484 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#bind" title="5. Changing the default key bindings">bind</a></code>
3485 <em class="replaceable"><code>map</code></em>
3487 <em class="replaceable"><code>key</code></em>
3489 <em class="replaceable"><code>function</code></em>
3490 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#charset-hook" title="6. Defining aliases for character sets">charset-hook</a></code>
3491 <em class="replaceable"><code>alias</code></em>
3493 <em class="replaceable"><code>charset</code></em>
3494 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#charset-hook" title="6. Defining aliases for character sets">iconv-hook</a></code>
3495 <em class="replaceable"><code>charset</code></em>
3497 <em class="replaceable"><code>local-charset</code></em>
3498 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#color" title="9. Using color and mono video attributes">color</a></code>
3499 <em class="replaceable"><code>object</code></em>
3501 <em class="replaceable"><code>foreground</code></em>
3503 <em class="replaceable"><code>background</code></em>
3504 </p></div><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#color" title="9. Using color and mono video attributes">color</a></code> {
3505 <code class="option">header</code>
3507 <code class="option">body</code>
3509 <em class="replaceable"><code>foreground</code></em>
3511 <em class="replaceable"><code>background</code></em>
3513 <em class="replaceable"><code>regexp</code></em>
3514 </p></div><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#color" title="9. Using color and mono video attributes">color</a></code>
3515 <code class="option">index</code>
3517 <em class="replaceable"><code>foreground</code></em>
3519 <em class="replaceable"><code>background</code></em>
3521 <em class="replaceable"><code>pattern</code></em>
3522 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#color" title="9. Using color and mono video attributes">uncolor</a></code>
3523 <code class="option">index</code>
3525 <em class="replaceable"><code>pattern</code></em>
3526 ... </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#exec" title="23. Executing functions">exec</a></code>
3527 <em class="replaceable"><code>function</code></em>
3529 <em class="replaceable"><code>function</code></em>
3530 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a></code>
3531 <em class="replaceable"><code>[!]pattern</code></em>
3533 <em class="replaceable"><code>mailbox</code></em>
3534 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a></code>
3535 <em class="replaceable"><code>[!]pattern</code></em>
3537 <em class="replaceable"><code>mailbox</code></em>
3538 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#folder-hook" title="7. Setting variables based upon mailbox">folder-hook</a></code>
3539 <em class="replaceable"><code>[!]regexp</code></em>
3541 <em class="replaceable"><code>command</code></em>
3542 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#addrgroup" title="3. Address groups">group</a></code> [
3543 <code class="option">-group</code>
3544 <em class="replaceable"><code>name</code></em>
3546 <code class="option">-rx</code>
3547 <em class="replaceable"><code>expr</code></em>
3549 <code class="option">-addr</code>
3550 <em class="replaceable"><code>expr</code></em>
3551 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#addrgroup" title="3. Address groups">ungroup</a></code> [
3552 <code class="option">-group</code>
3553 <em class="replaceable"><code>name</code></em>
3555 <em class="replaceable"><code>*</code></em>
3557 <code class="option">-rx</code>
3558 <em class="replaceable"><code>expr</code></em>
3560 <code class="option">-addr</code>
3561 <em class="replaceable"><code>expr</code></em>
3562 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#hdr-order">hdr_order</a></code>
3563 <em class="replaceable"><code>header</code></em>
3565 <em class="replaceable"><code>header</code></em>
3566 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#hdr-order">unhdr_order</a></code> {
3567 <em class="replaceable"><code>*</code></em>
3569 <em class="replaceable"><code>header</code></em>
3570 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#ignore" title="10. Message header display">ignore</a></code>
3571 <em class="replaceable"><code>pattern</code></em>
3573 <em class="replaceable"><code>pattern</code></em>
3574 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#ignore" title="10. Message header display">unignore</a></code> {
3575 <em class="replaceable"><code>*</code></em>
3577 <em class="replaceable"><code>pattern</code></em>
3578 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#lists" title="12. Mailing lists">lists</a></code> [
3579 <code class="option">-group</code>
3580 <em class="replaceable"><code>name</code></em>
3582 <em class="replaceable"><code>regexp</code></em>
3584 <em class="replaceable"><code>regexp</code></em>
3585 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#lists" title="12. Mailing lists">unlists</a></code> [
3586 <code class="option">-group</code>
3587 <em class="replaceable"><code>name</code></em>
3589 <em class="replaceable"><code>*</code></em>
3591 <em class="replaceable"><code>regexp</code></em>
3592 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#macro" title="8. Keyboard macros">macro</a></code>
3593 <em class="replaceable"><code>menu</code></em>
3595 <em class="replaceable"><code>key</code></em>
3597 <em class="replaceable"><code>sequence</code></em>
3599 <em class="replaceable"><code>description</code></em>
3600 ]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mailboxes" title="14. Monitoring incoming mail">mailboxes</a></code>
3601 <em class="replaceable"><code>mailbox</code></em>
3603 <em class="replaceable"><code>mailbox</code></em>
3604 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mailboxes" title="14. Monitoring incoming mail">unmailboxes</a></code> {
3605 <em class="replaceable"><code>*</code></em>
3607 <em class="replaceable"><code>mailbox</code></em>
3608 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mbox-hook" title="13. Using Multiple spool mailboxes">mbox-hook</a></code>
3609 <em class="replaceable"><code>[!]pattern</code></em>
3611 <em class="replaceable"><code>mailbox</code></em>
3612 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#message-hook" title="20. Change settings before formatting a message">message-hook</a></code>
3613 <em class="replaceable"><code>[!]pattern</code></em>
3615 <em class="replaceable"><code>command</code></em>
3616 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mime-lookup" title="7. MIME Lookup">mime-lookup</a></code>
3617 <em class="replaceable"><code>mimetype</code></em>
3619 <em class="replaceable"><code>mimetype</code></em>
3620 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mime-lookup" title="7. MIME Lookup">unmime-lookup</a></code> {
3621 <em class="replaceable"><code>*</code></em>
3623 <em class="replaceable"><code>mimetype</code></em>
3624 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mono">mono</a></code>
3625 <em class="replaceable"><code>object</code></em>
3627 <em class="replaceable"><code>attribute</code></em>
3628 </p></div><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mono">mono</a></code> {
3629 <code class="option">header</code>
3631 <code class="option">body</code>
3633 <em class="replaceable"><code>attribute</code></em>
3635 <em class="replaceable"><code>regexp</code></em>
3636 </p></div><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mono">mono</a></code>
3637 <code class="option">index</code>
3639 <em class="replaceable"><code>attribute</code></em>
3641 <em class="replaceable"><code>pattern</code></em>
3642 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mono">unmono</a></code>
3643 <code class="option">index</code>
3645 <em class="replaceable"><code>*</code></em>
3647 <em class="replaceable"><code>pattern</code></em>
3648 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#my-hdr" title="15. User defined headers">my_hdr</a></code>
3649 <em class="replaceable"><code>string</code></em>
3650 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#my-hdr" title="15. User defined headers">unmy_hdr</a></code> {
3651 <em class="replaceable"><code>*</code></em>
3653 <em class="replaceable"><code>field</code></em>
3654 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#crypt-hook" title="21. Choosing the cryptographic key of the recipient">crypt-hook</a></code>
3655 <em class="replaceable"><code>pattern</code></em>
3657 <em class="replaceable"><code>keyid</code></em>
3658 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#push" title="22. Adding key sequences to the keyboard buffer">push</a></code>
3659 <em class="replaceable"><code>string</code></em>
3660 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">reset</a></code>
3661 <em class="replaceable"><code>variable</code></em>
3663 <em class="replaceable"><code>variable</code></em>
3664 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#save-hook" title="16. Specify default save mailbox">save-hook</a></code>
3665 <em class="replaceable"><code>[!]pattern</code></em>
3667 <em class="replaceable"><code>mailbox</code></em>
3668 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#score" title="3.253. score">score</a></code>
3669 <em class="replaceable"><code>pattern</code></em>
3671 <em class="replaceable"><code>value</code></em>
3672 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#score" title="3.253. score">unscore</a></code> {
3673 <em class="replaceable"><code>*</code></em>
3675 <em class="replaceable"><code>pattern</code></em>
3676 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#reply-hook">reply-hook</a></code>
3677 <em class="replaceable"><code>[!]pattern</code></em>
3679 <em class="replaceable"><code>command</code></em>
3680 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a></code>
3681 <em class="replaceable"><code>[!]pattern</code></em>
3683 <em class="replaceable"><code>command</code></em>
3684 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#send2-hook">send2-hook</a></code>
3685 <em class="replaceable"><code>[!]pattern</code></em>
3687 <em class="replaceable"><code>command</code></em>
3688 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">set</a></code> {
3689 [ <code class="option">no</code> | <code class="option">inv</code> ]
3690 <em class="replaceable"><code>variable</code></em>
3692 <em class="replaceable"><code>variable=value</code></em>
3693 } [...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">unset</a></code>
3694 <em class="replaceable"><code>variable</code></em>
3696 <em class="replaceable"><code>variable</code></em>
3697 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#source" title="27. Reading initialization commands from another file">source</a></code>
3698 <em class="replaceable"><code>filename</code></em>
3699 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#spam" title="25. Spam detection">spam</a></code>
3700 <em class="replaceable"><code>pattern</code></em>
3702 <em class="replaceable"><code>format</code></em>
3703 </p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#spam" title="25. Spam detection">nospam</a></code> {
3704 <em class="replaceable"><code>*</code></em>
3706 <em class="replaceable"><code>pattern</code></em>
3707 }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#subscribe">subscribe</a></code> [
3708 <code class="option">-group</code>
3709 <em class="replaceable"><code>name</code></em>
3711 <em class="replaceable"><code>regexp</code></em>
3713 <em class="replaceable"><code>regexp</code></em>
3714 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#subscribe">unsubscribe</a></code> [
3715 <code class="option">-group</code>
3716 <em class="replaceable"><code>name</code></em>
3718 <em class="replaceable"><code>*</code></em>
3720 <em class="replaceable"><code>regexp</code></em>
3721 ... }</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">toggle</a></code>
3722 <em class="replaceable"><code>variable</code></em>
3724 <em class="replaceable"><code>variable</code></em>
3725 ...]</p></div></li><li><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#unhook" title="28. Removing hooks">unhook</a></code> {
3726 <em class="replaceable"><code>*</code></em>
3728 <em class="replaceable"><code>hook-type</code></em>
3729 }</p></div></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="variables"></a>3. Configuration variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="abort-nosubject"></a>3.1. abort_nosubject</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3730 Default: ask-yes</p></div><p>
3731 If set to <span class="emphasis"><em>yes</em></span>, when composing messages and no subject is given
3732 at the subject prompt, composition will be aborted. If set to
3733 <span class="emphasis"><em>no</em></span>, composing messages with no subject given at the subject
3734 prompt will never be aborted.
3735 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="abort-unmodified"></a>3.2. abort_unmodified</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3736 Default: yes</p></div><p>
3737 If set to <span class="emphasis"><em>yes</em></span>, composition will automatically abort after
3738 editing the message body if no changes are made to the file (this
3739 check only happens after the <span class="emphasis"><em>first</em></span> edit of the file). When set
3740 to <span class="emphasis"><em>no</em></span>, composition will never be aborted.
3741 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-file"></a>3.3. alias_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
3742 Default: “<span class="quote"><code class="literal">˜/.muttrc</code></span>”</p></div><p>
3743 The default file in which to save aliases created by the
3744 <code class="literal"><a class="link" href="#create-alias"><create-alias></a></code> function. Entries added to this file are
3745 encoded in the character set specified by <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> if it
3746 is <span class="emphasis"><em>set</em></span> or the current character set otherwise.
3748 <span class="bold"><strong>Note:</strong></span> Mutt will not automatically source this file; you must
3749 explicitly use the “<span class="quote"><a class="link" href="#source" title="27. Reading initialization commands from another file">source</a></span>” command for it to be executed in case
3750 this option points to a dedicated alias file.
3752 The default for this option is the currently used muttrc file, or
3753 “<span class="quote">˜/.muttrc</span>” if no user muttrc was found.
3754 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-format"></a>3.4. alias_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3755 Default: “<span class="quote"><code class="literal">%4n %2f %t %-10a %r</code></span>”</p></div><p>
3756 Specifies the format of the data displayed for the “<span class="quote"><a class="link" href="#alias" title="4. Defining/Using aliases">alias</a></span>” menu. The
3757 following <code class="literal">printf(3)</code>-style sequences are available:
3759 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>alias name
3760 </p></dd><dt><span class="term">%f </span></dt><dd><p>flags - currently, a “<span class="quote">d</span>” for an alias marked for deletion
3761 </p></dd><dt><span class="term">%n </span></dt><dd><p>index number
3762 </p></dd><dt><span class="term">%r </span></dt><dd><p>address which alias expands to
3763 </p></dd><dt><span class="term">%t </span></dt><dd><p>character which indicates if the alias is tagged for inclusion
3764 </p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="allow-8bit"></a>3.5. allow_8bit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3765 Default: yes</p></div><p>
3766 Controls whether 8-bit data is converted to 7-bit using either Quoted-
3767 Printable or Base64 encoding when sending mail.
3768 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="allow-ansi"></a>3.6. allow_ansi</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3769 Default: no</p></div><p>
3770 Controls whether ANSI color codes in messages (and color tags in
3771 rich text messages) are to be interpreted.
3772 Messages containing these codes are rare, but if this option is <span class="emphasis"><em>set</em></span>,
3773 their text will be colored accordingly. Note that this may override
3774 your color choices, and even present a security problem, since a
3775 message could include a line like
3777 </p><pre class="screen">
3778 [-- PGP output follows ...
3781 and give it the same color as your attachment color (see also
3782 <a class="link" href="#crypt-timestamp" title="3.149. crypt_timestamp">$crypt_timestamp</a>).
3783 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="arrow-cursor"></a>3.7. arrow_cursor</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3784 Default: no</p></div><p>
3785 When <span class="emphasis"><em>set</em></span>, an arrow (“<span class="quote">-></span>”) will be used to indicate the current entry
3786 in menus instead of highlighting the whole line. On slow network or modem
3787 links this will make response faster because there is less that has to
3788 be redrawn on the screen when moving to the next or previous entries
3790 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ascii-chars"></a>3.8. ascii_chars</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3791 Default: no</p></div><p>
3792 If <span class="emphasis"><em>set</em></span>, Mutt will use plain ASCII characters when displaying thread
3793 and attachment trees, instead of the default <span class="emphasis"><em>ACS</em></span> characters.
3794 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="askbcc"></a>3.9. askbcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3795 Default: no</p></div><p>
3796 If <span class="emphasis"><em>set</em></span>, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
3797 before editing an outgoing message.
3798 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="askcc"></a>3.10. askcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3799 Default: no</p></div><p>
3800 If <span class="emphasis"><em>set</em></span>, Mutt will prompt you for carbon-copy (Cc) recipients before
3801 editing the body of an outgoing message.
3802 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="assumed-charset"></a>3.11. assumed_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3803 Default: (empty)</p></div><p>
3804 This variable is a colon-separated list of character encoding
3805 schemes for messages without character encoding indication.
3806 Header field values and message body content without character encoding
3807 indication would be assumed that they are written in one of this list.
3808 By default, all the header fields and message body without any charset
3809 indication are assumed to be in “<span class="quote">us-ascii</span>”.
3811 For example, Japanese users might prefer this:
3813 </p><pre class="screen">
3814 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
3817 However, only the first content is valid for the message body.
3818 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-charset"></a>3.12. attach_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3819 Default: (empty)</p></div><p>
3820 This variable is a colon-separated list of character encoding
3821 schemes for text file attachments.
3822 If <span class="emphasis"><em>unset</em></span>, the value of <a class="link" href="#charset" title="3.25. charset">$charset</a> will be used instead.
3823 For example, the following configuration would work for Japanese
3826 </p><pre class="screen">
3827 set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
3830 Note: for Japanese users, “<span class="quote">iso-2022-*</span>” must be put at the head
3831 of the value as shown above if included.
3832 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-format"></a>3.13. attach_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3833 Default: “<span class="quote"><code class="literal">%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] </code></span>”</p></div><p>
3834 This variable describes the format of the “<span class="quote">attachment</span>” menu. The
3835 following <code class="literal">printf(3)</code>-style sequences are understood:
3837 </p><div class="variablelist"><dl><dt><span class="term">%C </span></dt><dd><p>charset
3838 </p></dd><dt><span class="term">%c </span></dt><dd><p>requires charset conversion (“<span class="quote">n</span>” or “<span class="quote">c</span>”)
3839 </p></dd><dt><span class="term">%D </span></dt><dd><p>deleted flag
3840 </p></dd><dt><span class="term">%d </span></dt><dd><p>description
3841 </p></dd><dt><span class="term">%e </span></dt><dd><p>MIME content-transfer-encoding
3842 </p></dd><dt><span class="term">%f </span></dt><dd><p>filename
3843 </p></dd><dt><span class="term">%I </span></dt><dd><p>disposition (“<span class="quote">I</span>” for inline, “<span class="quote">A</span>” for attachment)
3844 </p></dd><dt><span class="term">%m </span></dt><dd><p>major MIME type
3845 </p></dd><dt><span class="term">%M </span></dt><dd><p>MIME subtype
3846 </p></dd><dt><span class="term">%n </span></dt><dd><p>attachment number
3847 </p></dd><dt><span class="term">%Q </span></dt><dd><p>“<span class="quote">Q</span>”, if MIME part qualifies for attachment counting
3848 </p></dd><dt><span class="term">%s </span></dt><dd><p>size
3849 </p></dd><dt><span class="term">%t </span></dt><dd><p>tagged flag
3850 </p></dd><dt><span class="term">%T </span></dt><dd><p>graphic tree characters
3851 </p></dd><dt><span class="term">%u </span></dt><dd><p>unlink (=to delete) flag
3852 </p></dd><dt><span class="term">%X </span></dt><dd><p>number of qualifying MIME parts in this part and its children
3853 (please see the “<span class="quote"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></span>” section for possible speed effects)
3854 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with character “<span class="quote">X</span>”
3855 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with character “<span class="quote">X</span>”
3856 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character “<span class="quote">X</span>” as pad
3857 </p></dd></dl></div><p>
3858 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> documentation.
3859 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-sep"></a>3.14. attach_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3860 Default: “<span class="quote"><code class="literal">\n</code></span>”</p></div><p>
3861 The separator to add between attachments when operating (saving,
3862 printing, piping, etc) on a list of tagged attachments.
3863 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-split"></a>3.15. attach_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3864 Default: yes</p></div><p>
3865 If this variable is <span class="emphasis"><em>unset</em></span>, when operating (saving, printing, piping,
3866 etc) on a list of tagged attachments, Mutt will concatenate the
3867 attachments and will operate on them as a single attachment. The
3868 <a class="link" href="#attach-sep" title="3.14. attach_sep">$attach_sep</a> separator is added after each attachment. When <span class="emphasis"><em>set</em></span>,
3869 Mutt will operate on the attachments one by one.
3870 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attribution"></a>3.16. attribution</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3871 Default: “<span class="quote"><code class="literal">On %d, %n wrote:</code></span>”</p></div><p>
3872 This is the string that will precede a message which has been included
3873 in a reply. For a full listing of defined <code class="literal">printf(3)</code>-like sequences see
3874 the section on <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>.
3875 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="autoedit"></a>3.17. autoedit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3876 Default: no</p></div><p>
3877 When <span class="emphasis"><em>set</em></span> along with <a class="link" href="#edit-headers" title="3.50. edit_headers">$edit_headers</a>, Mutt will skip the initial
3878 send-menu (prompting for subject and recipients) and allow you to
3879 immediately begin editing the body of your
3880 message. The send-menu may still be accessed once you have finished
3881 editing the body of your message.
3883 Also see <a class="link" href="#fast-reply" title="3.55. fast_reply">$fast_reply</a>.
3884 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="auto-tag"></a>3.18. auto_tag</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3885 Default: no</p></div><p>
3886 When <span class="emphasis"><em>set</em></span>, functions in the <span class="emphasis"><em>index</em></span> menu which affect a message
3887 will be applied to all tagged messages (if there are any). When
3888 unset, you must first use the <code class="literal"><tag-prefix></code> function (bound to “<span class="quote">;</span>”
3889 by default) to make the next function apply to all tagged messages.
3890 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="beep"></a>3.19. beep</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3891 Default: yes</p></div><p>
3892 When this variable is <span class="emphasis"><em>set</em></span>, mutt will beep when an error occurs.
3893 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="beep-new"></a>3.20. beep_new</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3894 Default: no</p></div><p>
3895 When this variable is <span class="emphasis"><em>set</em></span>, mutt will beep whenever it prints a message
3896 notifying you of new mail. This is independent of the setting of the
3897 <a class="link" href="#beep" title="3.19. beep">$beep</a> variable.
3898 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="bounce"></a>3.21. bounce</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3899 Default: ask-yes</p></div><p>
3900 Controls whether you will be asked to confirm bouncing messages.
3901 If set to <span class="emphasis"><em>yes</em></span> you don't get asked if you want to bounce a
3902 message. Setting this variable to <span class="emphasis"><em>no</em></span> is not generally useful,
3903 and thus not recommended, because you are unable to bounce messages.
3904 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="bounce-delivered"></a>3.22. bounce_delivered</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3905 Default: yes</p></div><p>
3906 When this variable is <span class="emphasis"><em>set</em></span>, mutt will include Delivered-To headers when
3907 bouncing messages. Postfix users may wish to <span class="emphasis"><em>unset</em></span> this variable.
3908 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="braille-friendly"></a>3.23. braille_friendly</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3909 Default: no</p></div><p>
3910 When this variable is <span class="emphasis"><em>set</em></span>, mutt will place the cursor at the beginning
3911 of the current line in menus, even when the <a class="link" href="#arrow-cursor" title="3.7. arrow_cursor">$arrow_cursor</a> variable
3912 is <span class="emphasis"><em>unset</em></span>, making it easier for blind persons using Braille displays to
3913 follow these menus. The option is <span class="emphasis"><em>unset</em></span> by default because many
3914 visual terminals don't permit making the cursor invisible.
3915 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="check-mbox-size"></a>3.24. check_mbox_size</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3916 Default: no</p></div><p>
3917 When this variable is <span class="emphasis"><em>set</em></span>, mutt will use file size attribute instead of
3918 access time when checking for new mail in mbox and mmdf folders.
3920 This variable is <span class="emphasis"><em>unset</em></span> by default and should only be enabled when
3921 new mail detection for these folder types is unreliable or doesn't work.
3923 Note that enabling this variable should happen before any “<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring incoming mail">mailboxes</a></span>”
3924 directives occur in configuration files regarding mbox or mmdf folders
3925 because mutt needs to determine the initial new mail status of such a
3926 mailbox by performing a fast mailbox scan when it is defined.
3927 Afterwards the new mail status is tracked by file size changes.
3928 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="charset"></a>3.25. charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3929 Default: (empty)</p></div><p>
3930 Character set your terminal uses to display and enter textual data.
3931 It is also the fallback for <a class="link" href="#send-charset" title="3.257. send_charset">$send_charset</a>.
3933 Upon startup Mutt tries to derive this value from environment variables
3934 such as <code class="literal">$LC_CTYPE</code> or <code class="literal">$LANG</code>.
3936 <span class="bold"><strong>Note:</strong></span> It should only be set in case Mutt isn't abled to determine the
3937 character set used correctly.
3938 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="check-new"></a>3.26. check_new</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3939 Default: yes</p></div><p>
3940 <span class="bold"><strong>Note:</strong></span> this option only affects <span class="emphasis"><em>maildir</em></span> and <span class="emphasis"><em>MH</em></span> style
3943 When <span class="emphasis"><em>set</em></span>, Mutt will check for new mail delivered while the
3944 mailbox is open. Especially with MH mailboxes, this operation can
3945 take quite some time since it involves scanning the directory and
3946 checking each file to see if it has already been looked at. If
3947 this variable is <span class="emphasis"><em>unset</em></span>, no check for new mail is performed
3948 while the mailbox is open.
3949 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="collapse-unread"></a>3.27. collapse_unread</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3950 Default: yes</p></div><p>
3951 When <span class="emphasis"><em>unset</em></span>, Mutt will not collapse a thread if it contains any
3953 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="uncollapse-jump"></a>3.28. uncollapse_jump</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3954 Default: no</p></div><p>
3955 When <span class="emphasis"><em>set</em></span>, Mutt will jump to the next unread message, if any,
3956 when the current thread is <span class="emphasis"><em>un</em></span>collapsed.
3957 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-format"></a>3.29. compose_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3958 Default: “<span class="quote"><code class="literal">-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-</code></span>”</p></div><p>
3959 Controls the format of the status line displayed in the “<span class="quote">compose</span>”
3960 menu. This string is similar to <a class="link" href="#status-format" title="3.279. status_format">$status_format</a>, but has its own
3961 set of <code class="literal">printf(3)</code>-like sequences:
3963 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>total number of attachments
3964 </p></dd><dt><span class="term">%h </span></dt><dd><p>local hostname
3965 </p></dd><dt><span class="term">%l </span></dt><dd><p>approximate size (in bytes) of the current message
3966 </p></dd><dt><span class="term">%v </span></dt><dd><p>Mutt version string
3967 </p></dd></dl></div><p>
3968 See the text describing the <a class="link" href="#status-format" title="3.279. status_format">$status_format</a> option for more
3969 information on how to set <a class="link" href="#compose-format" title="3.29. compose_format">$compose_format</a>.
3970 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="config-charset"></a>3.30. config_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3971 Default: (empty)</p></div><p>
3972 When defined, Mutt will recode commands in rc files from this
3973 encoding to the current character set as specified by <a class="link" href="#charset" title="3.25. charset">$charset</a>
3974 and aliases written to <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a> from the current character set.
3976 Please note that if setting <a class="link" href="#charset" title="3.25. charset">$charset</a> it must be done before
3977 setting <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>.
3979 Recoding should be avoided as it may render unconvertable
3980 characters as question marks which can lead to undesired
3981 side effects (for example in regular expressions).
3982 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="confirmappend"></a>3.31. confirmappend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3983 Default: yes</p></div><p>
3984 When <span class="emphasis"><em>set</em></span>, Mutt will prompt for confirmation when appending messages to
3985 an existing mailbox.
3986 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="confirmcreate"></a>3.32. confirmcreate</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3987 Default: yes</p></div><p>
3988 When <span class="emphasis"><em>set</em></span>, Mutt will prompt for confirmation when saving messages to a
3989 mailbox which does not yet exist before creating it.
3990 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="connect-timeout"></a>3.33. connect_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
3991 Default: 30</p></div><p>
3992 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
3993 many seconds if the connection is not able to be established. A negative
3994 value causes Mutt to wait indefinitely for the connection attempt to succeed.
3995 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="content-type"></a>3.34. content_type</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3996 Default: “<span class="quote"><code class="literal">text/plain</code></span>”</p></div><p>
3997 Sets the default Content-Type for the body of newly composed messages.
3998 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="copy"></a>3.35. copy</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3999 Default: yes</p></div><p>
4000 This variable controls whether or not copies of your outgoing messages
4001 will be saved for later references. Also see <a class="link" href="#record" title="3.240. record">$record</a>,
4002 <a class="link" href="#save-name" title="3.252. save_name">$save_name</a>, <a class="link" href="#force-name" title="3.61. force_name">$force_name</a> and “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a></span>”.
4003 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-gpgme"></a>3.36. crypt_use_gpgme</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4004 Default: no</p></div><p>
4005 This variable controls the use of the GPGME-enabled crypto backends.
4006 If it is <span class="emphasis"><em>set</em></span> and Mutt was built with gpgme support, the gpgme code for
4007 S/MIME and PGP will be used instead of the classic code. Note that
4008 you need to set this option in .muttrc; it won't have any effect when
4010 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-pka"></a>3.37. crypt_use_pka</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4011 Default: no</p></div><p>
4012 Controls whether mutt uses PKA
4013 (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature
4014 verification (only supported by the GPGME backend).
4015 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autopgp"></a>3.38. crypt_autopgp</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4016 Default: yes</p></div><p>
4017 This variable controls whether or not mutt may automatically enable
4018 PGP encryption/signing for messages. See also <a class="link" href="#crypt-autoencrypt" title="3.144. crypt_autoencrypt">$crypt_autoencrypt</a>,
4019 <a class="link" href="#crypt-replyencrypt" title="3.146. crypt_replyencrypt">$crypt_replyencrypt</a>,
4020 <a class="link" href="#crypt-autosign" title="3.143. crypt_autosign">$crypt_autosign</a>, <a class="link" href="#crypt-replysign" title="3.147. crypt_replysign">$crypt_replysign</a> and <a class="link" href="#smime-is-default" title="3.152. smime_is_default">$smime_is_default</a>.
4021 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autosmime"></a>3.39. crypt_autosmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4022 Default: yes</p></div><p>
4023 This variable controls whether or not mutt may automatically enable
4024 S/MIME encryption/signing for messages. See also <a class="link" href="#crypt-autoencrypt" title="3.144. crypt_autoencrypt">$crypt_autoencrypt</a>,
4025 <a class="link" href="#crypt-replyencrypt" title="3.146. crypt_replyencrypt">$crypt_replyencrypt</a>,
4026 <a class="link" href="#crypt-autosign" title="3.143. crypt_autosign">$crypt_autosign</a>, <a class="link" href="#crypt-replysign" title="3.147. crypt_replysign">$crypt_replysign</a> and <a class="link" href="#smime-is-default" title="3.152. smime_is_default">$smime_is_default</a>.
4027 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="date-format"></a>3.40. date_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4028 Default: “<span class="quote"><code class="literal">!%a, %b %d, %Y at %I:%M:%S%p %Z</code></span>”</p></div><p>
4029 This variable controls the format of the date printed by the “<span class="quote">%d</span>”
4030 sequence in <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>. This is passed to the <code class="literal">strftime(3)</code>
4031 function to process the date, see the man page for the proper syntax.
4033 Unless the first character in the string is a bang (“<span class="quote">!</span>”), the month
4034 and week day names are expanded according to the locale specified in
4035 the variable <a class="link" href="#locale" title="3.104. locale">$locale</a>. If the first character in the string is a
4036 bang, the bang is discarded, and the month and week day names in the
4037 rest of the string are expanded in the <span class="emphasis"><em>C</em></span> locale (that is in US
4039 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="default-hook"></a>3.41. default_hook</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4040 Default: “<span class="quote"><code class="literal">˜f %s !˜P | (˜P ˜C %s)</code></span>”</p></div><p>
4041 This variable controls how “<span class="quote"><a class="link" href="#message-hook" title="20. Change settings before formatting a message">message-hook</a></span>”, “<span class="quote"><a class="link" href="#reply-hook">reply-hook</a></span>”, “<span class="quote"><a class="link" href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a></span>”,
4042 “<span class="quote"><a class="link" href="#send2-hook">send2-hook</a></span>”, “<span class="quote"><a class="link" href="#save-hook" title="16. Specify default save mailbox">save-hook</a></span>”, and “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a></span>” will
4043 be interpreted if they are specified with only a simple regexp,
4044 instead of a matching pattern. The hooks are expanded when they are
4045 declared, so a hook will be interpreted according to the value of this
4046 variable at the time the hook is declared.
4048 The default value matches
4049 if the message is either from a user matching the regular expression
4050 given, or if it is from you (if the from address matches
4051 “<span class="quote"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></span>”) and is to or cc'ed to a user matching the given
4053 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="delete"></a>3.42. delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4054 Default: ask-yes</p></div><p>
4055 Controls whether or not messages are really deleted when closing or
4056 synchronizing a mailbox. If set to <span class="emphasis"><em>yes</em></span>, messages marked for
4057 deleting will automatically be purged without prompting. If set to
4058 <span class="emphasis"><em>no</em></span>, messages marked for deletion will be kept in the mailbox.
4059 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="delete-untag"></a>3.43. delete_untag</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4060 Default: yes</p></div><p>
4061 If this option is <span class="emphasis"><em>set</em></span>, mutt will untag messages when marking them
4062 for deletion. This applies when you either explicitly delete a message,
4063 or when you save it to another folder.
4064 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="digest-collapse"></a>3.44. digest_collapse</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4065 Default: yes</p></div><p>
4066 If this option is <span class="emphasis"><em>set</em></span>, mutt's received-attachments menu will not show the subparts of
4067 individual messages in a multipart/digest. To see these subparts, press “<span class="quote">v</span>” on that menu.
4068 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="display-filter"></a>3.45. display_filter</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4069 Default: (empty)</p></div><p>
4070 When set, specifies a command used to filter messages. When a message
4071 is viewed it is passed as standard input to <a class="link" href="#display-filter" title="3.45. display_filter">$display_filter</a>, and the
4072 filtered message is read from the standard output.
4073 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="dotlock-program"></a>3.46. dotlock_program</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4074 Default: “<span class="quote"><code class="literal">/usr/local/bin/mutt_dotlock</code></span>”</p></div><p>
4075 Contains the path of the <code class="literal">mutt_dotlock(8)</code> binary to be used by
4077 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="dsn-notify"></a>3.47. dsn_notify</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4078 Default: (empty)</p></div><p>
4079 This variable sets the request for when notification is returned. The
4080 string consists of a comma separated list (no spaces!) of one or more
4081 of the following: <span class="emphasis"><em>never</em></span>, to never request notification,
4082 <span class="emphasis"><em>failure</em></span>, to request notification on transmission failure,
4083 <span class="emphasis"><em>delay</em></span>, to be notified of message delays, <span class="emphasis"><em>success</em></span>, to be
4084 notified of successful transmission.
4088 </p><pre class="screen">
4089 set dsn_notify="failure,delay"
4092 <span class="bold"><strong>Note:</strong></span> when using <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> for delivery, you should not enable
4093 this unless you are either using Sendmail 8.8.x or greater or a MTA
4094 providing a <code class="literal">sendmail(1)</code>-compatible interface supporting the <code class="literal">-N</code> option
4095 for DSN. For SMTP delivery, DSN support is autodetected so that it
4096 depends on the server whether DSN will be used or not.
4097 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="dsn-return"></a>3.48. dsn_return</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4098 Default: (empty)</p></div><p>
4099 This variable controls how much of your message is returned in DSN
4100 messages. It may be set to either <span class="emphasis"><em>hdrs</em></span> to return just the
4101 message header, or <span class="emphasis"><em>full</em></span> to return the full message.
4105 </p><pre class="screen">
4109 <span class="bold"><strong>Note:</strong></span> when using <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> for delivery, you should not enable
4110 this unless you are either using Sendmail 8.8.x or greater or a MTA
4111 providing a <code class="literal">sendmail(1)</code>-compatible interface supporting the <code class="literal">-R</code> option
4112 for DSN. For SMTP delivery, DSN support is autodetected so that it
4113 depends on the server whether DSN will be used or not.
4114 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="duplicate-threads"></a>3.49. duplicate_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4115 Default: yes</p></div><p>
4116 This variable controls whether mutt, when <a class="link" href="#sort" title="3.271. sort">$sort</a> is set to <span class="emphasis"><em>threads</em></span>, threads
4117 messages with the same Message-Id together. If it is <span class="emphasis"><em>set</em></span>, it will indicate
4118 that it thinks they are duplicates of each other with an equals sign
4120 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="edit-headers"></a>3.50. edit_headers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4121 Default: no</p></div><p>
4122 This option allows you to edit the header of your outgoing messages
4123 along with the body of your message.
4125 <span class="bold"><strong>Note</strong></span> that changes made to the References: and Date: headers are
4126 ignored for interoperability reasons.
4127 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editor"></a>3.51. editor</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4128 Default: (empty)</p></div><p>
4129 This variable specifies which editor is used by mutt.
4130 It defaults to the value of the <code class="literal">$VISUAL</code>, or <code class="literal">$EDITOR</code>, environment
4131 variable, or to the string “<span class="quote">vi</span>” if neither of those are set.
4132 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="encode-from"></a>3.52. encode_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4133 Default: no</p></div><p>
4134 When <span class="emphasis"><em>set</em></span>, mutt will quoted-printable encode messages when
4135 they contain the string “<span class="quote">From </span>” (note the trailing space) in the beginning of a line.
4136 This is useful to avoid the tampering certain mail delivery and transport
4137 agents tend to do with messages (in order to prevent tools from
4138 misinterpreting the line as a mbox message separator).
4139 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="envelope-from-address"></a>3.53. envelope_from_address</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
4140 Default: (empty)</p></div><p>
4141 Manually sets the <span class="emphasis"><em>envelope</em></span> sender for outgoing messages.
4142 This value is ignored if <a class="link" href="#use-envelope-from" title="3.294. use_envelope_from">$use_envelope_from</a> is <span class="emphasis"><em>unset</em></span>.
4143 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="escape"></a>3.54. escape</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4144 Default: “<span class="quote"><code class="literal">˜</code></span>”</p></div><p>
4145 Escape character to use for functions in the builtin editor.
4146 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="fast-reply"></a>3.55. fast_reply</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4147 Default: no</p></div><p>
4148 When <span class="emphasis"><em>set</em></span>, the initial prompt for recipients and subject are skipped
4149 when replying to messages, and the initial prompt for subject is
4150 skipped when forwarding messages.
4152 <span class="bold"><strong>Note:</strong></span> this variable has no effect when the <a class="link" href="#autoedit" title="3.17. autoedit">$autoedit</a>
4153 variable is <span class="emphasis"><em>set</em></span>.
4154 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="fcc-attach"></a>3.56. fcc_attach</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4155 Default: yes</p></div><p>
4156 This variable controls whether or not attachments on outgoing messages
4157 are saved along with the main body of your message.
4158 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="fcc-clear"></a>3.57. fcc_clear</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4159 Default: no</p></div><p>
4160 When this variable is <span class="emphasis"><em>set</em></span>, FCCs will be stored unencrypted and
4161 unsigned, even when the actual message is encrypted and/or
4164 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="folder"></a>3.58. folder</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4165 Default: “<span class="quote"><code class="literal">˜/Mail</code></span>”</p></div><p>
4166 Specifies the default location of your mailboxes. A “<span class="quote">+</span>” or “<span class="quote">=</span>” at the
4167 beginning of a pathname will be expanded to the value of this
4168 variable. Note that if you change this variable (from the default)
4169 value you need to make sure that the assignment occurs <span class="emphasis"><em>before</em></span>
4170 you use “<span class="quote">+</span>” or “<span class="quote">=</span>” for any other variables since expansion takes place
4171 when handling the “<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring incoming mail">mailboxes</a></span>” command.
4172 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="folder-format"></a>3.59. folder_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4173 Default: “<span class="quote"><code class="literal">%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f</code></span>”</p></div><p>
4174 This variable allows you to customize the file browser display to your
4175 personal taste. This string is similar to <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>, but has
4176 its own set of <code class="literal">printf(3)</code>-like sequences:
4178 </p><div class="variablelist"><dl><dt><span class="term">%C </span></dt><dd><p>current file number
4179 </p></dd><dt><span class="term">%d </span></dt><dd><p>date/time folder was last modified
4180 </p></dd><dt><span class="term">%f </span></dt><dd><p>filename
4181 </p></dd><dt><span class="term">%F </span></dt><dd><p>file permissions
4182 </p></dd><dt><span class="term">%g </span></dt><dd><p>group name (or numeric gid, if missing)
4183 </p></dd><dt><span class="term">%l </span></dt><dd><p>number of hard links
4184 </p></dd><dt><span class="term">%N </span></dt><dd><p>N if folder has new mail, blank otherwise
4185 </p></dd><dt><span class="term">%s </span></dt><dd><p>size in bytes
4186 </p></dd><dt><span class="term">%t </span></dt><dd><p>“<span class="quote">*</span>” if the file is tagged, blank otherwise
4187 </p></dd><dt><span class="term">%u </span></dt><dd><p>owner name (or numeric uid, if missing)
4188 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with character “<span class="quote">X</span>”
4189 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with character “<span class="quote">X</span>”
4190 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character “<span class="quote">X</span>” as pad
4191 </p></dd></dl></div><p>
4192 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> documentation.
4193 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="followup-to"></a>3.60. followup_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4194 Default: yes</p></div><p>
4195 Controls whether or not the “<span class="quote">Mail-Followup-To:</span>” header field is
4196 generated when sending mail. When <span class="emphasis"><em>set</em></span>, Mutt will generate this
4197 field when you are replying to a known mailing list, specified with
4198 the “<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>” or “<span class="quote"><a class="link" href="#lists" title="12. Mailing lists">lists</a></span>” commands.
4200 This field has two purposes. First, preventing you from
4201 receiving duplicate copies of replies to messages which you send
4202 to mailing lists, and second, ensuring that you do get a reply
4203 separately for any messages sent to known lists to which you are
4206 The header will contain only the list's address
4207 for subscribed lists, and both the list address and your own
4208 email address for unsubscribed lists. Without this header, a
4209 group reply to your message sent to a subscribed list will be
4210 sent to both the list and your address, resulting in two copies
4211 of the same email for you.
4212 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="force-name"></a>3.61. force_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4213 Default: no</p></div><p>
4214 This variable is similar to <a class="link" href="#save-name" title="3.252. save_name">$save_name</a>, except that Mutt will
4215 store a copy of your outgoing message by the username of the address
4216 you are sending to even if that mailbox does not exist.
4218 Also see the <a class="link" href="#record" title="3.240. record">$record</a> variable.
4219 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-decode"></a>3.62. forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4220 Default: yes</p></div><p>
4221 Controls the decoding of complex MIME messages into <code class="literal">text/plain</code> when
4222 forwarding a message. The message header is also RFC2047 decoded.
4223 This variable is only used, if <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a> is <span class="emphasis"><em>unset</em></span>,
4224 otherwise <a class="link" href="#mime-forward-decode" title="3.128. mime_forward_decode">$mime_forward_decode</a> is used instead.
4225 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-edit"></a>3.63. forward_edit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4226 Default: yes</p></div><p>
4227 This quadoption controls whether or not the user is automatically
4228 placed in the editor when forwarding messages. For those who always want
4229 to forward with no modification, use a setting of “<span class="quote">no</span>”.
4230 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-format"></a>3.64. forward_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4231 Default: “<span class="quote"><code class="literal">[%a: %s]</code></span>”</p></div><p>
4232 This variable controls the default subject when forwarding a message.
4233 It uses the same format sequences as the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> variable.
4234 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-quote"></a>3.65. forward_quote</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4235 Default: no</p></div><p>
4236 When <span class="emphasis"><em>set</em></span>, forwarded messages included in the main body of the
4237 message (when <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a> is <span class="emphasis"><em>unset</em></span>) will be quoted using
4238 <a class="link" href="#indent-string" title="3.100. indent_string">$indent_string</a>.
4239 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="from"></a>3.66. from</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
4240 Default: (empty)</p></div><p>
4241 When <span class="emphasis"><em>set</em></span>, this variable contains a default from address. It
4242 can be overridden using “<span class="quote"><a class="link" href="#my-hdr" title="15. User defined headers">my_hdr</a></span>” (including from a “<span class="quote"><a class="link" href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a></span>”) and
4243 <a class="link" href="#reverse-name" title="3.246. reverse_name">$reverse_name</a>. This variable is ignored if <a class="link" href="#use-from" title="3.295. use_from">$use_from</a> is <span class="emphasis"><em>unset</em></span>.
4245 This setting defaults to the contents of the environment variable <code class="literal">$EMAIL</code>.
4246 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="gecos-mask"></a>3.67. gecos_mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
4247 Default: “<span class="quote"><code class="literal">^[^,]*</code></span>”</p></div><p>
4248 A regular expression used by mutt to parse the GECOS field of a password
4249 entry when expanding the alias. The default value
4250 will return the string up to the first “<span class="quote">,</span>” encountered.
4251 If the GECOS field contains a string like “<span class="quote">lastname, firstname</span>” then you
4252 should set it to “<span class="quote"><code class="literal">.*</code></span>”.
4254 This can be useful if you see the following behavior: you address a e-mail
4255 to user ID “<span class="quote">stevef</span>” whose full name is “<span class="quote">Steve Franklin</span>”. If mutt expands
4256 “<span class="quote">stevef</span>” to “<span class="quote">"Franklin" stevef@foo.bar</span>” then you should set the <a class="link" href="#gecos-mask" title="3.67. gecos_mask">$gecos_mask</a> to
4257 a regular expression that will match the whole name so mutt will expand
4258 “<span class="quote">Franklin</span>” to “<span class="quote">Franklin, Steve</span>”.
4259 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hdrs"></a>3.68. hdrs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4260 Default: yes</p></div><p>
4261 When <span class="emphasis"><em>unset</em></span>, the header fields normally added by the “<span class="quote"><a class="link" href="#my-hdr" title="15. User defined headers">my_hdr</a></span>”
4262 command are not created. This variable <span class="emphasis"><em>must</em></span> be unset before
4263 composing a new message or replying in order to take effect. If <span class="emphasis"><em>set</em></span>,
4264 the user defined header fields are added to every new message.
4265 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header"></a>3.69. header</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4266 Default: no</p></div><p>
4267 When <span class="emphasis"><em>set</em></span>, this variable causes Mutt to include the header
4268 of the message you are replying to into the edit buffer.
4269 The <a class="link" href="#weed" title="3.301. weed">$weed</a> setting applies.
4270 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="help"></a>3.70. help</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4271 Default: yes</p></div><p>
4272 When <span class="emphasis"><em>set</em></span>, help lines describing the bindings for the major functions
4273 provided by each menu are displayed on the first line of the screen.
4275 <span class="bold"><strong>Note:</strong></span> The binding will not be displayed correctly if the
4276 function is bound to a sequence rather than a single keystroke. Also,
4277 the help line may not be updated if a binding is changed while Mutt is
4278 running. Since this variable is primarily aimed at new users, neither
4279 of these should present a major problem.
4280 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hidden-host"></a>3.71. hidden_host</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4281 Default: no</p></div><p>
4282 When <span class="emphasis"><em>set</em></span>, mutt will skip the host name part of <a class="link" href="#hostname" title="3.80. hostname">$hostname</a> variable
4283 when adding the domain part to addresses. This variable does not
4284 affect the generation of Message-IDs, and it will not lead to the
4285 cut-off of first-level domains.
4286 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-limited"></a>3.72. hide_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4287 Default: no</p></div><p>
4288 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of messages that are hidden
4289 by limiting, in the thread tree.
4290 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-missing"></a>3.73. hide_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4291 Default: yes</p></div><p>
4292 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of missing messages in the
4294 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-thread-subject"></a>3.74. hide_thread_subject</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4295 Default: yes</p></div><p>
4296 When <span class="emphasis"><em>set</em></span>, mutt will not show the subject of messages in the thread
4297 tree that have the same subject as their parent or closest previously
4299 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-limited"></a>3.75. hide_top_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4300 Default: no</p></div><p>
4301 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of messages that are hidden
4302 by limiting, at the top of threads in the thread tree. Note that when
4303 <a class="link" href="#hide-limited" title="3.72. hide_limited">$hide_limited</a> is <span class="emphasis"><em>set</em></span>, this option will have no effect.
4304 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-missing"></a>3.76. hide_top_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4305 Default: yes</p></div><p>
4306 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of missing messages at the
4307 top of threads in the thread tree. Note that when <a class="link" href="#hide-missing" title="3.73. hide_missing">$hide_missing</a> is
4308 <span class="emphasis"><em>set</em></span>, this option will have no effect.
4309 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="history"></a>3.77. history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4310 Default: 10</p></div><p>
4311 This variable controls the size (in number of strings remembered) of
4312 the string history buffer per category. The buffer is cleared each time the
4314 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="history-file"></a>3.78. history_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4315 Default: “<span class="quote"><code class="literal">˜/.mutthistory</code></span>”</p></div><p>
4316 The file in which Mutt will save its history.
4317 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="honor-followup-to"></a>3.79. honor_followup_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4318 Default: yes</p></div><p>
4319 This variable controls whether or not a Mail-Followup-To header is
4320 honored when group-replying to a message.
4321 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hostname"></a>3.80. hostname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4322 Default: (empty)</p></div><p>
4323 Specifies the fully-qualified hostname of the system mutt is running on
4324 containing the host's name and the DNS domain it belongs to. It is used
4325 as the domain part (after “<span class="quote">@</span>”) for local email addresses as well as
4328 Its value is determined at startup as follows: If the node's name
4329 as returned by the <code class="literal">uname(3)</code> function contains the hostname and the
4330 domain, these are used to construct <a class="link" href="#hostname" title="3.80. hostname">$hostname</a>. If there is no
4331 domain part returned, Mutt will look for a “<span class="quote">domain</span>” or “<span class="quote">search</span>”
4332 line in <code class="literal">/etc/resolv.conf</code> to determine the domain. Optionally, Mutt
4333 can be compiled with a fixed domain name in which case a detected
4336 Also see <a class="link" href="#use-domain" title="3.293. use_domain">$use_domain</a> and <a class="link" href="#hidden-host" title="3.71. hidden_host">$hidden_host</a>.
4337 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-linear-white-space"></a>3.81. ignore_linear_white_space</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4338 Default: no</p></div><p>
4339 This option replaces linear-white-space between encoded-word
4340 and text to a single space to prevent the display of MIME-encoded
4341 “<span class="quote">Subject:</span>” field from being divided into multiple lines.
4342 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-list-reply-to"></a>3.82. ignore_list_reply_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4343 Default: no</p></div><p>
4344 Affects the behaviour of the <code class="literal"><reply></code> function when replying to
4345 messages from mailing lists (as defined by the “<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>” or
4346 “<span class="quote"><a class="link" href="#lists" title="12. Mailing lists">lists</a></span>” commands). When <span class="emphasis"><em>set</em></span>, if the “<span class="quote">Reply-To:</span>” field is
4347 set to the same value as the “<span class="quote">To:</span>” field, Mutt assumes that the
4348 “<span class="quote">Reply-To:</span>” field was set by the mailing list to automate responses
4349 to the list, and will ignore this field. To direct a response to the
4350 mailing list when this option is <span class="emphasis"><em>set</em></span>, use the <code class="literal"><a class="link" href="#list-reply"><list-reply></a></code>
4351 function; <code class="literal"><group-reply></code> will reply to both the sender and the
4353 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-authenticators"></a>3.83. imap_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4354 Default: (empty)</p></div><p>
4355 This is a colon-delimited list of authentication methods mutt may
4356 attempt to use to log in to an IMAP server, in the order mutt should
4357 try them. Authentication methods are either “<span class="quote">login</span>” or the right
4358 side of an IMAP “<span class="quote">AUTH=xxx</span>” capability string, eg “<span class="quote">digest-md5</span>”, “<span class="quote">gssapi</span>”
4359 or “<span class="quote">cram-md5</span>”. This option is case-insensitive. If it's
4360 <span class="emphasis"><em>unset</em></span> (the default) mutt will try all available methods,
4361 in order from most-secure to least-secure.
4365 </p><pre class="screen">
4366 set imap_authenticators="gssapi:cram-md5:login"
4369 <span class="bold"><strong>Note:</strong></span> Mutt will only fall back to other authentication methods if
4370 the previous methods are unavailable. If a method is available but
4371 authentication fails, mutt will not connect to the IMAP server.
4372 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-check-subscribed"></a>3.84. imap_check_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4373 Default: no</p></div><p>
4374 When <span class="emphasis"><em>set</em></span>, mutt will fetch the set of subscribed folders from
4375 your server on connection, and add them to the set of mailboxes
4376 it polls for new mail just as if you had issued individual “<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring incoming mail">mailboxes</a></span>”
4378 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-delim-chars"></a>3.85. imap_delim_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4379 Default: “<span class="quote"><code class="literal">/.</code></span>”</p></div><p>
4380 This contains the list of characters which you would like to treat
4381 as folder separators for displaying IMAP paths. In particular it
4382 helps in using the “<span class="quote">=</span>” shortcut for your <span class="emphasis"><em>folder</em></span> variable.
4383 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-headers"></a>3.86. imap_headers</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4384 Default: (empty)</p></div><p>
4385 Mutt requests these header fields in addition to the default headers
4386 (“<span class="quote">Date:</span>”, “<span class="quote">From:</span>”, “<span class="quote">Subject:</span>”, “<span class="quote">To:</span>”, “<span class="quote">Cc:</span>”, “<span class="quote">Message-Id:</span>”,
4387 “<span class="quote">References:</span>”, “<span class="quote">Content-Type:</span>”, “<span class="quote">Content-Description:</span>”, “<span class="quote">In-Reply-To:</span>”,
4388 “<span class="quote">Reply-To:</span>”, “<span class="quote">Lines:</span>”, “<span class="quote">List-Post:</span>”, “<span class="quote">X-Label:</span>”) from IMAP
4389 servers before displaying the index menu. You may want to add more
4390 headers for spam detection.
4392 <span class="bold"><strong>Note:</strong></span> This is a space separated list, items should be uppercase
4393 and not contain the colon, e.g. “<span class="quote">X-BOGOSITY X-SPAM-STATUS</span>” for the
4394 “<span class="quote">X-Bogosity:</span>” and “<span class="quote">X-Spam-Status:</span>” header fields.
4395 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-idle"></a>3.87. imap_idle</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4396 Default: no</p></div><p>
4397 When <span class="emphasis"><em>set</em></span>, mutt will attempt to use the IMAP IDLE extension
4398 to check for new mail in the current mailbox. Some servers
4399 (dovecot was the inspiration for this option) react badly
4400 to mutt's implementation. If your connection seems to freeze
4401 up periodically, try unsetting this.
4402 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-keepalive"></a>3.88. imap_keepalive</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4403 Default: 900</p></div><p>
4404 This variable specifies the maximum amount of time in seconds that mutt
4405 will wait before polling open IMAP connections, to prevent the server
4406 from closing them before mutt has finished with them. The default is
4407 well within the RFC-specified minimum amount of time (30 minutes) before
4408 a server is allowed to do this, but in practice the RFC does get
4409 violated every now and then. Reduce this number if you find yourself
4410 getting disconnected from your IMAP server due to inactivity.
4411 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-list-subscribed"></a>3.89. imap_list_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4412 Default: no</p></div><p>
4413 This variable configures whether IMAP folder browsing will look for
4414 only subscribed folders or all folders. This can be toggled in the
4415 IMAP browser with the <code class="literal"><toggle-subscribed></code> function.
4416 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-login"></a>3.90. imap_login</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4417 Default: (empty)</p></div><p>
4418 Your login name on the IMAP server.
4420 This variable defaults to the value of <a class="link" href="#imap-user" title="3.96. imap_user">$imap_user</a>.
4421 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-pass"></a>3.91. imap_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4422 Default: (empty)</p></div><p>
4423 Specifies the password for your IMAP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
4424 prompt you for your password when you invoke the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function
4425 or try to open an IMAP folder.
4427 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
4428 fairly secure machine, because the superuser can read your muttrc even
4429 if you are the only one who can read the file.
4430 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-passive"></a>3.92. imap_passive</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4431 Default: yes</p></div><p>
4432 When <span class="emphasis"><em>set</em></span>, mutt will not open new IMAP connections to check for new
4433 mail. Mutt will only check for new mail over existing IMAP
4434 connections. This is useful if you don't want to be prompted to
4435 user/password pairs on mutt invocation, or if opening the connection
4437 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-peek"></a>3.93. imap_peek</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4438 Default: yes</p></div><p>
4439 When <span class="emphasis"><em>set</em></span>, mutt will avoid implicitly marking your mail as read whenever
4440 you fetch a message from the server. This is generally a good thing,
4441 but can make closing an IMAP folder somewhat slower. This option
4442 exists to appease speed freaks.
4443 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-pipeline-depth"></a>3.94. imap_pipeline_depth</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4444 Default: 15</p></div><p>
4445 Controls the number of IMAP commands that may be queued up before they
4446 are sent to the server. A deeper pipeline reduces the amount of time
4447 mutt must wait for the server, and can make IMAP servers feel much
4448 more responsive. But not all servers correctly handle pipelined commands,
4449 so if you have problems you might want to try setting this variable to 0.
4451 <span class="bold"><strong>Note:</strong></span> Changes to this variable have no effect on open connections.
4452 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-servernoise"></a>3.95. imap_servernoise</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4453 Default: yes</p></div><p>
4454 When <span class="emphasis"><em>set</em></span>, mutt will display warning messages from the IMAP
4455 server as error messages. Since these messages are often
4456 harmless, or generated due to configuration problems on the
4457 server which are out of the users' hands, you may wish to suppress
4459 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-user"></a>3.96. imap_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4460 Default: (empty)</p></div><p>
4461 The name of the user whose mail you intend to access on the IMAP
4464 This variable defaults to your user name on the local machine.
4465 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="implicit-autoview"></a>3.97. implicit_autoview</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4466 Default: no</p></div><p>
4467 If set to “<span class="quote">yes</span>”, mutt will look for a mailcap entry with the
4468 “<span class="quote"><code class="literal">copiousoutput</code></span>” flag set for <span class="emphasis"><em>every</em></span> MIME attachment it doesn't have
4469 an internal viewer defined for. If such an entry is found, mutt will
4470 use the viewer defined in that entry to convert the body part to text
4472 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="include"></a>3.98. include</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4473 Default: ask-yes</p></div><p>
4474 Controls whether or not a copy of the message(s) you are replying to
4475 is included in your reply.
4476 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="include-onlyfirst"></a>3.99. include_onlyfirst</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4477 Default: no</p></div><p>
4478 Controls whether or not Mutt includes only the first attachment
4479 of the message you are replying.
4480 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="indent-string"></a>3.100. indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4481 Default: “<span class="quote"><code class="literal">> </code></span>”</p></div><p>
4482 Specifies the string to prepend to each line of text quoted in a
4483 message to which you are replying. You are strongly encouraged not to
4484 change this value, as it tends to agitate the more fanatical netizens.
4486 This option is a format string, please see the description of
4487 <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> for supported <code class="literal">printf(3)</code>-style sequences.
4489 Because for <code class="literal">format=lowed</code> style messages the quoting mechanism
4490 is strictly defined, this setting is ignored if <a class="link" href="#text-flowed" title="3.283. text_flowed">$text_flowed</a> is
4491 <span class="emphasis"><em>set</em></span>.
4492 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index-format"></a>3.101. index_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4493 Default: “<span class="quote"><code class="literal">%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s</code></span>”</p></div><p>
4494 This variable allows you to customize the message index display to
4495 your personal taste.
4497 “<span class="quote">Format strings</span>” are similar to the strings used in the C
4498 function <code class="literal">printf(3)</code> to format output (see the man page for more details).
4499 The following sequences are defined in Mutt:
4501 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>address of the author
4502 </p></dd><dt><span class="term">%A </span></dt><dd><p>reply-to address (if present; otherwise: address of author)
4503 </p></dd><dt><span class="term">%b </span></dt><dd><p>filename of the original message folder (think mailbox)
4504 </p></dd><dt><span class="term">%B </span></dt><dd><p>the list to which the letter was sent, or else the folder name (%b).
4505 </p></dd><dt><span class="term">%c </span></dt><dd><p>number of characters (bytes) in the message
4506 </p></dd><dt><span class="term">%C </span></dt><dd><p>current message number
4507 </p></dd><dt><span class="term">%d </span></dt><dd><p>date and time of the message in the format specified by
4508 <a class="link" href="#date-format" title="3.40. date_format">$date_format</a> converted to sender's time zone
4509 </p></dd><dt><span class="term">%D </span></dt><dd><p>date and time of the message in the format specified by
4510 <a class="link" href="#date-format" title="3.40. date_format">$date_format</a> converted to the local time zone
4511 </p></dd><dt><span class="term">%e </span></dt><dd><p>current message number in thread
4512 </p></dd><dt><span class="term">%E </span></dt><dd><p>number of messages in current thread
4513 </p></dd><dt><span class="term">%f </span></dt><dd><p>sender (address + real name), either From: or Return-Path:
4514 </p></dd><dt><span class="term">%F </span></dt><dd><p>author name, or recipient name if the message is from you
4515 </p></dd><dt><span class="term">%H </span></dt><dd><p>spam attribute(s) of this message
4516 </p></dd><dt><span class="term">%i </span></dt><dd><p>message-id of the current message
4517 </p></dd><dt><span class="term">%l </span></dt><dd><p>number of lines in the message (does not work with maildir,
4518 mh, and possibly IMAP folders)
4519 </p></dd><dt><span class="term">%L </span></dt><dd><p>If an address in the “<span class="quote">To:</span>” or “<span class="quote">Cc:</span>” header field matches an address
4520 defined by the users “<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>” command, this displays
4521 "To <list-name>", otherwise the same as %F.
4522 </p></dd><dt><span class="term">%m </span></dt><dd><p>total number of message in the mailbox
4523 </p></dd><dt><span class="term">%M </span></dt><dd><p>number of hidden messages if the thread is collapsed.
4524 </p></dd><dt><span class="term">%N </span></dt><dd><p>message score
4525 </p></dd><dt><span class="term">%n </span></dt><dd><p>author's real name (or address if missing)
4526 </p></dd><dt><span class="term">%O </span></dt><dd><p>original save folder where mutt would formerly have
4527 stashed the message: list name or recipient name
4528 if not sent to a list
4529 </p></dd><dt><span class="term">%P </span></dt><dd><p>progress indicator for the builtin pager (how much of the file has been displayed)
4530 </p></dd><dt><span class="term">%s </span></dt><dd><p>subject of the message
4531 </p></dd><dt><span class="term">%S </span></dt><dd><p>status of the message (“<span class="quote">N</span>”/“<span class="quote">D</span>”/“<span class="quote">d</span>”/“<span class="quote">!</span>”/“<span class="quote">r</span>”/*)
4532 </p></dd><dt><span class="term">%t </span></dt><dd><p>“<span class="quote">To:</span>” field (recipients)
4533 </p></dd><dt><span class="term">%T </span></dt><dd><p>the appropriate character from the <a class="link" href="#to-chars" title="3.290. to_chars">$to_chars</a> string
4534 </p></dd><dt><span class="term">%u </span></dt><dd><p>user (login) name of the author
4535 </p></dd><dt><span class="term">%v </span></dt><dd><p>first name of the author, or the recipient if the message is from you
4536 </p></dd><dt><span class="term">%X </span></dt><dd><p>number of attachments
4537 (please see the “<span class="quote"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></span>” section for possible speed effects)
4538 </p></dd><dt><span class="term">%y </span></dt><dd><p>“<span class="quote">X-Label:</span>” field, if present
4539 </p></dd><dt><span class="term">%Y </span></dt><dd><p>“<span class="quote">X-Label:</span>” field, if present, and <span class="emphasis"><em>(1)</em></span> not at part of a thread tree,
4540 <span class="emphasis"><em>(2)</em></span> at the top of a thread, or <span class="emphasis"><em>(3)</em></span> “<span class="quote">X-Label:</span>” is different from
4541 preceding message's “<span class="quote">X-Label:</span>”.
4542 </p></dd><dt><span class="term">%Z </span></dt><dd><p>message status flags
4543 </p></dd><dt><span class="term">%{fmt} </span></dt><dd><p>the date and time of the message is converted to sender's
4544 time zone, and “<span class="quote">fmt</span>” is expanded by the library function
4545 <code class="literal">strftime(3)</code>; a leading bang disables locales
4546 </p></dd><dt><span class="term">%[fmt] </span></dt><dd><p>the date and time of the message is converted to the local
4547 time zone, and “<span class="quote">fmt</span>” is expanded by the library function
4548 <code class="literal">strftime(3)</code>; a leading bang disables locales
4549 </p></dd><dt><span class="term">%(fmt) </span></dt><dd><p>the local date and time when the message was received.
4550 “<span class="quote">fmt</span>” is expanded by the library function <code class="literal">strftime(3)</code>;
4551 a leading bang disables locales
4552 </p></dd><dt><span class="term">%<fmt> </span></dt><dd><p>the current local time. “<span class="quote">fmt</span>” is expanded by the library
4553 function <code class="literal">strftime(3)</code>; a leading bang disables locales.
4554 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with character “<span class="quote">X</span>”
4555 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with character “<span class="quote">X</span>”
4556 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character “<span class="quote">X</span>” as pad
4557 </p></dd></dl></div><p>
4558 “<span class="quote">Soft-fill</span>” deserves some explanation: Normal right-justification
4559 will print everything to the left of the “<span class="quote">%></span>”, displaying padding and
4560 whatever lies to the right only if there's room. By contrast,
4561 soft-fill gives priority to the right-hand side, guaranteeing space
4562 to display it and showing padding only if there's still room. If
4563 necessary, soft-fill will eat text leftwards to make room for
4566 Note that these expandos are supported in
4567 “<span class="quote"><a class="link" href="#save-hook" title="16. Specify default save mailbox">save-hook</a></span>”, “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a></span>” and “<span class="quote"><a class="link" href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a></span>”, too.
4568 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ispell"></a>3.102. ispell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4569 Default: “<span class="quote"><code class="literal">ispell</code></span>”</p></div><p>
4570 How to invoke ispell (GNU's spell-checking software).
4571 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="keep-flagged"></a>3.103. keep_flagged</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4572 Default: no</p></div><p>
4573 If <span class="emphasis"><em>set</em></span>, read messages marked as flagged will not be moved
4574 from your spool mailbox to your <a class="link" href="#mbox" title="3.116. mbox">$mbox</a> mailbox, or as a result of
4575 a “<span class="quote"><a class="link" href="#mbox-hook" title="13. Using Multiple spool mailboxes">mbox-hook</a></span>” command.
4576 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="locale"></a>3.104. locale</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4577 Default: “<span class="quote"><code class="literal">C</code></span>”</p></div><p>
4578 The locale used by <code class="literal">strftime(3)</code> to format dates. Legal values are
4579 the strings your system accepts for the locale environment variable <code class="literal">$LC_TIME</code>.
4580 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mail-check"></a>3.105. mail_check</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4581 Default: 5</p></div><p>
4582 This variable configures how often (in seconds) mutt should look for
4583 new mail. Also see the <a class="link" href="#timeout" title="3.288. timeout">$timeout</a> variable.
4584 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-path"></a>3.106. mailcap_path</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4585 Default: (empty)</p></div><p>
4586 This variable specifies which files to consult when attempting to
4587 display MIME bodies not directly supported by Mutt.
4588 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-sanitize"></a>3.107. mailcap_sanitize</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4589 Default: yes</p></div><p>
4590 If <span class="emphasis"><em>set</em></span>, mutt will restrict possible characters in mailcap % expandos
4591 to a well-defined set of safe characters. This is the safe setting,
4592 but we are not sure it doesn't break some more advanced MIME stuff.
4594 <span class="bold"><strong>DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
4595 DOING!</strong></span>
4596 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache"></a>3.108. header_cache</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4597 Default: (empty)</p></div><p>
4598 This variable points to the header cache database.
4599 If pointing to a directory Mutt will contain a header cache
4600 database file per folder, if pointing to a file that file will
4601 be a single global header cache. By default it is <span class="emphasis"><em>unset</em></span> so no header
4602 caching will be used.
4604 Header caching can greatly improve speed when opening POP, IMAP
4605 MH or Maildir folders, see “<span class="quote"><a class="link" href="#caching" title="7. Local caching">caching</a></span>” for details.
4606 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-header-cache-verify"></a>3.109. maildir_header_cache_verify</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4607 Default: yes</p></div><p>
4608 Check for Maildir unaware programs other than mutt having modified maildir
4609 files when the header cache is in use. This incurs one <code class="literal">stat(2)</code> per
4610 message every time the folder is opened (which can be very slow for NFS
4612 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-pagesize"></a>3.110. header_cache_pagesize</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4613 Default: “<span class="quote"><code class="literal">16384</code></span>”</p></div><p>
4614 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
4615 this option changes the database page size. Too large or too small
4616 values can waste space, memory, or CPU time. The default should be more
4617 or less optimal for most use cases.
4618 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-compress"></a>3.111. header_cache_compress</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4619 Default: yes</p></div><p>
4620 When mutt is compiled with qdbm or tokyocabinet as header cache backend,
4621 this option determines whether the database will be compressed.
4622 Compression results in database files roughly being one fifth
4623 of the usual diskspace, but the uncompression can result in a
4624 slower opening of cached folder(s) which in general is still
4625 much faster than opening non header cached folders.
4626 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-trash"></a>3.112. maildir_trash</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4627 Default: no</p></div><p>
4628 If <span class="emphasis"><em>set</em></span>, messages marked as deleted will be saved with the maildir
4629 trashed flag instead of unlinked. <span class="bold"><strong>Note:</strong></span> this only applies
4630 to maildir-style mailboxes. Setting it will have no effect on other
4632 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mark-old"></a>3.113. mark_old</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4633 Default: yes</p></div><p>
4634 Controls whether or not mutt marks <span class="emphasis"><em>new</em></span> <span class="bold"><strong>unread</strong></span>
4635 messages as <span class="emphasis"><em>old</em></span> if you exit a mailbox without reading them.
4636 With this option <span class="emphasis"><em>set</em></span>, the next time you start mutt, the messages
4637 will show up with an “<span class="quote">O</span>” next to them in the index menu,
4638 indicating that they are old.
4639 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="markers"></a>3.114. markers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4640 Default: yes</p></div><p>
4641 Controls the display of wrapped lines in the internal pager. If set, a
4642 “<span class="quote">+</span>” marker is displayed at the beginning of wrapped lines.
4644 Also see the <a class="link" href="#smart-wrap" title="3.265. smart_wrap">$smart_wrap</a> variable.
4645 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mask"></a>3.115. mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
4646 Default: “<span class="quote"><code class="literal">!^\.[^.]</code></span>”</p></div><p>
4647 A regular expression used in the file browser, optionally preceded by
4648 the <span class="emphasis"><em>not</em></span> operator “<span class="quote">!</span>”. Only files whose names match this mask
4649 will be shown. The match is always case-sensitive.
4650 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mbox"></a>3.116. mbox</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4651 Default: “<span class="quote"><code class="literal">˜/mbox</code></span>”</p></div><p>
4652 This specifies the folder into which read mail in your <a class="link" href="#spoolfile" title="3.277. spoolfile">$spoolfile</a>
4653 folder will be appended.
4655 Also see the <a class="link" href="#move" title="3.132. move">$move</a> variable.
4656 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mbox-type"></a>3.117. mbox_type</h3></div></div></div><div class="literallayout"><p>Type: folder magic<br />
4657 Default: mbox</p></div><p>
4658 The default mailbox type used when creating new folders. May be any of
4659 “<span class="quote">mbox</span>”, “<span class="quote">MMDF</span>”, “<span class="quote">MH</span>” and “<span class="quote">Maildir</span>”.
4660 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="metoo"></a>3.118. metoo</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4661 Default: no</p></div><p>
4662 If <span class="emphasis"><em>unset</em></span>, Mutt will remove your address (see the “<span class="quote"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></span>”
4663 command) from the list of recipients when replying to a message.
4664 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-context"></a>3.119. menu_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4665 Default: 0</p></div><p>
4666 This variable controls the number of lines of context that are given
4667 when scrolling through menus. (Similar to <a class="link" href="#pager-context" title="3.139. pager_context">$pager_context</a>.)
4668 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-move-off"></a>3.120. menu_move_off</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4669 Default: yes</p></div><p>
4670 When <span class="emphasis"><em>unset</em></span>, the bottom entry of menus will never scroll up past
4671 the bottom of the screen, unless there are less entries than lines.
4672 When <span class="emphasis"><em>set</em></span>, the bottom entry may move off the bottom.
4673 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-scroll"></a>3.121. menu_scroll</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4674 Default: no</p></div><p>
4675 When <span class="emphasis"><em>set</em></span>, menus will be scrolled up or down one line when you
4676 attempt to move across a screen boundary. If <span class="emphasis"><em>unset</em></span>, the screen
4677 is cleared and the next or previous page of the menu is displayed
4678 (useful for slow links to avoid many redraws).
4679 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="meta-key"></a>3.122. meta_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4680 Default: no</p></div><p>
4681 If <span class="emphasis"><em>set</em></span>, forces Mutt to interpret keystrokes with the high bit (bit 8)
4682 set as if the user had pressed the Esc key and whatever key remains
4683 after having the high bit removed. For example, if the key pressed
4684 has an ASCII value of <code class="literal">0xf8</code>, then this is treated as if the user had
4685 pressed Esc then “<span class="quote">x</span>”. This is because the result of removing the
4686 high bit from <code class="literal">0xf8</code> is <code class="literal">0x78</code>, which is the ASCII character
4687 “<span class="quote">x</span>”.
4688 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-purge"></a>3.123. mh_purge</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4689 Default: no</p></div><p>
4690 When <span class="emphasis"><em>unset</em></span>, mutt will mimic mh's behaviour and rename deleted messages
4691 to <span class="emphasis"><em>,<old file name></em></span> in mh folders instead of really deleting
4692 them. This leaves the message on disk but makes programs reading the folder
4693 ignore it. If the variable is <span class="emphasis"><em>set</em></span>, the message files will simply be
4696 This option is similar to <a class="link" href="#maildir-trash" title="3.112. maildir_trash">$maildir_trash</a> for Maildir folders.
4697 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-flagged"></a>3.124. mh_seq_flagged</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4698 Default: “<span class="quote"><code class="literal">flagged</code></span>”</p></div><p>
4699 The name of the MH sequence used for flagged messages.
4700 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-replied"></a>3.125. mh_seq_replied</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4701 Default: “<span class="quote"><code class="literal">replied</code></span>”</p></div><p>
4702 The name of the MH sequence used to tag replied messages.
4703 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-unseen"></a>3.126. mh_seq_unseen</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4704 Default: “<span class="quote"><code class="literal">unseen</code></span>”</p></div><p>
4705 The name of the MH sequence used for unseen messages.
4706 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward"></a>3.127. mime_forward</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4707 Default: no</p></div><p>
4708 When <span class="emphasis"><em>set</em></span>, the message you are forwarding will be attached as a
4709 separate <code class="literal">message/rfc822</code> MIME part instead of included in the main body of the
4710 message. This is useful for forwarding MIME messages so the receiver
4711 can properly view the message as it was delivered to you. If you like
4712 to switch between MIME and not MIME from mail to mail, set this
4713 variable to “<span class="quote">ask-no</span>” or “<span class="quote">ask-yes</span>”.
4715 Also see <a class="link" href="#forward-decode" title="3.62. forward_decode">$forward_decode</a> and <a class="link" href="#mime-forward-decode" title="3.128. mime_forward_decode">$mime_forward_decode</a>.
4716 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-decode"></a>3.128. mime_forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4717 Default: no</p></div><p>
4718 Controls the decoding of complex MIME messages into <code class="literal">text/plain</code> when
4719 forwarding a message while <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a> is <span class="emphasis"><em>set</em></span>. Otherwise
4720 <a class="link" href="#forward-decode" title="3.62. forward_decode">$forward_decode</a> is used instead.
4721 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-rest"></a>3.129. mime_forward_rest</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4722 Default: yes</p></div><p>
4723 When forwarding multiple attachments of a MIME message from the attachment
4724 menu, attachments which cannot be decoded in a reasonable manner will
4725 be attached to the newly composed message if this option is <span class="emphasis"><em>set</em></span>.
4726 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mix-entry-format"></a>3.130. mix_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4727 Default: “<span class="quote"><code class="literal">%4n %c %-16s %a</code></span>”</p></div><p>
4728 This variable describes the format of a remailer line on the mixmaster
4729 chain selection screen. The following <code class="literal">printf(3)</code>-like sequences are
4732 </p><div class="variablelist"><dl><dt><span class="term">%n </span></dt><dd><p>The running number on the menu.
4733 </p></dd><dt><span class="term">%c </span></dt><dd><p>Remailer capabilities.
4734 </p></dd><dt><span class="term">%s </span></dt><dd><p>The remailer's short name.
4735 </p></dd><dt><span class="term">%a </span></dt><dd><p>The remailer's e-mail address.
4736 </p></dd></dl></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mixmaster"></a>3.131. mixmaster</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4737 Default: “<span class="quote"><code class="literal">mixmaster</code></span>”</p></div><p>
4738 This variable contains the path to the Mixmaster binary on your
4739 system. It is used with various sets of parameters to gather the
4740 list of known remailers, and to finally send a message through the
4742 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="move"></a>3.132. move</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4743 Default: no</p></div><p>
4744 Controls whether or not Mutt will move read messages
4745 from your spool mailbox to your <a class="link" href="#mbox" title="3.116. mbox">$mbox</a> mailbox, or as a result of
4746 a “<span class="quote"><a class="link" href="#mbox-hook" title="13. Using Multiple spool mailboxes">mbox-hook</a></span>” command.
4747 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-cachedir"></a>3.133. message_cachedir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4748 Default: (empty)</p></div><p>
4749 Set this to a directory and mutt will cache copies of messages from
4750 your IMAP and POP servers here. You are free to remove entries at any
4753 When setting this variable to a directory, mutt needs to fetch every
4754 remote message only once and can perform regular expression searches
4755 as fast as for local folders.
4757 Also see the <a class="link" href="#message-cache-clean" title="3.134. message_cache_clean">$message_cache_clean</a> variable.
4758 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-cache-clean"></a>3.134. message_cache_clean</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4759 Default: no</p></div><p>
4760 If <span class="emphasis"><em>set</em></span>, mutt will clean out obsolete entries from the message cache when
4761 the mailbox is synchronized. You probably only want to set it
4762 every once in a while, since it can be a little slow
4763 (especially for large folders).
4764 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-format"></a>3.135. message_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4765 Default: “<span class="quote"><code class="literal">%s</code></span>”</p></div><p>
4766 This is the string displayed in the “<span class="quote">attachment</span>” menu for
4767 attachments of type <code class="literal">message/rfc822</code>. For a full listing of defined
4768 <code class="literal">printf(3)</code>-like sequences see the section on <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>.
4769 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="narrow-tree"></a>3.136. narrow_tree</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4770 Default: no</p></div><p>
4771 This variable, when <span class="emphasis"><em>set</em></span>, makes the thread tree narrower, allowing
4772 deeper threads to fit on the screen.
4773 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="net-inc"></a>3.137. net_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4774 Default: 10</p></div><p>
4775 Operations that expect to transfer a large amount of data over the
4776 network will update their progress every <a class="link" href="#net-inc" title="3.137. net_inc">$net_inc</a> kilobytes.
4777 If set to 0, no progress messages will be displayed.
4779 See also <a class="link" href="#read-inc" title="3.236. read_inc">$read_inc</a>, <a class="link" href="#write-inc" title="3.305. write_inc">$write_inc</a> and <a class="link" href="#net-inc" title="3.137. net_inc">$net_inc</a>.
4780 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager"></a>3.138. pager</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4781 Default: “<span class="quote"><code class="literal">builtin</code></span>”</p></div><p>
4782 This variable specifies which pager you would like to use to view
4783 messages. The value “<span class="quote">builtin</span>” means to use the builtin pager, otherwise this
4784 variable should specify the pathname of the external pager you would
4787 Using an external pager may have some disadvantages: Additional
4788 keystrokes are necessary because you can't call mutt functions
4789 directly from the pager, and screen resizes cause lines longer than
4790 the screen width to be badly formatted in the help menu.
4791 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-context"></a>3.139. pager_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4792 Default: 0</p></div><p>
4793 This variable controls the number of lines of context that are given
4794 when displaying the next or previous page in the internal pager. By
4795 default, Mutt will display the line after the last one on the screen
4796 at the top of the next page (0 lines of context).
4797 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-format"></a>3.140. pager_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4798 Default: “<span class="quote"><code class="literal">-%Z- %C/%m: %-20.20n %s%* -- (%P)</code></span>”</p></div><p>
4799 This variable controls the format of the one-line message “<span class="quote">status</span>”
4800 displayed before each message in either the internal or an external
4801 pager. The valid sequences are listed in the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>
4803 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-index-lines"></a>3.141. pager_index_lines</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4804 Default: 0</p></div><p>
4805 Determines the number of lines of a mini-index which is shown when in
4806 the pager. The current message, unless near the top or bottom of the
4807 folder, will be roughly one third of the way down this mini-index,
4808 giving the reader the context of a few messages before and after the
4809 message. This is useful, for example, to determine how many messages
4810 remain to be read in the current thread. One of the lines is reserved
4811 for the status bar from the index, so a setting of 6
4812 will only show 5 lines of the actual index. A value of 0 results in
4813 no index being shown. If the number of messages in the current folder
4814 is less than <a class="link" href="#pager-index-lines" title="3.141. pager_index_lines">$pager_index_lines</a>, then the index will only use as
4815 many lines as it needs.
4816 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-stop"></a>3.142. pager_stop</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4817 Default: no</p></div><p>
4818 When <span class="emphasis"><em>set</em></span>, the internal-pager will <span class="bold"><strong>not</strong></span> move to the next message
4819 when you are at the end of a message and invoke the <code class="literal"><next-page></code>
4821 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autosign"></a>3.143. crypt_autosign</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4822 Default: no</p></div><p>
4823 Setting this variable will cause Mutt to always attempt to
4824 cryptographically sign outgoing messages. This can be overridden
4825 by use of the pgp menu, when signing is not required or
4826 encryption is requested as well. If <a class="link" href="#smime-is-default" title="3.152. smime_is_default">$smime_is_default</a> is <span class="emphasis"><em>set</em></span>,
4827 then OpenSSL is used instead to create S/MIME messages and settings can
4828 be overridden by use of the smime menu instead of the pgp menu.
4830 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autoencrypt"></a>3.144. crypt_autoencrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4831 Default: no</p></div><p>
4832 Setting this variable will cause Mutt to always attempt to PGP
4833 encrypt outgoing messages. This is probably only useful in
4834 connection to the “<span class="quote"><a class="link" href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a></span>” command. It can be overridden
4835 by use of the pgp menu, when encryption is not required or
4836 signing is requested as well. If <a class="link" href="#smime-is-default" title="3.152. smime_is_default">$smime_is_default</a> is <span class="emphasis"><em>set</em></span>,
4837 then OpenSSL is used instead to create S/MIME messages and
4838 settings can be overridden by use of the smime menu instead.
4840 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-ignore-subkeys"></a>3.145. pgp_ignore_subkeys</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4841 Default: yes</p></div><p>
4842 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
4843 the principal key will inherit the subkeys' capabilities. <span class="emphasis"><em>Unset</em></span> this
4844 if you want to play interesting key selection games.
4846 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replyencrypt"></a>3.146. crypt_replyencrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4847 Default: yes</p></div><p>
4848 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL encrypt replies to messages which are
4851 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replysign"></a>3.147. crypt_replysign</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4852 Default: no</p></div><p>
4853 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL sign replies to messages which are
4856 <span class="bold"><strong>Note:</strong></span> this does not work on messages that are encrypted
4857 <span class="emphasis"><em>and</em></span> signed!
4859 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replysignencrypted"></a>3.148. crypt_replysignencrypted</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4860 Default: no</p></div><p>
4861 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL sign replies to messages
4862 which are encrypted. This makes sense in combination with
4863 <a class="link" href="#crypt-replyencrypt" title="3.146. crypt_replyencrypt">$crypt_replyencrypt</a>, because it allows you to sign all
4864 messages which are automatically encrypted. This works around
4865 the problem noted in <a class="link" href="#crypt-replysign" title="3.147. crypt_replysign">$crypt_replysign</a>, that mutt is not able
4866 to find out whether an encrypted message is also signed.
4868 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-timestamp"></a>3.149. crypt_timestamp</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4869 Default: yes</p></div><p>
4870 If <span class="emphasis"><em>set</em></span>, mutt will include a time stamp in the lines surrounding
4871 PGP or S/MIME output, so spoofing such lines is more difficult.
4872 If you are using colors to mark these lines, and rely on these,
4873 you may <span class="emphasis"><em>unset</em></span> this setting.
4875 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-use-gpg-agent"></a>3.150. pgp_use_gpg_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4876 Default: no</p></div><p>
4877 If <span class="emphasis"><em>set</em></span>, mutt will use a possibly-running <code class="literal">gpg-agent(1)</code> process.
4879 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-verify-sig"></a>3.151. crypt_verify_sig</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4880 Default: yes</p></div><p>
4881 If <span class="emphasis"><em>“<span class="quote">yes</span>”</em></span>, always attempt to verify PGP or S/MIME signatures.
4882 If <span class="emphasis"><em>“<span class="quote">ask-*</span>”</em></span>, ask whether or not to verify the signature.
4883 If \Fi“<span class="quote">no</span>”, never attempt to verify cryptographic signatures.
4885 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-is-default"></a>3.152. smime_is_default</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4886 Default: no</p></div><p>
4887 The default behaviour of mutt is to use PGP on all auto-sign/encryption
4888 operations. To override and to use OpenSSL instead this must be <span class="emphasis"><em>set</em></span>.
4889 However, this has no effect while replying, since mutt will automatically
4890 select the same application that was used to sign/encrypt the original
4891 message. (Note that this variable can be overridden by unsetting <a class="link" href="#crypt-autosmime" title="3.39. crypt_autosmime">$crypt_autosmime</a>.)
4893 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ask-cert-label"></a>3.153. smime_ask_cert_label</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4894 Default: yes</p></div><p>
4895 This flag controls whether you want to be asked to enter a label
4896 for a certificate about to be added to the database or not. It is
4897 <span class="emphasis"><em>set</em></span> by default.
4899 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-use-default-key"></a>3.154. smime_decrypt_use_default_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4900 Default: yes</p></div><p>
4901 If <span class="emphasis"><em>set</em></span> (default) this tells mutt to use the default key for decryption. Otherwise,
4902 if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address
4903 to determine the key to use. It will ask you to supply a key, if it can't find one.
4905 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-entry-format"></a>3.155. pgp_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4906 Default: “<span class="quote"><code class="literal">%4n %t%f %4l/0x%k %-4a %2c %u</code></span>”</p></div><p>
4907 This variable allows you to customize the PGP key selection menu to
4908 your personal taste. This string is similar to <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>, but
4909 has its own set of <code class="literal">printf(3)</code>-like sequences:
4911 </p><div class="variablelist"><dl><dt><span class="term">%n </span></dt><dd><p>number
4912 </p></dd><dt><span class="term">%k </span></dt><dd><p>key id
4913 </p></dd><dt><span class="term">%u </span></dt><dd><p>user id
4914 </p></dd><dt><span class="term">%a </span></dt><dd><p>algorithm
4915 </p></dd><dt><span class="term">%l </span></dt><dd><p>key length
4916 </p></dd><dt><span class="term">%f </span></dt><dd><p>flags
4917 </p></dd><dt><span class="term">%c </span></dt><dd><p>capabilities
4918 </p></dd><dt><span class="term">%t </span></dt><dd><p>trust/validity of the key-uid association
4919 </p></dd><dt><span class="term">%[<s>] </span></dt><dd><p>date of the key where <s> is an <code class="literal">strftime(3)</code> expression
4920 </p></dd></dl></div><p>
4922 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-good-sign"></a>3.156. pgp_good_sign</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
4923 Default: (empty)</p></div><p>
4924 If you assign a text to this variable, then a PGP signature is only
4925 considered verified if the output from <a class="link" href="#pgp-verify-command" title="3.171. pgp_verify_command">$pgp_verify_command</a> contains
4926 the text. Use this variable if the exit code from the command is 0
4927 even for bad signatures.
4929 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-check-exit"></a>3.157. pgp_check_exit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4930 Default: yes</p></div><p>
4931 If <span class="emphasis"><em>set</em></span>, mutt will check the exit code of the PGP subprocess when
4932 signing or encrypting. A non-zero exit code means that the
4935 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-long-ids"></a>3.158. pgp_long_ids</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4936 Default: no</p></div><p>
4937 If <span class="emphasis"><em>set</em></span>, use 64 bit PGP key IDs, if <span class="emphasis"><em>unset</em></span> use the normal 32 bit key IDs.
4939 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-retainable-sigs"></a>3.159. pgp_retainable_sigs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4940 Default: no</p></div><p>
4941 If <span class="emphasis"><em>set</em></span>, signed and encrypted messages will consist of nested
4942 <code class="literal">multipart/signed</code> and <code class="literal">multipart/encrypted</code> body parts.
4944 This is useful for applications like encrypted and signed mailing
4945 lists, where the outer layer (<code class="literal">multipart/encrypted</code>) can be easily
4946 removed, while the inner <code class="literal">multipart/signed</code> part is retained.
4948 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-autoinline"></a>3.160. pgp_autoinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4949 Default: no</p></div><p>
4950 This option controls whether Mutt generates old-style inline
4951 (traditional) PGP encrypted or signed messages under certain
4952 circumstances. This can be overridden by use of the pgp menu,
4953 when inline is not required.
4955 Note that Mutt might automatically use PGP/MIME for messages
4956 which consist of more than a single MIME part. Mutt can be
4957 configured to ask before sending PGP/MIME messages when inline
4958 (traditional) would not work.
4960 Also see the <a class="link" href="#pgp-mime-auto" title="3.167. pgp_mime_auto">$pgp_mime_auto</a> variable.
4962 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
4963 <span class="bold"><strong>deprecated</strong></span>.
4965 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-replyinline"></a>3.161. pgp_replyinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4966 Default: no</p></div><p>
4967 Setting this variable will cause Mutt to always attempt to
4968 create an inline (traditional) message when replying to a
4969 message which is PGP encrypted/signed inline. This can be
4970 overridden by use of the pgp menu, when inline is not
4971 required. This option does not automatically detect if the
4972 (replied-to) message is inline; instead it relies on Mutt
4973 internals for previously checked/flagged messages.
4975 Note that Mutt might automatically use PGP/MIME for messages
4976 which consist of more than a single MIME part. Mutt can be
4977 configured to ask before sending PGP/MIME messages when inline
4978 (traditional) would not work.
4980 Also see the <a class="link" href="#pgp-mime-auto" title="3.167. pgp_mime_auto">$pgp_mime_auto</a> variable.
4982 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
4983 <span class="bold"><strong>deprecated</strong></span>.
4985 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-show-unusable"></a>3.162. pgp_show_unusable</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4986 Default: yes</p></div><p>
4987 If <span class="emphasis"><em>set</em></span>, mutt will display non-usable keys on the PGP key selection
4988 menu. This includes keys which have been revoked, have expired, or
4989 have been marked as “<span class="quote">disabled</span>” by the user.
4991 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-as"></a>3.163. pgp_sign_as</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4992 Default: (empty)</p></div><p>
4993 If you have more than one key pair, this option allows you to specify
4994 which of your private keys to use. It is recommended that you use the
4995 keyid form to specify your key (e.g. <code class="literal">0x00112233</code>).
4997 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-strict-enc"></a>3.164. pgp_strict_enc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4998 Default: yes</p></div><p>
4999 If <span class="emphasis"><em>set</em></span>, Mutt will automatically encode PGP/MIME signed messages as
5000 quoted-printable. Please note that unsetting this variable may
5001 lead to problems with non-verifyable PGP signatures, so only change
5002 this if you know what you are doing.
5004 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-timeout"></a>3.165. pgp_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5005 Default: 300</p></div><p>
5006 The number of seconds after which a cached passphrase will expire if
5009 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sort-keys"></a>3.166. pgp_sort_keys</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5010 Default: address</p></div><p>
5011 Specifies how the entries in the pgp menu are sorted. The
5012 following are legal values:
5014 </p><div class="variablelist"><dl><dt><span class="term">address </span></dt><dd><p>sort alphabetically by user id
5015 </p></dd><dt><span class="term">keyid </span></dt><dd><p>sort alphabetically by key id
5016 </p></dd><dt><span class="term">date </span></dt><dd><p>sort by key creation date
5017 </p></dd><dt><span class="term">trust </span></dt><dd><p>sort by the trust of the key
5018 </p></dd></dl></div><p>
5019 If you prefer reverse order of the above values, prefix it with
5020 “<span class="quote">reverse-</span>”.
5022 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-mime-auto"></a>3.167. pgp_mime_auto</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5023 Default: ask-yes</p></div><p>
5024 This option controls whether Mutt will prompt you for
5025 automatically sending a (signed/encrypted) message using
5026 PGP/MIME when inline (traditional) fails (for any reason).
5028 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5029 <span class="bold"><strong>deprecated</strong></span>.
5031 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-auto-decode"></a>3.168. pgp_auto_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5032 Default: no</p></div><p>
5033 If <span class="emphasis"><em>set</em></span>, mutt will automatically attempt to decrypt traditional PGP
5034 messages whenever the user performs an operation which ordinarily would
5035 result in the contents of the message being operated on. For example,
5036 if the user displays a pgp-traditional message which has not been manually
5037 checked with the <code class="literal"><a class="link" href="#check-traditional-pgp"><check-traditional-pgp></a></code> function, mutt will automatically
5038 check the message for traditional pgp.
5039 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decode-command"></a>3.169. pgp_decode_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5040 Default: (empty)</p></div><p>
5041 This format strings specifies a command which is used to decode
5042 application/pgp attachments.
5044 The PGP command formats have their own set of <code class="literal">printf(3)</code>-like sequences:
5046 </p><div class="variablelist"><dl><dt><span class="term">%p </span></dt><dd><p>Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
5047 string otherwise. Note: This may be used with a %? construct.
5048 </p></dd><dt><span class="term">%f </span></dt><dd><p>Expands to the name of a file containing a message.
5049 </p></dd><dt><span class="term">%s </span></dt><dd><p>Expands to the name of a file containing the signature part
5050 of a <code class="literal">multipart/signed</code> attachment when verifying it.
5051 </p></dd><dt><span class="term">%a </span></dt><dd><p>The value of <a class="link" href="#pgp-sign-as" title="3.163. pgp_sign_as">$pgp_sign_as</a>.
5052 </p></dd><dt><span class="term">%r </span></dt><dd><p>One or more key IDs.
5053 </p></dd></dl></div><p>
5054 For examples on how to configure these formats for the various versions
5055 of PGP which are floating around, see the pgp and gpg sample configuration files in
5056 the <code class="literal">samples/</code> subdirectory which has been installed on your system
5057 alongside the documentation.
5059 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-getkeys-command"></a>3.170. pgp_getkeys_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5060 Default: (empty)</p></div><p>
5061 This command is invoked whenever mutt will need public key information.
5062 Of the sequences supported by <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a>, %r is the only
5063 <code class="literal">printf(3)</code>-like sequence used with this format.
5065 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-command"></a>3.171. pgp_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5066 Default: (empty)</p></div><p>
5067 This command is used to verify PGP signatures.
5069 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5070 possible <code class="literal">printf(3)</code>-like sequences.
5072 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decrypt-command"></a>3.172. pgp_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5073 Default: (empty)</p></div><p>
5074 This command is used to decrypt a PGP encrypted message.
5076 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5077 possible <code class="literal">printf(3)</code>-like sequences.
5079 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-clearsign-command"></a>3.173. pgp_clearsign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5080 Default: (empty)</p></div><p>
5081 This format is used to create a old-style “<span class="quote">clearsigned</span>” PGP
5082 message. Note that the use of this format is <span class="bold"><strong>strongly</strong></span>
5083 <span class="bold"><strong>deprecated</strong></span>.
5085 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5086 possible <code class="literal">printf(3)</code>-like sequences.
5088 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-command"></a>3.174. pgp_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5089 Default: (empty)</p></div><p>
5090 This command is used to create the detached PGP signature for a
5091 <code class="literal">multipart/signed</code> PGP/MIME body part.
5093 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5094 possible <code class="literal">printf(3)</code>-like sequences.
5096 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-sign-command"></a>3.175. pgp_encrypt_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5097 Default: (empty)</p></div><p>
5098 This command is used to both sign and encrypt a body part.
5100 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5101 possible <code class="literal">printf(3)</code>-like sequences.
5103 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-only-command"></a>3.176. pgp_encrypt_only_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5104 Default: (empty)</p></div><p>
5105 This command is used to encrypt a body part without signing it.
5107 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5108 possible <code class="literal">printf(3)</code>-like sequences.
5110 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-import-command"></a>3.177. pgp_import_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5111 Default: (empty)</p></div><p>
5112 This command is used to import a key from a message into
5113 the user's public key ring.
5115 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5116 possible <code class="literal">printf(3)</code>-like sequences.
5118 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-export-command"></a>3.178. pgp_export_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5119 Default: (empty)</p></div><p>
5120 This command is used to export a public key from the user's
5123 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5124 possible <code class="literal">printf(3)</code>-like sequences.
5126 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-key-command"></a>3.179. pgp_verify_key_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5127 Default: (empty)</p></div><p>
5128 This command is used to verify key information from the key selection
5131 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5132 possible <code class="literal">printf(3)</code>-like sequences.
5134 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-secring-command"></a>3.180. pgp_list_secring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5135 Default: (empty)</p></div><p>
5136 This command is used to list the secret key ring's contents. The
5137 output format must be analogous to the one used by:
5139 </p><pre class="screen">
5140 gpg --list-keys --with-colons.
5143 This format is also generated by the <code class="literal">pgpring</code> utility which comes
5146 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5147 possible <code class="literal">printf(3)</code>-like sequences.
5149 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-pubring-command"></a>3.181. pgp_list_pubring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5150 Default: (empty)</p></div><p>
5151 This command is used to list the public key ring's contents. The
5152 output format must be analogous to the one used by
5154 </p><pre class="screen">
5155 gpg --list-keys --with-colons.
5158 This format is also generated by the <code class="literal">pgpring</code> utility which comes
5161 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.169. pgp_decode_command">$pgp_decode_command</a> command for
5162 possible <code class="literal">printf(3)</code>-like sequences.
5164 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-decrypt"></a>3.182. forward_decrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5165 Default: yes</p></div><p>
5166 Controls the handling of encrypted messages when forwarding a message.
5167 When <span class="emphasis"><em>set</em></span>, the outer layer of encryption is stripped off. This
5168 variable is only used if <a class="link" href="#mime-forward" title="3.127. mime_forward">$mime_forward</a> is <span class="emphasis"><em>set</em></span> and
5169 <a class="link" href="#mime-forward-decode" title="3.128. mime_forward_decode">$mime_forward_decode</a> is <span class="emphasis"><em>unset</em></span>.
5171 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-timeout"></a>3.183. smime_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5172 Default: 300</p></div><p>
5173 The number of seconds after which a cached passphrase will expire if
5176 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-with"></a>3.184. smime_encrypt_with</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5177 Default: (empty)</p></div><p>
5178 This sets the algorithm that should be used for encryption.
5179 Valid choices are “<span class="quote">des</span>”, “<span class="quote">des3</span>”, “<span class="quote">rc2-40</span>”, “<span class="quote">rc2-64</span>”, “<span class="quote">rc2-128</span>”.
5180 If <span class="emphasis"><em>unset</em></span>, “<span class="quote">3des</span>” (TripleDES) is used.
5182 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-keys"></a>3.185. smime_keys</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5183 Default: (empty)</p></div><p>
5184 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
5185 storage and retrieval of keys/certs by itself. This is very basic right now,
5186 and stores keys and certificates in two different directories, both
5187 named as the hash-value retrieved from OpenSSL. There is an index file
5188 which contains mailbox-address keyid pair, and which can be manually
5189 edited. This option points to the location of the private keys.
5191 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ca-location"></a>3.186. smime_ca_location</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5192 Default: (empty)</p></div><p>
5193 This variable contains the name of either a directory, or a file which
5194 contains trusted certificates for use with OpenSSL.
5196 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-certificates"></a>3.187. smime_certificates</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5197 Default: (empty)</p></div><p>
5198 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
5199 storage and retrieval of keys by itself. This is very basic right
5200 now, and keys and certificates are stored in two different
5201 directories, both named as the hash-value retrieved from
5202 OpenSSL. There is an index file which contains mailbox-address
5203 keyid pairs, and which can be manually edited. This option points to
5204 the location of the certificates.
5206 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-command"></a>3.188. smime_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5207 Default: (empty)</p></div><p>
5208 This format string specifies a command which is used to decrypt
5209 <code class="literal">application/x-pkcs7-mime</code> attachments.
5211 The OpenSSL command formats have their own set of <code class="literal">printf(3)</code>-like sequences
5214 </p><div class="variablelist"><dl><dt><span class="term">%f </span></dt><dd><p>Expands to the name of a file containing a message.
5215 </p></dd><dt><span class="term">%s </span></dt><dd><p>Expands to the name of a file containing the signature part
5216 of a <code class="literal">multipart/signed</code> attachment when verifying it.
5217 </p></dd><dt><span class="term">%k </span></dt><dd><p>The key-pair specified with <a class="link" href="#smime-default-key" title="3.199. smime_default_key">$smime_default_key</a>
5218 </p></dd><dt><span class="term">%c </span></dt><dd><p>One or more certificate IDs.
5219 </p></dd><dt><span class="term">%a </span></dt><dd><p>The algorithm used for encryption.
5220 </p></dd><dt><span class="term">%C </span></dt><dd><p>CA location: Depending on whether <a class="link" href="#smime-ca-location" title="3.186. smime_ca_location">$smime_ca_location</a>
5221 points to a directory or file, this expands to
5222 “<span class="quote">-CApath <a class="link" href="#smime-ca-location" title="3.186. smime_ca_location">$smime_ca_location</a></span>” or “<span class="quote">-CAfile <a class="link" href="#smime-ca-location" title="3.186. smime_ca_location">$smime_ca_location</a></span>”.
5223 </p></dd></dl></div><p>
5224 For examples on how to configure these formats, see the <code class="literal">smime.rc</code> in
5225 the <code class="literal">samples/</code> subdirectory which has been installed on your system
5226 alongside the documentation.
5228 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-command"></a>3.189. smime_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5229 Default: (empty)</p></div><p>
5230 This command is used to verify S/MIME signatures of type <code class="literal">multipart/signed</code>.
5232 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5233 possible <code class="literal">printf(3)</code>-like sequences.
5235 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-opaque-command"></a>3.190. smime_verify_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5236 Default: (empty)</p></div><p>
5237 This command is used to verify S/MIME signatures of type
5238 <code class="literal">application/x-pkcs7-mime</code>.
5240 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5241 possible <code class="literal">printf(3)</code>-like sequences.
5243 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-command"></a>3.191. smime_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5244 Default: (empty)</p></div><p>
5245 This command is used to created S/MIME signatures of type
5246 <code class="literal">multipart/signed</code>, which can be read by all mail clients.
5248 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5249 possible <code class="literal">printf(3)</code>-like sequences.
5251 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-opaque-command"></a>3.192. smime_sign_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5252 Default: (empty)</p></div><p>
5253 This command is used to created S/MIME signatures of type
5254 <code class="literal">application/x-pkcs7-signature</code>, which can only be handled by mail
5255 clients supporting the S/MIME extension.
5257 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5258 possible <code class="literal">printf(3)</code>-like sequences.
5260 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-command"></a>3.193. smime_encrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5261 Default: (empty)</p></div><p>
5262 This command is used to create encrypted S/MIME messages.
5264 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5265 possible <code class="literal">printf(3)</code>-like sequences.
5267 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-pk7out-command"></a>3.194. smime_pk7out_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5268 Default: (empty)</p></div><p>
5269 This command is used to extract PKCS7 structures of S/MIME signatures,
5270 in order to extract the public X509 certificate(s).
5272 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5273 possible <code class="literal">printf(3)</code>-like sequences.
5275 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-command"></a>3.195. smime_get_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5276 Default: (empty)</p></div><p>
5277 This command is used to extract X509 certificates from a PKCS7 structure.
5279 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5280 possible <code class="literal">printf(3)</code>-like sequences.
5282 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-signer-cert-command"></a>3.196. smime_get_signer_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5283 Default: (empty)</p></div><p>
5284 This command is used to extract only the signers X509 certificate from a S/MIME
5285 signature, so that the certificate's owner may get compared to the
5286 email's “<span class="quote">From:</span>” field.
5288 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5289 possible <code class="literal">printf(3)</code>-like sequences.
5291 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-import-cert-command"></a>3.197. smime_import_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5292 Default: (empty)</p></div><p>
5293 This command is used to import a certificate via smime_keys.
5295 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5296 possible <code class="literal">printf(3)</code>-like sequences.
5298 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-email-command"></a>3.198. smime_get_cert_email_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5299 Default: (empty)</p></div><p>
5300 This command is used to extract the mail address(es) used for storing
5301 X509 certificates, and for verification purposes (to check whether the
5302 certificate was issued for the sender's mailbox).
5304 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.188. smime_decrypt_command">$smime_decrypt_command</a> command for
5305 possible <code class="literal">printf(3)</code>-like sequences.
5307 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-default-key"></a>3.199. smime_default_key</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5308 Default: (empty)</p></div><p>
5309 This is the default key-pair to use for signing. This must be set to the
5310 keyid (the hash-value that OpenSSL generates) to work properly
5312 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-client-cert"></a>3.200. ssl_client_cert</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5313 Default: (empty)</p></div><p>
5314 The file containing a client certificate and its associated private
5316 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-force-tls"></a>3.201. ssl_force_tls</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5317 Default: no</p></div><p>
5318 If this variable is <span class="emphasis"><em>set</em></span>, Mutt will require that all connections
5319 to remote servers be encrypted. Furthermore it will attempt to
5320 negotiate TLS even if the server does not advertise the capability,
5321 since it would otherwise have to abort the connection anyway. This
5322 option supersedes <a class="link" href="#ssl-starttls" title="3.202. ssl_starttls">$ssl_starttls</a>.
5323 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-starttls"></a>3.202. ssl_starttls</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5324 Default: yes</p></div><p>
5325 If <span class="emphasis"><em>set</em></span> (the default), mutt will attempt to use <code class="literal">STARTTLS</code> on servers
5326 advertising the capability. When <span class="emphasis"><em>unset</em></span>, mutt will not attempt to
5327 use <code class="literal">STARTTLS</code> regardless of the server's capabilities.
5328 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="certificate-file"></a>3.203. certificate_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5329 Default: “<span class="quote"><code class="literal">˜/.mutt_certificates</code></span>”</p></div><p>
5330 This variable specifies the file where the certificates you trust
5331 are saved. When an unknown certificate is encountered, you are asked
5332 if you accept it or not. If you accept it, the certificate can also
5333 be saved in this file and further connections are automatically
5336 You can also manually add CA certificates in this file. Any server
5337 certificate that is signed with one of these CA certificates is
5338 also automatically accepted.
5342 </p><pre class="screen">
5343 set certificate_file=~/.mutt/certificates
5345 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-usesystemcerts"></a>3.204. ssl_usesystemcerts</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5346 Default: yes</p></div><p>
5347 If set to <span class="emphasis"><em>yes</em></span>, mutt will use CA certificates in the
5348 system-wide certificate store when checking if a server certificate
5349 is signed by a trusted CA.
5350 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="entropy-file"></a>3.205. entropy_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5351 Default: (empty)</p></div><p>
5352 The file which includes random data that is used to initialize SSL
5354 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv2"></a>3.206. ssl_use_sslv2</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5355 Default: yes</p></div><p>
5356 This variables specifies whether to attempt to use SSLv2 in the
5357 SSL authentication process.
5358 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv3"></a>3.207. ssl_use_sslv3</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5359 Default: yes</p></div><p>
5360 This variables specifies whether to attempt to use SSLv3 in the
5361 SSL authentication process.
5362 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-tlsv1"></a>3.208. ssl_use_tlsv1</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5363 Default: yes</p></div><p>
5364 This variables specifies whether to attempt to use TLSv1 in the
5365 SSL authentication process.
5366 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-min-dh-prime-bits"></a>3.209. ssl_min_dh_prime_bits</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5367 Default: 0</p></div><p>
5368 This variable specifies the minimum acceptable prime size (in bits)
5369 for use in any Diffie-Hellman key exchange. A value of 0 will use
5370 the default from the GNUTLS library.
5371 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-ca-certificates-file"></a>3.210. ssl_ca_certificates_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5372 Default: (empty)</p></div><p>
5373 This variable specifies a file containing trusted CA certificates.
5374 Any server certificate that is signed with one of these CA
5375 certificates is also automatically accepted.
5379 </p><pre class="screen">
5380 set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
5382 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-split"></a>3.211. pipe_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5383 Default: no</p></div><p>
5384 Used in connection with the <code class="literal"><pipe-message></code> function following
5385 <code class="literal"><tag-prefix></code>. If this variable is <span class="emphasis"><em>unset</em></span>, when piping a list of
5386 tagged messages Mutt will concatenate the messages and will pipe them
5387 all concatenated. When <span class="emphasis"><em>set</em></span>, Mutt will pipe the messages one by one.
5388 In both cases the messages are piped in the current sorted order,
5389 and the <a class="link" href="#pipe-sep" title="3.213. pipe_sep">$pipe_sep</a> separator is added after each message.
5390 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-decode"></a>3.212. pipe_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5391 Default: no</p></div><p>
5392 Used in connection with the <code class="literal"><pipe-message></code> command. When <span class="emphasis"><em>unset</em></span>,
5393 Mutt will pipe the messages without any preprocessing. When <span class="emphasis"><em>set</em></span>, Mutt
5394 will weed headers and will attempt to decode the messages
5396 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-sep"></a>3.213. pipe_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5397 Default: “<span class="quote"><code class="literal">\n</code></span>”</p></div><p>
5398 The separator to add between messages when piping a list of tagged
5399 messages to an external Unix command.
5400 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-authenticators"></a>3.214. pop_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5401 Default: (empty)</p></div><p>
5402 This is a colon-delimited list of authentication methods mutt may
5403 attempt to use to log in to an POP server, in the order mutt should
5404 try them. Authentication methods are either “<span class="quote">user</span>”, “<span class="quote">apop</span>” or any
5405 SASL mechanism, eg “<span class="quote">digest-md5</span>”, “<span class="quote">gssapi</span>” or “<span class="quote">cram-md5</span>”.
5406 This option is case-insensitive. If this option is <span class="emphasis"><em>unset</em></span>
5407 (the default) mutt will try all available methods, in order from
5408 most-secure to least-secure.
5412 </p><pre class="screen">
5413 set pop_authenticators="digest-md5:apop:user"
5415 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-auth-try-all"></a>3.215. pop_auth_try_all</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5416 Default: yes</p></div><p>
5417 If <span class="emphasis"><em>set</em></span>, Mutt will try all available authentication methods.
5418 When <span class="emphasis"><em>unset</em></span>, Mutt will only fall back to other authentication
5419 methods if the previous methods are unavailable. If a method is
5420 available but authentication fails, Mutt will not connect to the POP server.
5421 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-checkinterval"></a>3.216. pop_checkinterval</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5422 Default: 60</p></div><p>
5423 This variable configures how often (in seconds) mutt should look for
5424 new mail in the currently selected mailbox if it is a POP mailbox.
5425 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-delete"></a>3.217. pop_delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5426 Default: ask-no</p></div><p>
5427 If <span class="emphasis"><em>set</em></span>, Mutt will delete successfully downloaded messages from the POP
5428 server when using the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function. When <span class="emphasis"><em>unset</em></span>, Mutt will
5429 download messages but also leave them on the POP server.
5430 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-host"></a>3.218. pop_host</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5431 Default: (empty)</p></div><p>
5432 The name of your POP server for the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function. You
5433 can also specify an alternative port, username and password, ie:
5435 </p><pre class="screen">
5436 [pop[s]://][username[:password]@]popserver[:port]
5439 where “<span class="quote">[...]</span>” denotes an optional part.
5440 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-last"></a>3.219. pop_last</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5441 Default: no</p></div><p>
5442 If this variable is <span class="emphasis"><em>set</em></span>, mutt will try to use the “<span class="quote"><code class="literal">LAST</code></span>” POP command
5443 for retrieving only unread messages from the POP server when using
5444 the <code class="literal"><a class="link" href="#fetch-mail"><fetch-mail></a></code> function.
5445 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-reconnect"></a>3.220. pop_reconnect</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5446 Default: ask-yes</p></div><p>
5447 Controls whether or not Mutt will try to reconnect to the POP server if
5448 the connection is lost.
5449 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-user"></a>3.221. pop_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5450 Default: (empty)</p></div><p>
5451 Your login name on the POP server.
5453 This variable defaults to your user name on the local machine.
5454 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-pass"></a>3.222. pop_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5455 Default: (empty)</p></div><p>
5456 Specifies the password for your POP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
5457 prompt you for your password when you open a POP mailbox.
5459 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
5460 fairly secure machine, because the superuser can read your muttrc
5461 even if you are the only one who can read the file.
5462 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="post-indent-string"></a>3.223. post_indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5463 Default: (empty)</p></div><p>
5464 Similar to the <a class="link" href="#attribution" title="3.16. attribution">$attribution</a> variable, Mutt will append this
5465 string after the inclusion of a message which is being replied to.
5466 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postpone"></a>3.224. postpone</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5467 Default: ask-yes</p></div><p>
5468 Controls whether or not messages are saved in the <a class="link" href="#postponed" title="3.225. postponed">$postponed</a>
5469 mailbox when you elect not to send immediately.
5471 Also see the <a class="link" href="#recall" title="3.239. recall">$recall</a> variable.
5472 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postponed"></a>3.225. postponed</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5473 Default: “<span class="quote"><code class="literal">˜/postponed</code></span>”</p></div><p>
5474 Mutt allows you to indefinitely “<span class="quote"><a class="link" href="#postpone" title="3.224. postpone">postpone</a> sending a message</span>” which
5475 you are editing. When you choose to postpone a message, Mutt saves it
5476 in the mailbox specified by this variable.
5478 Also see the <a class="link" href="#postpone" title="3.224. postpone">$postpone</a> variable.
5479 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="preconnect"></a>3.226. preconnect</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5480 Default: (empty)</p></div><p>
5481 If <span class="emphasis"><em>set</em></span>, a shell command to be executed if mutt fails to establish
5482 a connection to the server. This is useful for setting up secure
5483 connections, e.g. with <code class="literal">ssh(1)</code>. If the command returns a nonzero
5484 status, mutt gives up opening the server. Example:
5486 </p><pre class="screen">
5487 set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
5488 sleep 20 < /dev/null > /dev/null"
5491 Mailbox “<span class="quote">foo</span>” on “<span class="quote">mailhost.net</span>” can now be reached
5492 as “<span class="quote">{localhost:1234}foo</span>”.
5494 Note: For this example to work, you must be able to log in to the
5495 remote machine without having to enter a password.
5496 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print"></a>3.227. print</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5497 Default: ask-no</p></div><p>
5498 Controls whether or not Mutt really prints messages.
5499 This is set to “<span class="quote">ask-no</span>” by default, because some people
5500 accidentally hit “<span class="quote">p</span>” often.
5501 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-command"></a>3.228. print_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5502 Default: “<span class="quote"><code class="literal">lpr</code></span>”</p></div><p>
5503 This specifies the command pipe that should be used to print messages.
5504 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-decode"></a>3.229. print_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5505 Default: yes</p></div><p>
5506 Used in connection with the <code class="literal"><print-message></code> command. If this
5507 option is <span class="emphasis"><em>set</em></span>, the message is decoded before it is passed to the
5508 external command specified by <a class="link" href="#print-command" title="3.228. print_command">$print_command</a>. If this option
5509 is <span class="emphasis"><em>unset</em></span>, no processing will be applied to the message when
5510 printing it. The latter setting may be useful if you are using
5511 some advanced printer filter which is able to properly format
5512 e-mail messages for printing.
5513 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-split"></a>3.230. print_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5514 Default: no</p></div><p>
5515 Used in connection with the <code class="literal"><print-message></code> command. If this option
5516 is <span class="emphasis"><em>set</em></span>, the command specified by <a class="link" href="#print-command" title="3.228. print_command">$print_command</a> is executed once for
5517 each message which is to be printed. If this option is <span class="emphasis"><em>unset</em></span>,
5518 the command specified by <a class="link" href="#print-command" title="3.228. print_command">$print_command</a> is executed only once, and
5519 all the messages are concatenated, with a form feed as the message
5522 Those who use the <code class="literal">enscript</code>(1) program's mail-printing mode will
5523 most likely want to <span class="emphasis"><em>set</em></span> this option.
5524 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="prompt-after"></a>3.231. prompt_after</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5525 Default: yes</p></div><p>
5526 If you use an <span class="emphasis"><em>external</em></span> <a class="link" href="#pager" title="3.138. pager">$pager</a>, setting this variable will
5527 cause Mutt to prompt you for a command when the pager exits rather
5528 than returning to the index menu. If <span class="emphasis"><em>unset</em></span>, Mutt will return to the
5529 index menu when the external pager exits.
5530 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-command"></a>3.232. query_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5531 Default: (empty)</p></div><p>
5532 This specifies the command that mutt will use to make external address
5533 queries. The string should contain a “<span class="quote">%s</span>”, which will be substituted
5534 with the query string the user types. See “<span class="quote"><a class="link" href="#query" title="5. External Address Queries">query</a></span>” for more
5536 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-format"></a>3.233. query_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5537 Default: “<span class="quote"><code class="literal">%4c %t %-25.25a %-25.25n %?e?(%e)?</code></span>”</p></div><p>
5538 This variable describes the format of the “<span class="quote">query</span>” menu. The
5539 following <code class="literal">printf(3)</code>-style sequences are understood:
5541 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>destination address
5542 </p></dd><dt><span class="term">%c </span></dt><dd><p>current entry number
5543 </p></dd><dt><span class="term">%e </span></dt><dd><p>extra information *
5544 </p></dd><dt><span class="term">%n </span></dt><dd><p>destination name
5545 </p></dd><dt><span class="term">%t </span></dt><dd><p>“<span class="quote">*</span>” if current entry is tagged, a space otherwise
5546 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with “<span class="quote">X</span>”
5547 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with “<span class="quote">X</span>”
5548 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character “<span class="quote">X</span>” as pad
5549 </p></dd></dl></div><p>
5550 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> documentation.
5552 * = can be optionally printed if nonzero, see the <a class="link" href="#status-format" title="3.279. status_format">$status_format</a> documentation.
5553 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="quit"></a>3.234. quit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5554 Default: yes</p></div><p>
5555 This variable controls whether “<span class="quote">quit</span>” and “<span class="quote">exit</span>” actually quit
5556 from mutt. If this option is <span class="emphasis"><em>set</em></span>, they do quit, if it is <span class="emphasis"><em>unset</em></span>, they
5557 have no effect, and if it is set to <span class="emphasis"><em>ask-yes</em></span> or <span class="emphasis"><em>ask-no</em></span>, you are
5558 prompted for confirmation when you try to quit.
5559 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="quote-regexp"></a>3.235. quote_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5560 Default: “<span class="quote"><code class="literal">^([ \t]*[|>:}#])+</code></span>”</p></div><p>
5561 A regular expression used in the internal pager to determine quoted
5562 sections of text in the body of a message. Quoted text may be filtered
5563 out using the <code class="literal"><toggle-quoted></code> command, or colored according to the
5564 “<span class="quote">color quoted</span>” family of directives.
5566 Higher levels of quoting may be colored differently (“<span class="quote">color quoted1</span>”,
5567 “<span class="quote">color quoted2</span>”, etc.). The quoting level is determined by removing
5568 the last character from the matched text and recursively reapplying
5569 the regular expression until it fails to produce a match.
5571 Match detection may be overridden by the <a class="link" href="#smileys" title="3.266. smileys">$smileys</a> regular expression.
5572 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="read-inc"></a>3.236. read_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5573 Default: 10</p></div><p>
5574 If set to a value greater than 0, Mutt will display which message it
5575 is currently on when reading a mailbox or when performing search actions
5576 such as search and limit. The message is printed after
5577 this many messages have been read or searched (e.g., if set to 25, Mutt will
5578 print a message when it is at message 25, and then again when it gets
5579 to message 50). This variable is meant to indicate progress when
5580 reading or searching large mailboxes which may take some time.
5581 When set to 0, only a single message will appear before the reading
5584 Also see the <a class="link" href="#write-inc" title="3.305. write_inc">$write_inc</a>, <a class="link" href="#net-inc" title="3.137. net_inc">$net_inc</a> and <a class="link" href="#time-inc" title="3.287. time_inc">$time_inc</a> variables and the
5585 “<span class="quote"><a class="link" href="#tuning" title="Chapter 7. Performance tuning">tuning</a></span>” section of the manual for performance considerations.
5586 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="read-only"></a>3.237. read_only</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5587 Default: no</p></div><p>
5588 If <span class="emphasis"><em>set</em></span>, all folders are opened in read-only mode.
5589 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="realname"></a>3.238. realname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5590 Default: (empty)</p></div><p>
5591 This variable specifies what “<span class="quote">real</span>” or “<span class="quote">personal</span>” name should be used
5592 when sending messages.
5594 By default, this is the GECOS field from <code class="literal">/etc/passwd</code>. Note that this
5595 variable will <span class="emphasis"><em>not</em></span> be used when the user has set a real name
5596 in the <a class="link" href="#from" title="3.66. from">$from</a> variable.
5597 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="recall"></a>3.239. recall</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5598 Default: ask-yes</p></div><p>
5599 Controls whether or not Mutt recalls postponed messages
5600 when composing a new message.
5602 <span class="emphasis"><em>Setting</em></span> this variable to is not generally useful, and thus not
5605 Also see <a class="link" href="#postponed" title="3.225. postponed">$postponed</a> variable.
5606 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="record"></a>3.240. record</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5607 Default: “<span class="quote"><code class="literal">˜/sent</code></span>”</p></div><p>
5608 This specifies the file into which your outgoing messages should be
5609 appended. (This is meant as the primary method for saving a copy of
5610 your messages, but another way to do this is using the “<span class="quote"><a class="link" href="#my-hdr" title="15. User defined headers">my_hdr</a></span>”
5611 command to create a “<span class="quote">Bcc:</span>” field with your email address in it.)
5613 The value of <span class="emphasis"><em><a class="link" href="#record" title="3.240. record">$record</a></em></span> is overridden by the <a class="link" href="#force-name" title="3.61. force_name">$force_name</a> and
5614 <a class="link" href="#save-name" title="3.252. save_name">$save_name</a> variables, and the “<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a></span>” command.
5615 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-regexp"></a>3.241. reply_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5616 Default: “<span class="quote"><code class="literal">^(re([\[0-9\]+])*|aw):[ \t]*</code></span>”</p></div><p>
5617 A regular expression used to recognize reply messages when threading
5618 and replying. The default value corresponds to the English "Re:" and
5620 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-self"></a>3.242. reply_self</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5621 Default: no</p></div><p>
5622 If <span class="emphasis"><em>unset</em></span> and you are replying to a message sent by you, Mutt will
5623 assume that you want to reply to the recipients of that message rather
5626 Also see the “<span class="quote"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></span>” command.
5627 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-to"></a>3.243. reply_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5628 Default: ask-yes</p></div><p>
5629 If <span class="emphasis"><em>set</em></span>, when replying to a message, Mutt will use the address listed
5630 in the Reply-to: header as the recipient of the reply. If <span class="emphasis"><em>unset</em></span>,
5631 it will use the address in the From: header field instead. This
5632 option is useful for reading a mailing list that sets the Reply-To:
5633 header field to the list address and you want to send a private
5634 message to the author of a message.
5635 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="resolve"></a>3.244. resolve</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5636 Default: yes</p></div><p>
5637 When <span class="emphasis"><em>set</em></span>, the cursor will be automatically advanced to the next
5638 (possibly undeleted) message whenever a command that modifies the
5639 current message is executed.
5640 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-alias"></a>3.245. reverse_alias</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5641 Default: no</p></div><p>
5642 This variable controls whether or not Mutt will display the “<span class="quote">personal</span>”
5643 name from your aliases in the index menu if it finds an alias that
5644 matches the message's sender. For example, if you have the following
5647 </p><pre class="screen">
5648 alias juser abd30425@somewhere.net (Joe User)
5651 and then you receive mail which contains the following header:
5653 </p><pre class="screen">
5654 From: abd30425@somewhere.net
5657 It would be displayed in the index menu as “<span class="quote">Joe User</span>” instead of
5658 “<span class="quote">abd30425@somewhere.net.</span>” This is useful when the person's e-mail
5659 address is not human friendly.
5660 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-name"></a>3.246. reverse_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5661 Default: no</p></div><p>
5662 It may sometimes arrive that you receive mail to a certain machine,
5663 move the messages to another machine, and reply to some the messages
5664 from there. If this variable is <span class="emphasis"><em>set</em></span>, the default <span class="emphasis"><em>From:</em></span> line of
5665 the reply messages is built using the address where you received the
5666 messages you are replying to <span class="bold"><strong>if</strong></span> that address matches your
5667 “<span class="quote"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></span>”. If the variable is <span class="emphasis"><em>unset</em></span>, or the address that would be
5668 used doesn't match your “<span class="quote"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></span>”, the <span class="emphasis"><em>From:</em></span> line will use
5669 your address on the current machine.
5671 Also see the “<span class="quote"><a class="link" href="#alternates" title="11. Alternative addresses">alternates</a></span>” command.
5672 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-realname"></a>3.247. reverse_realname</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5673 Default: yes</p></div><p>
5674 This variable fine-tunes the behaviour of the <a class="link" href="#reverse-name" title="3.246. reverse_name">$reverse_name</a> feature.
5675 When it is <span class="emphasis"><em>set</em></span>, mutt will use the address from incoming messages as-is,
5676 possibly including eventual real names. When it is <span class="emphasis"><em>unset</em></span>, mutt will
5677 override any such real names with the setting of the <a class="link" href="#realname" title="3.238. realname">$realname</a> variable.
5678 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="rfc2047-parameters"></a>3.248. rfc2047_parameters</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5679 Default: no</p></div><p>
5680 When this variable is <span class="emphasis"><em>set</em></span>, Mutt will decode RFC2047-encoded MIME
5681 parameters. You want to set this variable when mutt suggests you
5682 to save attachments to files named like:
5684 </p><pre class="screen">
5685 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
5688 When this variable is <span class="emphasis"><em>set</em></span> interactively, the change won't be
5689 active until you change folders.
5691 Note that this use of RFC2047's encoding is explicitly
5692 prohibited by the standard, but nevertheless encountered in the
5695 Also note that setting this parameter will <span class="emphasis"><em>not</em></span> have the effect
5696 that mutt <span class="emphasis"><em>generates</em></span> this kind of encoding. Instead, mutt will
5697 unconditionally use the encoding specified in RFC2231.
5698 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-address"></a>3.249. save_address</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5699 Default: no</p></div><p>
5700 If <span class="emphasis"><em>set</em></span>, mutt will take the sender's full address when choosing a
5701 default folder for saving a mail. If <a class="link" href="#save-name" title="3.252. save_name">$save_name</a> or <a class="link" href="#force-name" title="3.61. force_name">$force_name</a>
5702 is <span class="emphasis"><em>set</em></span> too, the selection of the Fcc folder will be changed as well.
5703 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-empty"></a>3.250. save_empty</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5704 Default: yes</p></div><p>
5705 When <span class="emphasis"><em>unset</em></span>, mailboxes which contain no saved messages will be removed
5706 when closed (the exception is <a class="link" href="#spoolfile" title="3.277. spoolfile">$spoolfile</a> which is never removed).
5707 If <span class="emphasis"><em>set</em></span>, mailboxes are never removed.
5709 <span class="bold"><strong>Note:</strong></span> This only applies to mbox and MMDF folders, Mutt does not
5710 delete MH and Maildir directories.
5711 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-history"></a>3.251. save_history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5712 Default: 0</p></div><p>
5713 This variable controls the size of the history (per category) saved in the
5714 <a class="link" href="#history-file" title="3.78. history_file">$history_file</a> file.
5715 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-name"></a>3.252. save_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5716 Default: no</p></div><p>
5717 This variable controls how copies of outgoing messages are saved.
5718 When <span class="emphasis"><em>set</em></span>, a check is made to see if a mailbox specified by the
5719 recipient address exists (this is done by searching for a mailbox in
5720 the <a class="link" href="#folder" title="3.58. folder">$folder</a> directory with the <span class="emphasis"><em>username</em></span> part of the
5721 recipient address). If the mailbox exists, the outgoing message will
5722 be saved to that mailbox, otherwise the message is saved to the
5723 <a class="link" href="#record" title="3.240. record">$record</a> mailbox.
5725 Also see the <a class="link" href="#force-name" title="3.61. force_name">$force_name</a> variable.
5726 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score"></a>3.253. score</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5727 Default: yes</p></div><p>
5728 When this variable is <span class="emphasis"><em>unset</em></span>, scoring is turned off. This can
5729 be useful to selectively disable scoring for certain folders when the
5730 <a class="link" href="#score-threshold-delete" title="3.254. score_threshold_delete">$score_threshold_delete</a> variable and related are used.
5731 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-delete"></a>3.254. score_threshold_delete</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5732 Default: -1</p></div><p>
5733 Messages which have been assigned a score equal to or lower than the value
5734 of this variable are automatically marked for deletion by mutt. Since
5735 mutt scores are always greater than or equal to zero, the default setting
5736 of this variable will never mark a message for deletion.
5737 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-flag"></a>3.255. score_threshold_flag</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5738 Default: 9999</p></div><p>
5739 Messages which have been assigned a score greater than or equal to this
5740 variable's value are automatically marked "flagged".
5741 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-read"></a>3.256. score_threshold_read</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5742 Default: -1</p></div><p>
5743 Messages which have been assigned a score equal to or lower than the value
5744 of this variable are automatically marked as read by mutt. Since
5745 mutt scores are always greater than or equal to zero, the default setting
5746 of this variable will never mark a message read.
5747 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="send-charset"></a>3.257. send_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5748 Default: “<span class="quote"><code class="literal">us-ascii:iso-8859-1:utf-8</code></span>”</p></div><p>
5749 A colon-delimited list of character sets for outgoing messages. Mutt will use the
5750 first character set into which the text can be converted exactly.
5751 If your <a class="link" href="#charset" title="3.25. charset">$charset</a> is not “<span class="quote">iso-8859-1</span>” and recipients may not
5752 understand “<span class="quote">UTF-8</span>”, it is advisable to include in the list an
5753 appropriate widely used standard character set (such as
5754 “<span class="quote">iso-8859-2</span>”, “<span class="quote">koi8-r</span>” or “<span class="quote">iso-2022-jp</span>”) either instead of or after
5755 “<span class="quote">iso-8859-1</span>”.
5757 In case the text cannot be converted into one of these exactly,
5758 mutt uses <a class="link" href="#charset" title="3.25. charset">$charset</a> as a fallback.
5759 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail"></a>3.258. sendmail</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5760 Default: “<span class="quote"><code class="literal">/usr/sbin/sendmail -oem -oi</code></span>”</p></div><p>
5761 Specifies the program and arguments used to deliver mail sent by Mutt.
5762 Mutt expects that the specified program interprets additional
5763 arguments as recipient addresses.
5764 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail-wait"></a>3.259. sendmail_wait</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5765 Default: 0</p></div><p>
5766 Specifies the number of seconds to wait for the <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> process
5767 to finish before giving up and putting delivery in the background.
5769 Mutt interprets the value of this variable as follows:
5771 </p><div class="variablelist"><dl><dt><span class="term">>0 </span></dt><dd><p>number of seconds to wait for sendmail to finish before continuing
5772 </p></dd><dt><span class="term">0 </span></dt><dd><p>wait forever for sendmail to finish
5773 </p></dd><dt><span class="term"><0 </span></dt><dd><p>always put sendmail in the background without waiting
5774 </p></dd></dl></div><p>
5775 Note that if you specify a value other than 0, the output of the child
5776 process will be put in a temporary file. If there is some error, you
5777 will be informed as to where to find the output.
5778 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="shell"></a>3.260. shell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5779 Default: (empty)</p></div><p>
5780 Command to use when spawning a subshell. By default, the user's login
5781 shell from <code class="literal">/etc/passwd</code> is used.
5782 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sig-dashes"></a>3.261. sig_dashes</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5783 Default: yes</p></div><p>
5784 If <span class="emphasis"><em>set</em></span>, a line containing “<span class="quote">-- </span>” (note the trailing space) will be inserted before your
5785 <a class="link" href="#signature" title="3.263. signature">$signature</a>. It is <span class="bold"><strong>strongly</strong></span> recommended that you not <span class="emphasis"><em>unset</em></span>
5786 this variable unless your signature contains just your name. The
5787 reason for this is because many software packages use “<span class="quote">-- \n</span>” to
5788 detect your signature. For example, Mutt has the ability to highlight
5789 the signature in a different color in the builtin pager.
5790 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sig-on-top"></a>3.262. sig_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5791 Default: no</p></div><p>
5792 If <span class="emphasis"><em>set</em></span>, the signature will be included before any quoted or forwarded
5793 text. It is <span class="bold"><strong>strongly</strong></span> recommended that you do not set this variable
5794 unless you really know what you are doing, and are prepared to take
5795 some heat from netiquette guardians.
5796 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="signature"></a>3.263. signature</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5797 Default: “<span class="quote"><code class="literal">˜/.signature</code></span>”</p></div><p>
5798 Specifies the filename of your signature, which is appended to all
5799 outgoing messages. If the filename ends with a pipe (“<span class="quote">|</span>”), it is
5800 assumed that filename is a shell command and input should be read from
5801 its standard output.
5802 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="simple-search"></a>3.264. simple_search</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5803 Default: “<span class="quote"><code class="literal">˜f %s | ˜s %s</code></span>”</p></div><p>
5804 Specifies how Mutt should expand a simple search into a real search
5805 pattern. A simple search is one that does not contain any of the “<span class="quote">˜</span>” pattern
5806 operators. See “<span class="quote"><a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a></span>” for more information on search patterns.
5808 For example, if you simply type “<span class="quote">joe</span>” at a search or limit prompt, Mutt
5809 will automatically expand it to the value specified by this variable by
5810 replacing “<span class="quote">%s</span>” with the supplied string.
5811 For the default value, “<span class="quote">joe</span>” would be expanded to: “<span class="quote">˜f joe | ˜s joe</span>”.
5812 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smart-wrap"></a>3.265. smart_wrap</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5813 Default: yes</p></div><p>
5814 Controls the display of lines longer than the screen width in the
5815 internal pager. If <span class="emphasis"><em>set</em></span>, long lines are wrapped at a word boundary. If
5816 <span class="emphasis"><em>unset</em></span>, lines are simply wrapped at the screen edge. Also see the
5817 <a class="link" href="#markers" title="3.114. markers">$markers</a> variable.
5818 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smileys"></a>3.266. smileys</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5819 Default: “<span class="quote"><code class="literal">(>From )|(:[-^]?[][)(><}{|/DP])</code></span>”</p></div><p>
5820 The <span class="emphasis"><em>pager</em></span> uses this variable to catch some common false
5821 positives of <a class="link" href="#quote-regexp" title="3.235. quote_regexp">$quote_regexp</a>, most notably smileys and not consider
5822 a line quoted text if it also matches <a class="link" href="#smileys" title="3.266. smileys">$smileys</a>. This mostly
5823 happens at the beginning of a line.
5824 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sleep-time"></a>3.267. sleep_time</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5825 Default: 1</p></div><p>
5826 Specifies time, in seconds, to pause while displaying certain informational
5827 messages, while moving from folder to folder and after expunging
5828 messages from the current folder. The default is to pause one second, so
5829 a value of zero for this option suppresses the pause.
5830 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-authenticators"></a>3.268. smtp_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5831 Default: (empty)</p></div><p>
5832 This is a colon-delimited list of authentication methods mutt may
5833 attempt to use to log in to an SMTP server, in the order mutt should
5834 try them. Authentication methods are any SASL mechanism, eg
5835 “<span class="quote">digest-md5</span>”, “<span class="quote">gssapi</span>” or “<span class="quote">cram-md5</span>”.
5836 This option is case-insensitive. If it is “<span class="quote">unset</span>”
5837 (the default) mutt will try all available methods, in order from
5838 most-secure to least-secure.
5842 </p><pre class="screen">
5843 set smtp_authenticators="digest-md5:cram-md5"
5845 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-pass"></a>3.269. smtp_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5846 Default: (empty)</p></div><p>
5847 Specifies the password for your SMTP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
5848 prompt you for your password when you first send mail via SMTP.
5849 See <a class="link" href="#smtp-url" title="3.270. smtp_url">$smtp_url</a> to configure mutt to send mail via SMTP.
5851 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
5852 fairly secure machine, because the superuser can read your muttrc even
5853 if you are the only one who can read the file.
5854 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-url"></a>3.270. smtp_url</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5855 Default: (empty)</p></div><p>
5856 Defines the SMTP smarthost where sent messages should relayed for
5857 delivery. This should take the form of an SMTP URL, eg:
5859 </p><pre class="screen">
5860 smtp[s]://[user[:pass]@]host[:port]/
5863 ... where “<span class="quote">[...]</span>” denotes an optional part.
5864 Setting this variable overrides the value of the <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a>
5866 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort"></a>3.271. sort</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5867 Default: date</p></div><p>
5868 Specifies how to sort messages in the “<span class="quote">index</span>” menu. Valid values
5871 </p><div class="itemizedlist"><ul type="disc"><li><p>date or date-sent
5872 </p></li><li><p>date-received
5873 </p></li><li><p>from
5874 </p></li><li><p>mailbox-order (unsorted)
5875 </p></li><li><p>score
5876 </p></li><li><p>size
5877 </p></li><li><p>spam
5878 </p></li><li><p>subject
5879 </p></li><li><p>threads
5881 </p></li></ul></div><p>
5882 You may optionally use the “<span class="quote">reverse-</span>” prefix to specify reverse sorting
5883 order (example: “<span class="quote"><code class="literal">set sort=reverse-date-sent</code></span>”).
5884 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-alias"></a>3.272. sort_alias</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5885 Default: alias</p></div><p>
5886 Specifies how the entries in the “<span class="quote">alias</span>” menu are sorted. The
5887 following are legal values:
5889 </p><div class="itemizedlist"><ul type="disc"><li><p>address (sort alphabetically by email address)
5890 </p></li><li><p>alias (sort alphabetically by alias name)
5891 </p></li><li><p>unsorted (leave in order specified in .muttrc)
5892 </p></li></ul></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-aux"></a>3.273. sort_aux</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5893 Default: date</p></div><p>
5894 When sorting by threads, this variable controls how threads are sorted
5895 in relation to other threads, and how the branches of the thread trees
5896 are sorted. This can be set to any value that <a class="link" href="#sort" title="3.271. sort">$sort</a> can, except
5897 “<span class="quote">threads</span>” (in that case, mutt will just use “<span class="quote">date-sent</span>”). You can also
5898 specify the “<span class="quote">last-</span>” prefix in addition to the “<span class="quote">reverse-</span>” prefix, but “<span class="quote">last-</span>”
5899 must come after “<span class="quote">reverse-</span>”. The “<span class="quote">last-</span>” prefix causes messages to be
5900 sorted against its siblings by which has the last descendant, using
5901 the rest of <a class="link" href="#sort-aux" title="3.273. sort_aux">$sort_aux</a> as an ordering. For instance,
5903 </p><pre class="screen">
5904 set sort_aux=last-date-received
5907 would mean that if a new message is received in a
5908 thread, that thread becomes the last one displayed (or the first, if
5909 you have “<span class="quote"><code class="literal">set sort=reverse-threads</code></span>”.)
5911 Note: For reversed <a class="link" href="#sort" title="3.271. sort">$sort</a>
5912 order <a class="link" href="#sort-aux" title="3.273. sort_aux">$sort_aux</a> is reversed again (which is not the right thing to do,
5913 but kept to not break any existing configuration setting).
5914 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-browser"></a>3.274. sort_browser</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5915 Default: alpha</p></div><p>
5916 Specifies how to sort entries in the file browser. By default, the
5917 entries are sorted alphabetically. Valid values:
5919 </p><div class="itemizedlist"><ul type="disc"><li><p>alpha (alphabetically)
5920 </p></li><li><p>date
5921 </p></li><li><p>size
5922 </p></li><li><p>unsorted
5923 </p></li></ul></div><p>
5924 You may optionally use the “<span class="quote">reverse-</span>” prefix to specify reverse sorting
5925 order (example: “<span class="quote"><code class="literal">set sort_browser=reverse-date</code></span>”).
5926 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-re"></a>3.275. sort_re</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5927 Default: yes</p></div><p>
5928 This variable is only useful when sorting by threads with
5929 <a class="link" href="#strict-threads" title="3.281. strict_threads">$strict_threads</a> <span class="emphasis"><em>unset</em></span>. In that case, it changes the heuristic
5930 mutt uses to thread messages by subject. With <a class="link" href="#sort-re" title="3.275. sort_re">$sort_re</a> <span class="emphasis"><em>set</em></span>, mutt will
5931 only attach a message as the child of another message by subject if
5932 the subject of the child message starts with a substring matching the
5933 setting of <a class="link" href="#reply-regexp" title="3.241. reply_regexp">$reply_regexp</a>. With <a class="link" href="#sort-re" title="3.275. sort_re">$sort_re</a> <span class="emphasis"><em>unset</em></span>, mutt will attach
5934 the message whether or not this is the case, as long as the
5935 non-<a class="link" href="#reply-regexp" title="3.241. reply_regexp">$reply_regexp</a> parts of both messages are identical.
5936 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="spam-separator"></a>3.276. spam_separator</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5937 Default: “<span class="quote"><code class="literal">,</code></span>”</p></div><p>
5938 This variable controls what happens when multiple spam headers
5939 are matched: if <span class="emphasis"><em>unset</em></span>, each successive header will overwrite any
5940 previous matches value for the spam label. If <span class="emphasis"><em>set</em></span>, each successive
5941 match will append to the previous, using this variable's value as a
5943 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="spoolfile"></a>3.277. spoolfile</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5944 Default: (empty)</p></div><p>
5945 If your spool mailbox is in a non-default place where Mutt cannot find
5946 it, you can specify its location with this variable. Mutt will
5947 automatically set this variable to the value of the environment
5948 variable <code class="literal">$MAIL</code> if it is not set.
5949 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-chars"></a>3.278. status_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5950 Default: “<span class="quote"><code class="literal">-*%A</code></span>”</p></div><p>
5951 Controls the characters used by the “<span class="quote">%r</span>” indicator in
5952 <a class="link" href="#status-format" title="3.279. status_format">$status_format</a>. The first character is used when the mailbox is
5953 unchanged. The second is used when the mailbox has been changed, and
5954 it needs to be resynchronized. The third is used if the mailbox is in
5955 read-only mode, or if the mailbox will not be written when exiting
5956 that mailbox (You can toggle whether to write changes to a mailbox
5957 with the <code class="literal"><toggle-write></code> operation, bound by default to “<span class="quote">%</span>”). The fourth
5958 is used to indicate that the current folder has been opened in attach-
5959 message mode (Certain operations like composing a new mail, replying,
5960 forwarding, etc. are not permitted in this mode).
5961 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-format"></a>3.279. status_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5962 Default: “<span class="quote"><code class="literal">-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---</code></span>”</p></div><p>
5963 Controls the format of the status line displayed in the “<span class="quote">index</span>”
5964 menu. This string is similar to <a class="link" href="#index-format" title="3.101. index_format">$index_format</a>, but has its own
5965 set of <code class="literal">printf(3)</code>-like sequences:
5967 </p><div class="variablelist"><dl><dt><span class="term">%b </span></dt><dd><p>number of mailboxes with new mail *
5968 </p></dd><dt><span class="term">%d </span></dt><dd><p>number of deleted messages *
5969 </p></dd><dt><span class="term">%f </span></dt><dd><p>the full pathname of the current mailbox
5970 </p></dd><dt><span class="term">%F </span></dt><dd><p>number of flagged messages *
5971 </p></dd><dt><span class="term">%h </span></dt><dd><p>local hostname
5972 </p></dd><dt><span class="term">%l </span></dt><dd><p>size (in bytes) of the current mailbox *
5973 </p></dd><dt><span class="term">%L </span></dt><dd><p>size (in bytes) of the messages shown
5974 (i.e., which match the current limit) *
5975 </p></dd><dt><span class="term">%m </span></dt><dd><p>the number of messages in the mailbox *
5976 </p></dd><dt><span class="term">%M </span></dt><dd><p>the number of messages shown (i.e., which match the current limit) *
5977 </p></dd><dt><span class="term">%n </span></dt><dd><p>number of new messages in the mailbox *
5978 </p></dd><dt><span class="term">%o </span></dt><dd><p>number of old unread messages *
5979 </p></dd><dt><span class="term">%p </span></dt><dd><p>number of postponed messages *
5980 </p></dd><dt><span class="term">%P </span></dt><dd><p>percentage of the way through the index
5981 </p></dd><dt><span class="term">%r </span></dt><dd><p>modified/read-only/won't-write/attach-message indicator,
5982 according to <a class="link" href="#status-chars" title="3.278. status_chars">$status_chars</a>
5983 </p></dd><dt><span class="term">%s </span></dt><dd><p>current sorting mode (<a class="link" href="#sort" title="3.271. sort">$sort</a>)
5984 </p></dd><dt><span class="term">%S </span></dt><dd><p>current aux sorting method (<a class="link" href="#sort-aux" title="3.273. sort_aux">$sort_aux</a>)
5985 </p></dd><dt><span class="term">%t </span></dt><dd><p>number of tagged messages *
5986 </p></dd><dt><span class="term">%u </span></dt><dd><p>number of unread messages *
5987 </p></dd><dt><span class="term">%v </span></dt><dd><p>Mutt version string
5988 </p></dd><dt><span class="term">%V </span></dt><dd><p>currently active limit pattern, if any *
5989 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with “<span class="quote">X</span>”
5990 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with “<span class="quote">X</span>”
5991 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character “<span class="quote">X</span>” as pad
5992 </p></dd></dl></div><p>
5993 For an explanation of “<span class="quote">soft-fill</span>”, see the <a class="link" href="#index-format" title="3.101. index_format">$index_format</a> documentation.
5995 * = can be optionally printed if nonzero
5997 Some of the above sequences can be used to optionally print a string
5998 if their value is nonzero. For example, you may only want to see the
5999 number of flagged messages if such messages exist, since zero is not
6000 particularly meaningful. To optionally print a string based upon one
6001 of the above sequences, the following construct is used:
6003 <code class="literal">%?<sequence_char>?<optional_string>?</code>
6005 where <span class="emphasis"><em>sequence_char</em></span> is a character from the table above, and
6006 <span class="emphasis"><em>optional_string</em></span> is the string you would like printed if
6007 <span class="emphasis"><em>sequence_char</em></span> is nonzero. <span class="emphasis"><em>optional_string</em></span> <span class="bold"><strong>may</strong></span> contain
6008 other sequences as well as normal text, but you may <span class="bold"><strong>not</strong></span> nest
6011 Here is an example illustrating how to optionally print the number of
6012 new messages in a mailbox:
6014 <code class="literal">%?n?%n new messages.?</code>
6016 You can also switch between two strings using the following construct:
6018 <code class="literal">%?<sequence_char>?<if_string>&<else_string>?</code>
6020 If the value of <span class="emphasis"><em>sequence_char</em></span> is non-zero, <span class="emphasis"><em>if_string</em></span> will
6021 be expanded, otherwise <span class="emphasis"><em>else_string</em></span> will be expanded.
6023 You can force the result of any <code class="literal">printf(3)</code>-like sequence to be lowercase
6024 by prefixing the sequence character with an underscore (“<span class="quote">_</span>”) sign.
6025 For example, if you want to display the local hostname in lowercase,
6026 you would use: “<span class="quote"><code class="literal">%_h</code></span>”.
6028 If you prefix the sequence character with a colon (“<span class="quote">:</span>”) character, mutt
6029 will replace any dots in the expansion by underscores. This might be helpful
6030 with IMAP folders that don't like dots in folder names.
6031 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-on-top"></a>3.280. status_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6032 Default: no</p></div><p>
6033 Setting this variable causes the “<span class="quote">status bar</span>” to be displayed on
6034 the first line of the screen rather than near the bottom. If <a class="link" href="#help" title="3.70. help">$help</a>
6035 is <span class="emphasis"><em>set</em></span>, too it'll be placed at the bottom.
6036 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="strict-threads"></a>3.281. strict_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6037 Default: no</p></div><p>
6038 If <span class="emphasis"><em>set</em></span>, threading will only make use of the “<span class="quote">In-Reply-To</span>” and
6039 “<span class="quote">References:</span>” fields when you <a class="link" href="#sort" title="3.271. sort">$sort</a> by message threads. By
6040 default, messages with the same subject are grouped together in
6041 “<span class="quote">pseudo threads.</span>”. This may not always be desirable, such as in a
6042 personal mailbox where you might have several unrelated messages with
6043 the subjects like “<span class="quote">hi</span>” which will get grouped together. See also
6044 <a class="link" href="#sort-re" title="3.275. sort_re">$sort_re</a> for a less drastic way of controlling this
6046 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="suspend"></a>3.282. suspend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6047 Default: yes</p></div><p>
6048 When <span class="emphasis"><em>unset</em></span>, mutt won't stop when the user presses the terminal's
6049 <span class="emphasis"><em>susp</em></span> key, usually “<span class="quote">^Z</span>”. This is useful if you run mutt
6050 inside an xterm using a command like “<span class="quote"><code class="literal">xterm -e mutt</code></span>”.
6051 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="text-flowed"></a>3.283. text_flowed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6052 Default: no</p></div><p>
6053 When <span class="emphasis"><em>set</em></span>, mutt will generate “<span class="quote">format=flowed</span>” bodies with a content type
6054 of “<span class="quote"><code class="literal">text/plain; format=flowed</code></span>”.
6055 This format is easier to handle for some mailing software, and generally
6056 just looks like ordinary text. To actually make use of this format's
6057 features, you'll need support in your editor.
6059 Note that <a class="link" href="#indent-string" title="3.100. indent_string">$indent_string</a> is ignored when this option is <span class="emphasis"><em>set</em></span>.
6060 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="thread-received"></a>3.284. thread_received</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6061 Default: no</p></div><p>
6062 When <span class="emphasis"><em>set</em></span>, mutt uses the date received rather than the date sent
6063 to thread messages by subject.
6064 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="thorough-search"></a>3.285. thorough_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6065 Default: no</p></div><p>
6066 Affects the <code class="literal">˜b</code> and <code class="literal">˜h</code> search operations described in
6067 section “<span class="quote"><a class="link" href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a></span>”. If <span class="emphasis"><em>set</em></span>, the headers and body/attachments of
6068 messages to be searched are decoded before searching. If <span class="emphasis"><em>unset</em></span>,
6069 messages are searched as they appear in the folder.
6071 Users searching attachments or for non-ASCII characters should <span class="emphasis"><em>set</em></span>
6072 this value because decoding also includes MIME parsing/decoding and possible
6073 character set conversions. Otherwise mutt will attempt to match against the
6074 raw message received (for example quoted-printable encoded or with encoded
6075 headers) which may lead to incorrect search results.
6076 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tilde"></a>3.286. tilde</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6077 Default: no</p></div><p>
6078 When <span class="emphasis"><em>set</em></span>, the internal-pager will pad blank lines to the bottom of the
6079 screen with a tilde (“<span class="quote">˜</span>”).
6080 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="time-inc"></a>3.287. time_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6081 Default: 0</p></div><p>
6082 Along with <a class="link" href="#read-inc" title="3.236. read_inc">$read_inc</a>, <a class="link" href="#write-inc" title="3.305. write_inc">$write_inc</a>, and <a class="link" href="#net-inc" title="3.137. net_inc">$net_inc</a>, this
6083 variable controls the frequency with which progress updates are
6084 displayed. It suppresses updates less than <a class="link" href="#time-inc" title="3.287. time_inc">$time_inc</a> milliseconds
6085 apart. This can improve throughput on systems with slow terminals,
6086 or when running mutt on a remote system.
6088 Also see the “<span class="quote"><a class="link" href="#tuning" title="Chapter 7. Performance tuning">tuning</a></span>” section of the manual for performance considerations.
6089 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="timeout"></a>3.288. timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6090 Default: 600</p></div><p>
6091 When Mutt is waiting for user input either idleing in menus or
6092 in an interactive prompt, Mutt would block until input is
6093 present. Depending on the context, this would prevent certain
6094 operations from working, like checking for new mail or keeping
6095 an IMAP connection alive.
6097 This variable controls how many seconds Mutt will at most wait
6098 until it aborts waiting for input, performs these operations and
6099 continues to wait for input.
6101 A value of zero or less will cause Mutt to never time out.
6102 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tmpdir"></a>3.289. tmpdir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6103 Default: (empty)</p></div><p>
6104 This variable allows you to specify where Mutt will place its
6105 temporary files needed for displaying and composing messages. If
6106 this variable is not set, the environment variable <code class="literal">$TMPDIR</code> is
6107 used. If <code class="literal">$TMPDIR</code> is not set then “<span class="quote"><code class="literal">/tmp</code></span>” is used.
6108 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="to-chars"></a>3.290. to_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6109 Default: “<span class="quote"><code class="literal"> +TCFL</code></span>”</p></div><p>
6110 Controls the character used to indicate mail addressed to you. The
6111 first character is the one used when the mail is <span class="emphasis"><em>not</em></span> addressed to your
6112 address. The second is used when you are the only
6113 recipient of the message. The third is when your address
6114 appears in the “<span class="quote">To:</span>” header field, but you are not the only recipient of
6115 the message. The fourth character is used when your
6116 address is specified in the “<span class="quote">Cc:</span>” header field, but you are not the only
6117 recipient. The fifth character is used to indicate mail that was sent
6118 by <span class="emphasis"><em>you</em></span>. The sixth character is used to indicate when a mail
6119 was sent to a mailing-list you subscribe to.
6120 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tunnel"></a>3.291. tunnel</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6121 Default: (empty)</p></div><p>
6122 Setting this variable will cause mutt to open a pipe to a command
6123 instead of a raw socket. You may be able to use this to set up
6124 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
6126 </p><pre class="screen">
6127 set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
6130 Note: For this example to work you must be able to log in to the remote
6131 machine without having to enter a password.
6132 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-8bitmime"></a>3.292. use_8bitmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6133 Default: no</p></div><p>
6134 <span class="bold"><strong>Warning:</strong></span> do not set this variable unless you are using a version
6135 of sendmail which supports the <code class="literal">-B8BITMIME</code> flag (such as sendmail
6136 8.8.x) or you may not be able to send mail.
6138 When <span class="emphasis"><em>set</em></span>, Mutt will invoke <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> with the <code class="literal">-B8BITMIME</code>
6139 flag when sending 8-bit messages to enable ESMTP negotiation.
6140 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-domain"></a>3.293. use_domain</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6141 Default: yes</p></div><p>
6142 When <span class="emphasis"><em>set</em></span>, Mutt will qualify all local addresses (ones without the
6143 “<span class="quote">@host</span>” portion) with the value of <a class="link" href="#hostname" title="3.80. hostname">$hostname</a>. If <span class="emphasis"><em>unset</em></span>, no
6144 addresses will be qualified.
6145 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-envelope-from"></a>3.294. use_envelope_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6146 Default: no</p></div><p>
6147 When <span class="emphasis"><em>set</em></span>, mutt will set the <span class="emphasis"><em>envelope</em></span> sender of the message.
6148 If <a class="link" href="#envelope-from-address" title="3.53. envelope_from_address">$envelope_from_address</a> is <span class="emphasis"><em>set</em></span>, it will be used as the sender
6149 address. If <span class="emphasis"><em>unset</em></span>, mutt will attempt to derive the sender from the
6150 “<span class="quote">From:</span>” header.
6152 Note that this information is passed to sendmail command using the
6153 <code class="literal">-f</code> command line switch. Therefore setting this option is not useful
6154 if the <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> variable already contains <code class="literal">-f</code> or if the
6155 executable pointed to by <a class="link" href="#sendmail" title="3.258. sendmail">$sendmail</a> doesn't support the <code class="literal">-f</code> switch.
6156 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-from"></a>3.295. use_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6157 Default: yes</p></div><p>
6158 When <span class="emphasis"><em>set</em></span>, Mutt will generate the “<span class="quote">From:</span>” header field when
6159 sending messages. If <span class="emphasis"><em>unset</em></span>, no “<span class="quote">From:</span>” header field will be
6160 generated unless the user explicitly sets one using the “<span class="quote"><a class="link" href="#my-hdr" title="15. User defined headers">my_hdr</a></span>”
6162 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-idn"></a>3.296. use_idn</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6163 Default: yes</p></div><p>
6164 When <span class="emphasis"><em>set</em></span>, Mutt will show you international domain names decoded.
6165 Note: You can use IDNs for addresses even if this is <span class="emphasis"><em>unset</em></span>.
6166 This variable only affects decoding.
6167 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-ipv6"></a>3.297. use_ipv6</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6168 Default: yes</p></div><p>
6169 When <span class="emphasis"><em>set</em></span>, Mutt will look for IPv6 addresses of hosts it tries to
6170 contact. If this option is <span class="emphasis"><em>unset</em></span>, Mutt will restrict itself to IPv4 addresses.
6171 Normally, the default should work.
6172 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="user-agent"></a>3.298. user_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6173 Default: yes</p></div><p>
6174 When <span class="emphasis"><em>set</em></span>, mutt will add a “<span class="quote">User-Agent:</span>” header to outgoing
6175 messages, indicating which version of mutt was used for composing
6177 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="visual"></a>3.299. visual</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6178 Default: (empty)</p></div><p>
6179 Specifies the visual editor to invoke when the “<span class="quote"><code class="literal">˜v</code></span>” command is
6180 given in the builtin editor.
6181 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wait-key"></a>3.300. wait_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6182 Default: yes</p></div><p>
6183 Controls whether Mutt will ask you to press a key after an external command
6184 has been invoked by these functions: <code class="literal"><shell-escape></code>,
6185 <code class="literal"><pipe-message></code>, <code class="literal"><pipe-entry></code>, <code class="literal"><print-message></code>,
6186 and <code class="literal"><print-entry></code> commands.
6188 It is also used when viewing attachments with “<span class="quote"><a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a></span>”, provided
6189 that the corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag,
6190 and the external program is interactive.
6192 When <span class="emphasis"><em>set</em></span>, Mutt will always ask for a key. When <span class="emphasis"><em>unset</em></span>, Mutt will wait
6193 for a key only if the external command returned a non-zero status.
6194 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="weed"></a>3.301. weed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6195 Default: yes</p></div><p>
6196 When <span class="emphasis"><em>set</em></span>, mutt will weed headers when displaying, forwarding,
6197 printing, or replying to messages.
6198 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap"></a>3.302. wrap</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6199 Default: 0</p></div><p>
6200 When set to a positive value, mutt will wrap text at <a class="link" href="#wrap" title="3.302. wrap">$wrap</a> characters.
6201 When set to a negative value, mutt will wrap text so that there are <a class="link" href="#wrap" title="3.302. wrap">$wrap</a>
6202 characters of empty space on the right side of the terminal.
6203 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap-search"></a>3.303. wrap_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6204 Default: yes</p></div><p>
6205 Controls whether searches wrap around the end.
6207 When <span class="emphasis"><em>set</em></span>, searches will wrap around the first (or last) item. When
6208 <span class="emphasis"><em>unset</em></span>, incremental searches will not wrap.
6209 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrapmargin"></a>3.304. wrapmargin</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6210 Default: 0</p></div><p>
6211 (DEPRECATED) Equivalent to setting <a class="link" href="#wrap" title="3.302. wrap">$wrap</a> with a negative value.
6212 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="write-inc"></a>3.305. write_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6213 Default: 10</p></div><p>
6214 When writing a mailbox, a message will be printed every
6215 <a class="link" href="#write-inc" title="3.305. write_inc">$write_inc</a> messages to indicate progress. If set to 0, only a
6216 single message will be displayed before writing a mailbox.
6218 Also see the <a class="link" href="#read-inc" title="3.236. read_inc">$read_inc</a>, <a class="link" href="#net-inc" title="3.137. net_inc">$net_inc</a> and <a class="link" href="#time-inc" title="3.287. time_inc">$time_inc</a> variables and the
6219 “<span class="quote"><a class="link" href="#tuning" title="Chapter 7. Performance tuning">tuning</a></span>” section of the manual for performance considerations.
6220 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="write-bcc"></a>3.306. write_bcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6221 Default: yes</p></div><p>
6222 Controls whether mutt writes out the “<span class="quote">Bcc:</span>” header when preparing
6223 messages to be sent. Exim users may wish to unset this. If mutt
6224 is set to deliver directly via SMTP (see <a class="link" href="#smtp-url" title="3.270. smtp_url">$smtp_url</a>), this
6225 option does nothing: mutt will never write out the “<span class="quote">Bcc:</span>” header
6227 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="functions"></a>4. Functions</h2></div></div></div><p>
6228 The following is the list of available functions listed by the mapping
6229 in which they are available. The default key setting is given, and an
6230 explanation of what the function does. The key bindings of these
6231 functions can be changed with the <a class="link" href="#bind" title="5. Changing the default key bindings">bind</a>
6233 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="generic_map"></a>4.1. generic menu</h3></div></div></div><p>
6234 The <span class="emphasis"><em>generic</em></span> menu is not a real menu, but specifies common functions
6235 (such as movement) available in all menus except for <span class="emphasis"><em>pager</em></span> and
6236 <span class="emphasis"><em>editor</em></span>. Changing settings for this menu will affect the default
6237 bindings for all menus (except as noted).
6238 </p><div class="table"><a id="generic_table"></a><p class="title"><b>Table 8.2. Default generic function bindings</b></p><div class="table-contents"><table summary="Default generic function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><top-page></code></td><td>H</td><td>move to the top of the page</td></tr><tr><td><code class="literal"><next-entry></code></td><td>j</td><td>move to the next entry</td></tr><tr><td><code class="literal"><previous-entry></code></td><td>k</td><td>move to the previous entry</td></tr><tr><td><code class="literal"><bottom-page></code></td><td>L</td><td>move to the bottom of the page</td></tr><tr><td><code class="literal"><refresh></code></td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td><code class="literal"><middle-page></code></td><td>M</td><td>move to the middle of the page</td></tr><tr><td><code class="literal"><search-next></code></td><td>n</td><td>search for next match</td></tr><tr><td><code class="literal"><exit></code></td><td>q</td><td>exit this menu</td></tr><tr><td><code class="literal"><tag-entry></code></td><td>t</td><td>tag the current entry</td></tr><tr><td><code class="literal"><next-page></code></td><td>z</td><td>move to the next page</td></tr><tr><td><code class="literal"><previous-page></code></td><td>Z</td><td>move to the previous page</td></tr><tr><td><code class="literal"><last-entry></code></td><td>*</td><td>move to the last entry</td></tr><tr><td><code class="literal"><first-entry></code></td><td>=</td><td>move to the first entry</td></tr><tr><td><code class="literal"><enter-command></code></td><td>:</td><td>enter a muttrc command</td></tr><tr><td><code class="literal"><next-line></code></td><td>></td><td>scroll down one line</td></tr><tr><td><code class="literal"><previous-line></code></td><td><</td><td>scroll up one line</td></tr><tr><td><code class="literal"><half-up></code></td><td>[</td><td>scroll up 1/2 page</td></tr><tr><td><code class="literal"><half-down></code></td><td>]</td><td>scroll down 1/2 page</td></tr><tr><td><code class="literal"><help></code></td><td>?</td><td>this screen</td></tr><tr><td><code class="literal"><tag-prefix></code></td><td>;</td><td>apply next function to tagged messages</td></tr><tr><td><code class="literal"><tag-prefix-cond></code></td><td> </td><td>apply next function ONLY to tagged messages</td></tr><tr><td><code class="literal"><end-cond></code></td><td> </td><td>end of conditional execution (noop)</td></tr><tr><td><code class="literal"><shell-escape></code></td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td><code class="literal"><select-entry></code></td><td><Return></td><td>select the current entry</td></tr><tr><td><code class="literal"><search></code></td><td>/</td><td>search for a regular expression</td></tr><tr><td><code class="literal"><search-reverse></code></td><td>Esc /</td><td>search backwards for a regular expression</td></tr><tr><td><code class="literal"><search-opposite></code></td><td> </td><td>search for next match in opposite direction</td></tr><tr><td><code class="literal"><jump></code></td><td> </td><td>jump to an index number</td></tr><tr><td><code class="literal"><current-top></code></td><td> </td><td>move entry to top of screen</td></tr><tr><td><code class="literal"><current-middle></code></td><td> </td><td>move entry to middle of screen</td></tr><tr><td><code class="literal"><current-bottom></code></td><td> </td><td>move entry to bottom of screen</td></tr><tr><td><code class="literal"><what-key></code></td><td> </td><td>display the keycode for a key press</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index_map"></a>4.2. index menu</h3></div></div></div><div class="table"><a id="index_table"></a><p class="title"><b>Table 8.3. Default index function bindings</b></p><div class="table-contents"><table summary="Default index function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><create-alias></code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal"><bounce-message></code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal"><break-thread></code></td><td>#</td><td>break the thread in two</td></tr><tr><td><code class="literal"><change-folder></code></td><td>c</td><td>open a different folder</td></tr><tr><td><code class="literal"><change-folder-readonly></code></td><td>Esc c</td><td>open a different folder in read only mode</td></tr><tr><td><code class="literal"><next-unread-mailbox></code></td><td> </td><td>open next mailbox with new mail</td></tr><tr><td><code class="literal"><collapse-thread></code></td><td>Esc v</td><td>collapse/uncollapse current thread</td></tr><tr><td><code class="literal"><collapse-all></code></td><td>Esc V</td><td>collapse/uncollapse all threads</td></tr><tr><td><code class="literal"><copy-message></code></td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td><code class="literal"><decode-copy></code></td><td>Esc C</td><td>make decoded (text/plain) copy</td></tr><tr><td><code class="literal"><decode-save></code></td><td>Esc s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td><code class="literal"><delete-message></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><delete-pattern></code></td><td>D</td><td>delete messages matching a pattern</td></tr><tr><td><code class="literal"><delete-thread></code></td><td>^D</td><td>delete all messages in thread</td></tr><tr><td><code class="literal"><delete-subthread></code></td><td>Esc d</td><td>delete all messages in subthread</td></tr><tr><td><code class="literal"><edit></code></td><td>e</td><td>edit the raw message</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><forward-message></code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal"><flag-message></code></td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td><code class="literal"><group-reply></code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal"><fetch-mail></code></td><td>G</td><td>retrieve mail from POP server</td></tr><tr><td><code class="literal"><imap-fetch-mail></code></td><td> </td><td>force retrieval of mail from IMAP server</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><next-undeleted></code></td><td>j</td><td>move to the next undeleted message</td></tr><tr><td><code class="literal"><previous-undeleted></code></td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td><code class="literal"><limit></code></td><td>l</td><td>show only messages matching a pattern</td></tr><tr><td><code class="literal"><link-threads></code></td><td>&</td><td>link tagged message to the current one</td></tr><tr><td><code class="literal"><list-reply></code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal"><mail></code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal"><toggle-new></code></td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td><code class="literal"><toggle-write></code></td><td>%</td><td>toggle whether the mailbox will be rewritten</td></tr><tr><td><code class="literal"><next-thread></code></td><td>^N</td><td>jump to the next thread</td></tr><tr><td><code class="literal"><next-subthread></code></td><td>Esc n</td><td>jump to the next subthread</td></tr><tr><td><code class="literal"><query></code></td><td>Q</td><td>query external program for addresses</td></tr><tr><td><code class="literal"><quit></code></td><td>q</td><td>save changes to mailbox and quit</td></tr><tr><td><code class="literal"><reply></code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal"><show-limit></code></td><td>Esc l</td><td>show currently active limit pattern</td></tr><tr><td><code class="literal"><sort-mailbox></code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal"><sort-reverse></code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal"><print-message></code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal"><previous-thread></code></td><td>^P</td><td>jump to previous thread</td></tr><tr><td><code class="literal"><previous-subthread></code></td><td>Esc p</td><td>jump to previous subthread</td></tr><tr><td><code class="literal"><recall-message></code></td><td>R</td><td>recall a postponed message</td></tr><tr><td><code class="literal"><read-thread></code></td><td>^R</td><td>mark the current thread as read</td></tr><tr><td><code class="literal"><read-subthread></code></td><td>Esc r</td><td>mark the current subthread as read</td></tr><tr><td><code class="literal"><resend-message></code></td><td>Esc e</td><td>use the current message as a template for a new one</td></tr><tr><td><code class="literal"><save-message></code></td><td>s</td><td>save message/attachment to a file</td></tr><tr><td><code class="literal"><tag-pattern></code></td><td>T</td><td>tag messages matching a pattern</td></tr><tr><td><code class="literal"><tag-subthread></code></td><td> </td><td>tag the current subthread</td></tr><tr><td><code class="literal"><tag-thread></code></td><td>Esc t</td><td>tag the current thread</td></tr><tr><td><code class="literal"><untag-pattern></code></td><td>^T</td><td>untag messages matching a pattern</td></tr><tr><td><code class="literal"><undelete-message></code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal"><undelete-pattern></code></td><td>U</td><td>undelete messages matching a pattern</td></tr><tr><td><code class="literal"><undelete-subthread></code></td><td>Esc u</td><td>undelete all messages in subthread</td></tr><tr><td><code class="literal"><undelete-thread></code></td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td><code class="literal"><view-attachments></code></td><td>v</td><td>show MIME attachments</td></tr><tr><td><code class="literal"><show-version></code></td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td><code class="literal"><set-flag></code></td><td>w</td><td>set a status flag on a message</td></tr><tr><td><code class="literal"><clear-flag></code></td><td>W</td><td>clear a status flag from a message</td></tr><tr><td><code class="literal"><display-message></code></td><td><Return></td><td>display a message</td></tr><tr><td><code class="literal"><buffy-list></code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal"><sync-mailbox></code></td><td>$</td><td>save changes to mailbox</td></tr><tr><td><code class="literal"><display-address></code></td><td>@</td><td>display full address of sender</td></tr><tr><td><code class="literal"><pipe-message></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><next-new></code></td><td> </td><td>jump to the next new message</td></tr><tr><td><code class="literal"><next-new-then-unread></code></td><td><Tab></td><td>jump to the next new or unread message</td></tr><tr><td><code class="literal"><previous-new></code></td><td> </td><td>jump to the previous new message</td></tr><tr><td><code class="literal"><previous-new-then-unread></code></td><td>Esc <Tab></td><td>jump to the previous new or unread message</td></tr><tr><td><code class="literal"><next-unread></code></td><td> </td><td>jump to the next unread message</td></tr><tr><td><code class="literal"><previous-unread></code></td><td> </td><td>jump to the previous unread message</td></tr><tr><td><code class="literal"><parent-message></code></td><td>P</td><td>jump to parent message in thread</td></tr><tr><td><code class="literal"><extract-keys></code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal"><check-traditional-pgp></code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal"><mail-key></code></td><td>Esc k</td><td>mail a PGP public key</td></tr><tr><td><code class="literal"><decrypt-copy></code></td><td> </td><td>make decrypted copy</td></tr><tr><td><code class="literal"><decrypt-save></code></td><td> </td><td>make decrypted copy and delete</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager_map"></a>4.3. pager menu</h3></div></div></div><div class="table"><a id="pager_table"></a><p class="title"><b>Table 8.4. Default pager function bindings</b></p><div class="table-contents"><table summary="Default pager function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><break-thread></code></td><td>#</td><td>break the thread in two</td></tr><tr><td><code class="literal"><create-alias></code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal"><bounce-message></code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal"><change-folder></code></td><td>c</td><td>open a different folder</td></tr><tr><td><code class="literal"><change-folder-readonly></code></td><td>Esc c</td><td>open a different folder in read only mode</td></tr><tr><td><code class="literal"><next-unread-mailbox></code></td><td> </td><td>open next mailbox with new mail</td></tr><tr><td><code class="literal"><copy-message></code></td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td><code class="literal"><decode-copy></code></td><td>Esc C</td><td>make decoded (text/plain) copy</td></tr><tr><td><code class="literal"><delete-message></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><delete-thread></code></td><td>^D</td><td>delete all messages in thread</td></tr><tr><td><code class="literal"><delete-subthread></code></td><td>Esc d</td><td>delete all messages in subthread</td></tr><tr><td><code class="literal"><edit></code></td><td>e</td><td>edit the raw message</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><forward-message></code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal"><flag-message></code></td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td><code class="literal"><group-reply></code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal"><imap-fetch-mail></code></td><td> </td><td>force retrieval of mail from IMAP server</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><next-undeleted></code></td><td>j</td><td>move to the next undeleted message</td></tr><tr><td><code class="literal"><next-entry></code></td><td>J</td><td>move to the next entry</td></tr><tr><td><code class="literal"><previous-undeleted></code></td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td><code class="literal"><previous-entry></code></td><td>K</td><td>move to the previous entry</td></tr><tr><td><code class="literal"><link-threads></code></td><td>&</td><td>link tagged message to the current one</td></tr><tr><td><code class="literal"><list-reply></code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal"><redraw-screen></code></td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td><code class="literal"><mail></code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal"><mark-as-new></code></td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td><code class="literal"><search-next></code></td><td>n</td><td>search for next match</td></tr><tr><td><code class="literal"><next-thread></code></td><td>^N</td><td>jump to the next thread</td></tr><tr><td><code class="literal"><next-subthread></code></td><td>Esc n</td><td>jump to the next subthread</td></tr><tr><td><code class="literal"><print-message></code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal"><previous-thread></code></td><td>^P</td><td>jump to previous thread</td></tr><tr><td><code class="literal"><previous-subthread></code></td><td>Esc p</td><td>jump to previous subthread</td></tr><tr><td><code class="literal"><quit></code></td><td>Q</td><td>save changes to mailbox and quit</td></tr><tr><td><code class="literal"><exit></code></td><td>q</td><td>exit this menu</td></tr><tr><td><code class="literal"><reply></code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal"><recall-message></code></td><td>R</td><td>recall a postponed message</td></tr><tr><td><code class="literal"><read-thread></code></td><td>^R</td><td>mark the current thread as read</td></tr><tr><td><code class="literal"><read-subthread></code></td><td>Esc r</td><td>mark the current subthread as read</td></tr><tr><td><code class="literal"><resend-message></code></td><td>Esc e</td><td>use the current message as a template for a new one</td></tr><tr><td><code class="literal"><save-message></code></td><td>s</td><td>save message/attachment to a file</td></tr><tr><td><code class="literal"><skip-quoted></code></td><td>S</td><td>skip beyond quoted text</td></tr><tr><td><code class="literal"><decode-save></code></td><td>Esc s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td><code class="literal"><tag-message></code></td><td>t</td><td>tag the current entry</td></tr><tr><td><code class="literal"><toggle-quoted></code></td><td>T</td><td>toggle display of quoted text</td></tr><tr><td><code class="literal"><undelete-message></code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal"><undelete-subthread></code></td><td>Esc u</td><td>undelete all messages in subthread</td></tr><tr><td><code class="literal"><undelete-thread></code></td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td><code class="literal"><view-attachments></code></td><td>v</td><td>show MIME attachments</td></tr><tr><td><code class="literal"><show-version></code></td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td><code class="literal"><search-toggle></code></td><td>\\</td><td>toggle search pattern coloring</td></tr><tr><td><code class="literal"><display-address></code></td><td>@</td><td>display full address of sender</td></tr><tr><td><code class="literal"><next-new></code></td><td> </td><td>jump to the next new message</td></tr><tr><td><code class="literal"><pipe-message></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><help></code></td><td>?</td><td>this screen</td></tr><tr><td><code class="literal"><next-page></code></td><td><Space></td><td>move to the next page</td></tr><tr><td><code class="literal"><previous-page></code></td><td>-</td><td>move to the previous page</td></tr><tr><td><code class="literal"><top></code></td><td>^</td><td>jump to the top of the message</td></tr><tr><td><code class="literal"><sync-mailbox></code></td><td>$</td><td>save changes to mailbox</td></tr><tr><td><code class="literal"><shell-escape></code></td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td><code class="literal"><enter-command></code></td><td>:</td><td>enter a muttrc command</td></tr><tr><td><code class="literal"><buffy-list></code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal"><search></code></td><td>/</td><td>search for a regular expression</td></tr><tr><td><code class="literal"><search-reverse></code></td><td>Esc /</td><td>search backwards for a regular expression</td></tr><tr><td><code class="literal"><search-opposite></code></td><td> </td><td>search for next match in opposite direction</td></tr><tr><td><code class="literal"><next-line></code></td><td><Return></td><td>scroll down one line</td></tr><tr><td><code class="literal"><jump></code></td><td> </td><td>jump to an index number</td></tr><tr><td><code class="literal"><next-unread></code></td><td> </td><td>jump to the next unread message</td></tr><tr><td><code class="literal"><previous-new></code></td><td> </td><td>jump to the previous new message</td></tr><tr><td><code class="literal"><previous-unread></code></td><td> </td><td>jump to the previous unread message</td></tr><tr><td><code class="literal"><half-up></code></td><td> </td><td>scroll up 1/2 page</td></tr><tr><td><code class="literal"><half-down></code></td><td> </td><td>scroll down 1/2 page</td></tr><tr><td><code class="literal"><previous-line></code></td><td> </td><td>scroll up one line</td></tr><tr><td><code class="literal"><bottom></code></td><td> </td><td>jump to the bottom of the message</td></tr><tr><td><code class="literal"><parent-message></code></td><td>P</td><td>jump to parent message in thread</td></tr><tr><td><code class="literal"><check-traditional-pgp></code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal"><mail-key></code></td><td>Esc k</td><td>mail a PGP public key</td></tr><tr><td><code class="literal"><extract-keys></code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal"><decrypt-copy></code></td><td> </td><td>make decrypted copy</td></tr><tr><td><code class="literal"><decrypt-save></code></td><td> </td><td>make decrypted copy and delete</td></tr><tr><td><code class="literal"><what-key></code></td><td> </td><td>display the keycode for a key press</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias_map"></a>4.4. alias menu</h3></div></div></div><div class="table"><a id="alias_table"></a><p class="title"><b>Table 8.5. Default alias function bindings</b></p><div class="table-contents"><table summary="Default alias function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><delete-entry></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><undelete-entry></code></td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query_map"></a>4.5. query menu</h3></div></div></div><div class="table"><a id="query_table"></a><p class="title"><b>Table 8.6. Default query function bindings</b></p><div class="table-contents"><table summary="Default query function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><create-alias></code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal"><mail></code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal"><query></code></td><td>Q</td><td>query external program for addresses</td></tr><tr><td><code class="literal"><query-append></code></td><td>A</td><td>append new query results to current results</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach_map"></a>4.6. attach menu</h3></div></div></div><div class="table"><a id="attach_table"></a><p class="title"><b>Table 8.7. Default attach function bindings</b></p><div class="table-contents"><table summary="Default attach function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><bounce-message></code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><print-entry></code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal"><save-entry></code></td><td>s</td><td>save message/attachment to a file</td></tr><tr><td><code class="literal"><pipe-entry></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><view-mailcap></code></td><td>m</td><td>force viewing of attachment using mailcap</td></tr><tr><td><code class="literal"><reply></code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal"><resend-message></code></td><td>Esc e</td><td>use the current message as a template for a new one</td></tr><tr><td><code class="literal"><group-reply></code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal"><list-reply></code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal"><forward-message></code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal"><view-text></code></td><td>T</td><td>view attachment as text</td></tr><tr><td><code class="literal"><view-attach></code></td><td><Return></td><td>view attachment using mailcap entry if necessary</td></tr><tr><td><code class="literal"><delete-entry></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><undelete-entry></code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal"><collapse-parts></code></td><td>v</td><td>Toggle display of subparts</td></tr><tr><td><code class="literal"><check-traditional-pgp></code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal"><extract-keys></code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose_map"></a>4.7. compose menu</h3></div></div></div><div class="table"><a id="compose_table"></a><p class="title"><b>Table 8.8. Default compose function bindings</b></p><div class="table-contents"><table summary="Default compose function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><attach-file></code></td><td>a</td><td>attach file(s) to this message</td></tr><tr><td><code class="literal"><attach-message></code></td><td>A</td><td>attach message(s) to this message</td></tr><tr><td><code class="literal"><edit-bcc></code></td><td>b</td><td>edit the BCC list</td></tr><tr><td><code class="literal"><edit-cc></code></td><td>c</td><td>edit the CC list</td></tr><tr><td><code class="literal"><copy-file></code></td><td>C</td><td>save message/attachment to a file</td></tr><tr><td><code class="literal"><detach-file></code></td><td>D</td><td>delete the current entry</td></tr><tr><td><code class="literal"><toggle-disposition></code></td><td>^D</td><td>toggle disposition between inline/attachment</td></tr><tr><td><code class="literal"><edit-description></code></td><td>d</td><td>edit attachment description</td></tr><tr><td><code class="literal"><edit-message></code></td><td>e</td><td>edit the message</td></tr><tr><td><code class="literal"><edit-headers></code></td><td>E</td><td>edit the message with headers</td></tr><tr><td><code class="literal"><edit-file></code></td><td>^X e</td><td>edit the file to be attached</td></tr><tr><td><code class="literal"><edit-encoding></code></td><td>^E</td><td>edit attachment transfer-encoding</td></tr><tr><td><code class="literal"><edit-from></code></td><td>Esc f</td><td>edit the from field</td></tr><tr><td><code class="literal"><edit-fcc></code></td><td>f</td><td>enter a file to save a copy of this message in</td></tr><tr><td><code class="literal"><filter-entry></code></td><td>F</td><td>filter attachment through a shell command</td></tr><tr><td><code class="literal"><get-attachment></code></td><td>G</td><td>get a temporary copy of an attachment</td></tr><tr><td><code class="literal"><display-toggle-weed></code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal"><ispell></code></td><td>i</td><td>run ispell on the message</td></tr><tr><td><code class="literal"><print-entry></code></td><td>l</td><td>print the current entry</td></tr><tr><td><code class="literal"><edit-mime></code></td><td>m</td><td>edit attachment using mailcap entry</td></tr><tr><td><code class="literal"><new-mime></code></td><td>n</td><td>compose new attachment using mailcap entry</td></tr><tr><td><code class="literal"><postpone-message></code></td><td>P</td><td>save this message to send later</td></tr><tr><td><code class="literal"><edit-reply-to></code></td><td>r</td><td>edit the Reply-To field</td></tr><tr><td><code class="literal"><rename-file></code></td><td>R</td><td>rename/move an attached file</td></tr><tr><td><code class="literal"><edit-subject></code></td><td>s</td><td>edit the subject of this message</td></tr><tr><td><code class="literal"><edit-to></code></td><td>t</td><td>edit the TO list</td></tr><tr><td><code class="literal"><edit-type></code></td><td>^T</td><td>edit attachment content type</td></tr><tr><td><code class="literal"><write-fcc></code></td><td>w</td><td>write the message to a folder</td></tr><tr><td><code class="literal"><toggle-unlink></code></td><td>u</td><td>toggle whether to delete file after sending it</td></tr><tr><td><code class="literal"><toggle-recode></code></td><td> </td><td>toggle recoding of this attachment</td></tr><tr><td><code class="literal"><update-encoding></code></td><td>U</td><td>update an attachment's encoding info</td></tr><tr><td><code class="literal"><view-attach></code></td><td><Return></td><td>view attachment using mailcap entry if necessary</td></tr><tr><td><code class="literal"><send-message></code></td><td>y</td><td>send the message</td></tr><tr><td><code class="literal"><pipe-entry></code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal"><attach-key></code></td><td>Esc k</td><td>attach a PGP public key</td></tr><tr><td><code class="literal"><pgp-menu></code></td><td>p</td><td>show PGP options</td></tr><tr><td><code class="literal"><forget-passphrase></code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal"><smime-menu></code></td><td>S</td><td>show S/MIME options</td></tr><tr><td><code class="literal"><mix></code></td><td>M</td><td>send the message through a mixmaster remailer chain</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postpone_map"></a>4.8. postpone menu</h3></div></div></div><div class="table"><a id="postpone_table"></a><p class="title"><b>Table 8.9. Default postpone function bindings</b></p><div class="table-contents"><table summary="Default postpone function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><delete-entry></code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal"><undelete-entry></code></td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="browser_map"></a>4.9. browser menu</h3></div></div></div><div class="table"><a id="browser_table"></a><p class="title"><b>Table 8.10. Default browser function bindings</b></p><div class="table-contents"><table summary="Default browser function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><change-dir></code></td><td>c</td><td>change directories</td></tr><tr><td><code class="literal"><display-filename></code></td><td>@</td><td>display the currently selected file's name</td></tr><tr><td><code class="literal"><enter-mask></code></td><td>m</td><td>enter a file mask</td></tr><tr><td><code class="literal"><sort></code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal"><sort-reverse></code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal"><select-new></code></td><td>N</td><td>select a new file in this directory</td></tr><tr><td><code class="literal"><check-new></code></td><td> </td><td>check mailboxes for new mail</td></tr><tr><td><code class="literal"><toggle-mailboxes></code></td><td><Tab></td><td>toggle whether to browse mailboxes or all files</td></tr><tr><td><code class="literal"><view-file></code></td><td><Space></td><td>view file</td></tr><tr><td><code class="literal"><buffy-list></code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal"><create-mailbox></code></td><td>C</td><td>create a new mailbox (IMAP only)</td></tr><tr><td><code class="literal"><delete-mailbox></code></td><td>d</td><td>delete the current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><rename-mailbox></code></td><td>r</td><td>rename the current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><subscribe></code></td><td>s</td><td>subscribe to current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><unsubscribe></code></td><td>u</td><td>unsubscribe from current mailbox (IMAP only)</td></tr><tr><td><code class="literal"><toggle-subscribed></code></td><td>T</td><td>toggle view all/subscribed mailboxes (IMAP only)</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp_map"></a>4.10. pgp menu</h3></div></div></div><div class="table"><a id="pgp_table"></a><p class="title"><b>Table 8.11. Default pgp function bindings</b></p><div class="table-contents"><table summary="Default pgp function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><verify-key></code></td><td>c</td><td>verify a PGP public key</td></tr><tr><td><code class="literal"><view-name></code></td><td>%</td><td>view the key's user id</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime_map"></a>4.11. smime menu</h3></div></div></div><div class="table"><a id="smime_table"></a><p class="title"><b>Table 8.12. Default smime function bindings</b></p><div class="table-contents"><table summary="Default smime function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><verify-key></code></td><td>c</td><td>verify a PGP public key</td></tr><tr><td><code class="literal"><view-name></code></td><td>%</td><td>view the key's user id</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mix_map"></a>4.12. mix menu</h3></div></div></div><div class="table"><a id="mix_table"></a><p class="title"><b>Table 8.13. Default mix function bindings</b></p><div class="table-contents"><table summary="Default mix function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><accept></code></td><td><Return></td><td>Accept the chain constructed</td></tr><tr><td><code class="literal"><append></code></td><td>a</td><td>Append a remailer to the chain</td></tr><tr><td><code class="literal"><insert></code></td><td>i</td><td>Insert a remailer into the chain</td></tr><tr><td><code class="literal"><delete></code></td><td>d</td><td>Delete a remailer from the chain</td></tr><tr><td><code class="literal"><chain-prev></code></td><td><Left></td><td>Select the previous element of the chain</td></tr><tr><td><code class="literal"><chain-next></code></td><td><Right></td><td>Select the next element of the chain</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editor_map"></a>4.13. editor menu</h3></div></div></div><div class="table"><a id="editor_table"></a><p class="title"><b>Table 8.14. Default editor function bindings</b></p><div class="table-contents"><table summary="Default editor function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal"><bol></code></td><td>^A</td><td>jump to the beginning of the line</td></tr><tr><td><code class="literal"><backward-char></code></td><td>^B</td><td>move the cursor one character to the left</td></tr><tr><td><code class="literal"><backward-word></code></td><td>Esc b</td><td>move the cursor to the beginning of the word</td></tr><tr><td><code class="literal"><capitalize-word></code></td><td>Esc c</td><td>capitalize the word</td></tr><tr><td><code class="literal"><downcase-word></code></td><td>Esc l</td><td>convert the word to lower case</td></tr><tr><td><code class="literal"><upcase-word></code></td><td>Esc u</td><td>convert the word to upper case</td></tr><tr><td><code class="literal"><delete-char></code></td><td>^D</td><td>delete the char under the cursor</td></tr><tr><td><code class="literal"><eol></code></td><td>^E</td><td>jump to the end of the line</td></tr><tr><td><code class="literal"><forward-char></code></td><td>^F</td><td>move the cursor one character to the right</td></tr><tr><td><code class="literal"><forward-word></code></td><td>Esc f</td><td>move the cursor to the end of the word</td></tr><tr><td><code class="literal"><backspace></code></td><td><Backspace></td><td>delete the char in front of the cursor</td></tr><tr><td><code class="literal"><kill-eol></code></td><td>^K</td><td>delete chars from cursor to end of line</td></tr><tr><td><code class="literal"><kill-eow></code></td><td>Esc d</td><td>delete chars from the cursor to the end of the word</td></tr><tr><td><code class="literal"><kill-line></code></td><td>^U</td><td>delete all chars on the line</td></tr><tr><td><code class="literal"><quote-char></code></td><td>^V</td><td>quote the next typed key</td></tr><tr><td><code class="literal"><kill-word></code></td><td>^W</td><td>delete the word in front of the cursor</td></tr><tr><td><code class="literal"><complete></code></td><td><Tab></td><td>complete filename or alias</td></tr><tr><td><code class="literal"><complete-query></code></td><td>^T</td><td>complete address with query</td></tr><tr><td><code class="literal"><buffy-cycle></code></td><td><Space></td><td>cycle among incoming mailboxes</td></tr><tr><td><code class="literal"><history-up></code></td><td> </td><td>scroll up through the history list</td></tr><tr><td><code class="literal"><history-down></code></td><td> </td><td>scroll down through the history list</td></tr><tr><td><code class="literal"><transpose-chars></code></td><td> </td><td>transpose character under cursor with previous</td></tr></tbody></table></div></div><br class="table-break" /></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="miscellany"></a>Chapter 9. Miscellany</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#acknowledgements">1. Acknowledgements</a></span></dt><dt><span class="sect1"><a href="#about">2. About this document</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="acknowledgements"></a>1. Acknowledgements</h2></div></div></div><p>
6239 Kari Hurtta <code class="email"><<a class="email" href="mailto:kari.hurtta@fmi.fi">kari.hurtta@fmi.fi</a>></code>
6240 co-developed the original MIME parsing code back in the ELM-ME days.
6242 The following people have been very helpful to the development of Mutt:
6243 </p><div class="itemizedlist"><ul type="disc"><li><p>Vikas Agnihotri <code class="email"><<a class="email" href="mailto:vikasa@writeme.com">vikasa@writeme.com</a>></code></p></li><li><p>Francois Berjon <code class="email"><<a class="email" href="mailto:Francois.Berjon@aar.alcatel-alsthom.fr">Francois.Berjon@aar.alcatel-alsthom.fr</a>></code></p></li><li><p>Aric Blumer <code class="email"><<a class="email" href="mailto:aric@fore.com">aric@fore.com</a>></code></p></li><li><p>John Capo <code class="email"><<a class="email" href="mailto:jc@irbs.com">jc@irbs.com</a>></code></p></li><li><p>David Champion <code class="email"><<a class="email" href="mailto:dgc@uchicago.edu">dgc@uchicago.edu</a>></code></p></li><li><p>Brendan Cully <code class="email"><<a class="email" href="mailto:brendan@kublai.com">brendan@kublai.com</a>></code></p></li><li><p>Liviu Daia <code class="email"><<a class="email" href="mailto:daia@stoilow.imar.ro">daia@stoilow.imar.ro</a>></code></p></li><li><p>Thomas E. Dickey <code class="email"><<a class="email" href="mailto:dickey@herndon4.his.com">dickey@herndon4.his.com</a>></code></p></li><li><p>David DeSimone <code class="email"><<a class="email" href="mailto:fox@convex.hp.com">fox@convex.hp.com</a>></code></p></li><li><p>Nickolay N. Dudorov <code class="email"><<a class="email" href="mailto:nnd@wint.itfs.nsk.su">nnd@wint.itfs.nsk.su</a>></code></p></li><li><p>Ruslan Ermilov <code class="email"><<a class="email" href="mailto:ru@freebsd.org">ru@freebsd.org</a>></code></p></li><li><p>Edmund Grimley Evans <code class="email"><<a class="email" href="mailto:edmundo@rano.org">edmundo@rano.org</a>></code></p></li><li><p>Michael Finken <code class="email"><<a class="email" href="mailto:finken@conware.de">finken@conware.de</a>></code></p></li><li><p>Sven Guckes <code class="email"><<a class="email" href="mailto:guckes@math.fu-berlin.de">guckes@math.fu-berlin.de</a>></code></p></li><li><p>Lars Hecking <code class="email"><<a class="email" href="mailto:lhecking@nmrc.ie">lhecking@nmrc.ie</a>></code></p></li><li><p>Mark Holloman <code class="email"><<a class="email" href="mailto:holloman@nando.net">holloman@nando.net</a>></code></p></li><li><p>Andreas Holzmann <code class="email"><<a class="email" href="mailto:holzmann@fmi.uni-passau.de">holzmann@fmi.uni-passau.de</a>></code></p></li><li><p>Marco d'Itri <code class="email"><<a class="email" href="mailto:md@linux.it">md@linux.it</a>></code></p></li><li><p>Björn Jacke <code class="email"><<a class="email" href="mailto:bjacke@suse.com">bjacke@suse.com</a>></code></p></li><li><p>Byrial Jensen <code class="email"><<a class="email" href="mailto:byrial@image.dk">byrial@image.dk</a>></code></p></li><li><p>David Jeske <code class="email"><<a class="email" href="mailto:jeske@igcom.net">jeske@igcom.net</a>></code></p></li><li><p>Christophe Kalt <code class="email"><<a class="email" href="mailto:kalt@hugo.int-evry.fr">kalt@hugo.int-evry.fr</a>></code></p></li><li><p>Tommi Komulainen <code class="email"><<a class="email" href="mailto:Tommi.Komulainen@iki.fi">Tommi.Komulainen@iki.fi</a>></code></p></li><li><p>Felix von Leitner (a.k.a “<span class="quote">Fefe</span>”) <code class="email"><<a class="email" href="mailto:leitner@math.fu-berlin.de">leitner@math.fu-berlin.de</a>></code></p></li><li><p>Brandon Long <code class="email"><<a class="email" href="mailto:blong@fiction.net">blong@fiction.net</a>></code></p></li><li><p>Jimmy Mäkelä <code class="email"><<a class="email" href="mailto:jmy@flashback.net">jmy@flashback.net</a>></code></p></li><li><p>Lars Marowsky-Bree <code class="email"><<a class="email" href="mailto:lmb@pointer.in-minden.de">lmb@pointer.in-minden.de</a>></code></p></li><li><p>Thomas “<span class="quote">Mike</span>” Michlmayr <code class="email"><<a class="email" href="mailto:mike@cosy.sbg.ac.at">mike@cosy.sbg.ac.at</a>></code></p></li><li><p>Andrew W. Nosenko <code class="email"><<a class="email" href="mailto:awn@bcs.zp.ua">awn@bcs.zp.ua</a>></code></p></li><li><p>David O'Brien <code class="email"><<a class="email" href="mailto:obrien@Nuxi.cs.ucdavis.edu">obrien@Nuxi.cs.ucdavis.edu</a>></code></p></li><li><p>Clint Olsen <code class="email"><<a class="email" href="mailto:olsenc@ichips.intel.com">olsenc@ichips.intel.com</a>></code></p></li><li><p>Park Myeong Seok <code class="email"><<a class="email" href="mailto:pms@romance.kaist.ac.kr">pms@romance.kaist.ac.kr</a>></code></p></li><li><p>Thomas Parmelan <code class="email"><<a class="email" href="mailto:tom@ankh.fr.eu.org">tom@ankh.fr.eu.org</a>></code></p></li><li><p>Ollivier Robert <code class="email"><<a class="email" href="mailto:roberto@keltia.freenix.fr">roberto@keltia.freenix.fr</a>></code></p></li><li><p>Thomas Roessler <code class="email"><<a class="email" href="mailto:roessler@does-not-exist.org">roessler@does-not-exist.org</a>></code></p></li><li><p>Roland Rosenfeld <code class="email"><<a class="email" href="mailto:roland@spinnaker.de">roland@spinnaker.de</a>></code></p></li><li><p>Rocco Rutte <code class="email"><<a class="email" href="mailto:pdmef@gmx.net">pdmef@gmx.net</a>></code></p></li><li><p>TAKIZAWA Takashi <code class="email"><<a class="email" href="mailto:taki@luna.email.ne.jp">taki@luna.email.ne.jp</a>></code></p></li><li><p>Allain Thivillon <code class="email"><<a class="email" href="mailto:Allain.Thivillon@alma.fr">Allain.Thivillon@alma.fr</a>></code></p></li><li><p>Gero Treuner <code class="email"><<a class="email" href="mailto:gero@70t.de">gero@70t.de</a>></code></p></li><li><p>Vsevolod Volkov <code class="email"><<a class="email" href="mailto:vvv@lucky.net">vvv@lucky.net</a>></code></p></li><li><p>Ken Weinert <code class="email"><<a class="email" href="mailto:kenw@ihs.com">kenw@ihs.com</a>></code></p></li></ul></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="about"></a>2. About this document</h2></div></div></div><p>
6244 This document was written in <a class="ulink" href="http://docbook.sourceforge.net" target="_top">DocBook</a>,
6245 and then rendered using the <a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">Gnome XSLT toolkit</a>.
6246 </p></div></div></div></body></html>
projects / software / mutt-debian.git / blob