]> git.llucax.com Git - software/mutt-debian.git/blob - doc/manual.html
Make mutt-nntp depend on mutt >= 1.5.21-5
[software/mutt-debian.git] / doc / manual.html
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <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.75.2" /><meta name="description" content="All mail clients suck. This one just sucks less. — me, circa 1995" /><style xmlns="" type="text/css">
4       body { margin-left:2%; margin-right:2%; font-family:serif; }
5 .toc, .list-of-tables, .list-of-examples { font-family:sans-serif; }
6 h1, h2, h3, h4, h5, h6 { 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, div.informaltable table { border-collapse:collapse; border:1px solid #c0c0c0; }
11 div.table-contents table td, div.informaltable td, div.table-contents table th, div.informaltable table th { padding:5px; text-align:left; }
12 div.table-contents table th, div.informaltable table th {
13     font-family:sans-serif;
14     background:#d0d0d0;
15     font-weight:normal;
16     vertical-align:top;
17 }
18 div.cmdsynopsis { border-left:1px solid #707070; padding-left:5px; }
19 li div.cmdsynopsis { border-left:none; padding-left:0px; }
20 pre.screen, div.note { background:#f0f0f0; border:1px solid #c0c0c0; padding:5px; margin-left:2%; margin-right:2%; }
21 div.example p.title { margin-left:2%; }
22 div.note h3 { font-size:small; font-style:italic; font-variant: small-caps; }
23 div.note h3:after { content: ":" }
24 div.note { margin-bottom: 5px; }
25 .command { font-family: monospace; font-weight: normal; }
26 .command strong { font-weight: normal; }
27 tr { vertical-align: top; }
28 .comment { color:#707070; }
29
30     </style></head><body><div class="book" title="The Mutt E-Mail Client"><div class="titlepage"><div><div><h1 class="title"><a id="id533198"></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">&lt;<a class="email" href="mailto:me@cs.hmc.edu">me@cs.hmc.edu</a>&gt;</code></div></div><div><p class="releaseinfo">version 1.5.21 (2010-09-15)</p></div><div><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>
31 <span class="quote">“<span class="quote">All mail clients suck.  This one just sucks less.</span>”</span> —
32 me, circa 1995
33 </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. Getting Mutt</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. Typographical 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="#concept-screens-and-menus">2. Screens and Menus</a></span></dt><dd><dl><dt><span class="sect2"><a href="#intro-index">2.1. Index</a></span></dt><dt><span class="sect2"><a href="#intro-pager">2.2. Pager</a></span></dt><dt><span class="sect2"><a href="#intro-browser">2.3. File Browser</a></span></dt><dt><span class="sect2"><a href="#intro-help">2.4. Help</a></span></dt><dt><span class="sect2"><a href="#intro-compose">2.5. Compose Menu</a></span></dt><dt><span class="sect2"><a href="#intro-alias">2.6. Alias Menu</a></span></dt><dt><span class="sect2"><a href="#intro-attach">2.7. Attachment Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#menus">3. Moving Around in Menus</a></span></dt><dt><span class="sect1"><a href="#editing">4. Editing Input Fields</a></span></dt><dd><dl><dt><span class="sect2"><a href="#editing-intro">4.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#editing-history">4.2. History</a></span></dt></dl></dd><dt><span class="sect1"><a href="#reading">5. Reading Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#index-menu">5.1. The Message Index</a></span></dt><dt><span class="sect2"><a href="#pager-menu">5.2. The Pager</a></span></dt><dt><span class="sect2"><a href="#threads">5.3. Threaded Mode</a></span></dt><dt><span class="sect2"><a href="#reading-misc">5.4. Miscellaneous Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sending">6. Sending Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#sending-intro">6.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#edit-header">6.2. Editing the Message Header</a></span></dt><dt><span class="sect2"><a href="#sending-crypto">6.3. Sending Cryptographically Signed/Encrypted Messages</a></span></dt><dt><span class="sect2"><a href="#ff">6.4. Sending Format=Flowed Messages</a></span></dt></dl></dd><dt><span class="sect1"><a href="#forwarding-mail">7. Forwarding and Bouncing Mail</a></span></dt><dt><span class="sect1"><a href="#postponing-mail">8. 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="#msg-hdr-display">10. Message Header Display</a></span></dt><dd><dl><dt><span class="sect2"><a href="#hdr-folding">10.1. Header Display</a></span></dt><dt><span class="sect2"><a href="#ignore">10.2. Selecting Headers</a></span></dt><dt><span class="sect2"><a href="#hdr-order">10.3. Ordering Displayed Headers</a></span></dt></dl></dd><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="#var-types">26.1. Variable Types</a></span></dt><dt><span class="sect2"><a href="#set-commands">26.2. Commands</a></span></dt><dt><span class="sect2"><a href="#set-myvar">26.3. User-Defined Variables</a></span></dt><dt><span class="sect2"><a href="#set-conversions">26.4. Type Conversions</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-conditionals">29.2. Conditionals</a></span></dt><dt><span class="sect2"><a href="#formatstrings-filters">29.3. Filters</a></span></dt><dt><span class="sect2"><a href="#formatstrings-padding">29.4. Padding</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="#charset-handling">1. Character Set Handling</a></span></dt><dt><span class="sect1"><a href="#regexp">2. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">3. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#patterns-modifier">3.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#simple-searches">3.2. Simple Searches</a></span></dt><dt><span class="sect2"><a href="#complex-patterns">3.3. Nesting and Boolean Operators</a></span></dt><dt><span class="sect2"><a href="#date-patterns">3.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">4. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">5. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">5.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">6. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">7. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">8. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">9. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#new-mail">10. New Mail Detection</a></span></dt><dd><dl><dt><span class="sect2"><a href="#new-mail-formats">10.1. How New Mail Detection Works</a></span></dt><dt><span class="sect2"><a href="#new-mail-polling">10.2. Polling For New Mail</a></span></dt></dl></dd><dt><span class="sect1"><a href="#editing-threads">11. Editing Threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#link-threads">11.1. Linking Threads</a></span></dt><dt><span class="sect2"><a href="#break-threads">11.2. Breaking Threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">12. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">13. Start a WWW Browser on URLs</a></span></dt><dt><span class="sect1"><a href="#misc-topics">14. Miscellany</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-overview">1.1. MIME Overview</a></span></dt><dt><span class="sect2"><a href="#mime-pager">1.2. Viewing MIME Messages in the Pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.3. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.4. 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 Mailcap</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 IMAP 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="#cache-dirs">7.3. Cache Directories</a></span></dt><dt><span class="sect2"><a href="#maint-cache">7.4. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact Address Generation</a></span></dt><dt><span class="sect1"><a href="#sending-mixmaster">9. Sending Anonymous Messages via Mixmaster</a></span></dt></dl></dd><dt><span class="chapter"><a href="#security">7. Security Considerations</a></span></dt><dd><dl><dt><span class="sect1"><a href="#security-passwords">1. Passwords</a></span></dt><dt><span class="sect1"><a href="#security-tempfiles">2. Temporary Files</a></span></dt><dt><span class="sect1"><a href="#security-leaks">3. Information Leaks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#security-leaks-mid">3.1. Message-Id: headers</a></span></dt><dt><span class="sect2"><a href="#security-leaks-mailto">3.2. <code class="literal">mailto:</code>-style Links</a></span></dt></dl></dd><dt><span class="sect1"><a href="#security-external">4. External Applications</a></span></dt></dl></dd><dt><span class="chapter"><a href="#tuning">8. 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">9. 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="#auto-tag">3.17. auto_tag</a></span></dt><dt><span class="sect2"><a href="#autoedit">3.18. autoedit</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="#certificate-file">3.24. certificate_file</a></span></dt><dt><span class="sect2"><a href="#charset">3.25. charset</a></span></dt><dt><span class="sect2"><a href="#check-mbox-size">3.26. check_mbox_size</a></span></dt><dt><span class="sect2"><a href="#check-new">3.27. check_new</a></span></dt><dt><span class="sect2"><a href="#collapse-unread">3.28. collapse_unread</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-autoencrypt">3.36. crypt_autoencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-autopgp">3.37. crypt_autopgp</a></span></dt><dt><span class="sect2"><a href="#crypt-autosign">3.38. crypt_autosign</a></span></dt><dt><span class="sect2"><a href="#crypt-autosmime">3.39. crypt_autosmime</a></span></dt><dt><span class="sect2"><a href="#crypt-replyencrypt">3.40. crypt_replyencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-replysign">3.41. crypt_replysign</a></span></dt><dt><span class="sect2"><a href="#crypt-replysignencrypted">3.42. crypt_replysignencrypted</a></span></dt><dt><span class="sect2"><a href="#crypt-timestamp">3.43. crypt_timestamp</a></span></dt><dt><span class="sect2"><a href="#crypt-use-gpgme">3.44. crypt_use_gpgme</a></span></dt><dt><span class="sect2"><a href="#crypt-use-pka">3.45. crypt_use_pka</a></span></dt><dt><span class="sect2"><a href="#crypt-verify-sig">3.46. crypt_verify_sig</a></span></dt><dt><span class="sect2"><a href="#date-format">3.47. date_format</a></span></dt><dt><span class="sect2"><a href="#default-hook">3.48. default_hook</a></span></dt><dt><span class="sect2"><a href="#delete">3.49. delete</a></span></dt><dt><span class="sect2"><a href="#delete-untag">3.50. delete_untag</a></span></dt><dt><span class="sect2"><a href="#digest-collapse">3.51. digest_collapse</a></span></dt><dt><span class="sect2"><a href="#display-filter">3.52. display_filter</a></span></dt><dt><span class="sect2"><a href="#dotlock-program">3.53. dotlock_program</a></span></dt><dt><span class="sect2"><a href="#dsn-notify">3.54. dsn_notify</a></span></dt><dt><span class="sect2"><a href="#dsn-return">3.55. dsn_return</a></span></dt><dt><span class="sect2"><a href="#duplicate-threads">3.56. duplicate_threads</a></span></dt><dt><span class="sect2"><a href="#edit-headers">3.57. edit_headers</a></span></dt><dt><span class="sect2"><a href="#editor">3.58. editor</a></span></dt><dt><span class="sect2"><a href="#encode-from">3.59. encode_from</a></span></dt><dt><span class="sect2"><a href="#entropy-file">3.60. entropy_file</a></span></dt><dt><span class="sect2"><a href="#envelope-from-address">3.61. envelope_from_address</a></span></dt><dt><span class="sect2"><a href="#escape">3.62. escape</a></span></dt><dt><span class="sect2"><a href="#fast-reply">3.63. fast_reply</a></span></dt><dt><span class="sect2"><a href="#fcc-attach">3.64. fcc_attach</a></span></dt><dt><span class="sect2"><a href="#fcc-clear">3.65. fcc_clear</a></span></dt><dt><span class="sect2"><a href="#folder">3.66. folder</a></span></dt><dt><span class="sect2"><a href="#folder-format">3.67. folder_format</a></span></dt><dt><span class="sect2"><a href="#followup-to">3.68. followup_to</a></span></dt><dt><span class="sect2"><a href="#force-name">3.69. force_name</a></span></dt><dt><span class="sect2"><a href="#forward-decode">3.70. forward_decode</a></span></dt><dt><span class="sect2"><a href="#forward-decrypt">3.71. forward_decrypt</a></span></dt><dt><span class="sect2"><a href="#forward-edit">3.72. forward_edit</a></span></dt><dt><span class="sect2"><a href="#forward-format">3.73. forward_format</a></span></dt><dt><span class="sect2"><a href="#forward-quote">3.74. forward_quote</a></span></dt><dt><span class="sect2"><a href="#from">3.75. from</a></span></dt><dt><span class="sect2"><a href="#gecos-mask">3.76. gecos_mask</a></span></dt><dt><span class="sect2"><a href="#hdrs">3.77. hdrs</a></span></dt><dt><span class="sect2"><a href="#header">3.78. header</a></span></dt><dt><span class="sect2"><a href="#header-cache">3.79. header_cache</a></span></dt><dt><span class="sect2"><a href="#header-cache-compress">3.80. header_cache_compress</a></span></dt><dt><span class="sect2"><a href="#header-cache-pagesize">3.81. header_cache_pagesize</a></span></dt><dt><span class="sect2"><a href="#help">3.82. help</a></span></dt><dt><span class="sect2"><a href="#hidden-host">3.83. hidden_host</a></span></dt><dt><span class="sect2"><a href="#hide-limited">3.84. hide_limited</a></span></dt><dt><span class="sect2"><a href="#hide-missing">3.85. hide_missing</a></span></dt><dt><span class="sect2"><a href="#hide-thread-subject">3.86. hide_thread_subject</a></span></dt><dt><span class="sect2"><a href="#hide-top-limited">3.87. hide_top_limited</a></span></dt><dt><span class="sect2"><a href="#hide-top-missing">3.88. hide_top_missing</a></span></dt><dt><span class="sect2"><a href="#history">3.89. history</a></span></dt><dt><span class="sect2"><a href="#history-file">3.90. history_file</a></span></dt><dt><span class="sect2"><a href="#honor-disposition">3.91. honor_disposition</a></span></dt><dt><span class="sect2"><a href="#honor-followup-to">3.92. honor_followup_to</a></span></dt><dt><span class="sect2"><a href="#hostname">3.93. hostname</a></span></dt><dt><span class="sect2"><a href="#ignore-linear-white-space">3.94. ignore_linear_white_space</a></span></dt><dt><span class="sect2"><a href="#ignore-list-reply-to">3.95. ignore_list_reply_to</a></span></dt><dt><span class="sect2"><a href="#imap-authenticators">3.96. imap_authenticators</a></span></dt><dt><span class="sect2"><a href="#imap-check-subscribed">3.97. imap_check_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-delim-chars">3.98. imap_delim_chars</a></span></dt><dt><span class="sect2"><a href="#imap-headers">3.99. imap_headers</a></span></dt><dt><span class="sect2"><a href="#imap-idle">3.100. imap_idle</a></span></dt><dt><span class="sect2"><a href="#imap-keepalive">3.101. imap_keepalive</a></span></dt><dt><span class="sect2"><a href="#imap-list-subscribed">3.102. imap_list_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-login">3.103. imap_login</a></span></dt><dt><span class="sect2"><a href="#imap-pass">3.104. imap_pass</a></span></dt><dt><span class="sect2"><a href="#imap-passive">3.105. imap_passive</a></span></dt><dt><span class="sect2"><a href="#imap-peek">3.106. imap_peek</a></span></dt><dt><span class="sect2"><a href="#imap-pipeline-depth">3.107. imap_pipeline_depth</a></span></dt><dt><span class="sect2"><a href="#imap-servernoise">3.108. imap_servernoise</a></span></dt><dt><span class="sect2"><a href="#imap-user">3.109. imap_user</a></span></dt><dt><span class="sect2"><a href="#implicit-autoview">3.110. implicit_autoview</a></span></dt><dt><span class="sect2"><a href="#include">3.111. include</a></span></dt><dt><span class="sect2"><a href="#include-onlyfirst">3.112. include_onlyfirst</a></span></dt><dt><span class="sect2"><a href="#indent-string">3.113. indent_string</a></span></dt><dt><span class="sect2"><a href="#index-format">3.114. index_format</a></span></dt><dt><span class="sect2"><a href="#ispell">3.115. ispell</a></span></dt><dt><span class="sect2"><a href="#keep-flagged">3.116. keep_flagged</a></span></dt><dt><span class="sect2"><a href="#locale">3.117. locale</a></span></dt><dt><span class="sect2"><a href="#mail-check">3.118. mail_check</a></span></dt><dt><span class="sect2"><a href="#mail-check-recent">3.119. mail_check_recent</a></span></dt><dt><span class="sect2"><a href="#mailcap-path">3.120. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.121. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.122. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.123. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.124. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.125. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.126. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.127. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.128. mbox_type</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.129. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.130. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.131. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.132. message_cache_clean</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-format">3.134. message_format</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.135. meta_key</a></span></dt><dt><span class="sect2"><a href="#metoo">3.136. metoo</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.137. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.138. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.139. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.140. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.141. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.142. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.143. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.144. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.145. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.146. move</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.147. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.148. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.149. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.150. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.151. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.152. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.153. pager_stop</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.154. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.155. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.156. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.157. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.158. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.159. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.160. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.161. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.162. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.163. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.164. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.165. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.166. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.167. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.168. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.169. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.170. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.171. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.172. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.173. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.174. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.175. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.176. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.177. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.178. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.179. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.180. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.181. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.182. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.183. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.184. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.185. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.186. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.187. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.188. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.189. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.190. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.191. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.192. pop_pass</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.193. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.194. pop_user</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.195. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.196. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.197. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.198. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.199. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.200. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.201. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.202. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.203. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.204. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.205. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.206. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.207. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.208. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.209. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.210. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.211. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.212. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.213. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.214. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.215. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.216. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.217. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.218. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.219. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.220. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.221. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.222. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.223. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.224. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.225. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.226. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.227. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.228. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#search-context">3.229. search_context</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.230. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.231. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.232. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.233. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.234. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.235. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.236. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.237. simple_search</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.238. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.239. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.240. smileys</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.241. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.242. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.243. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.244. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.245. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.246. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.247. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.248. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.249. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.250. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.251. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.252. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.253. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.254. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.255. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.256. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.257. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.258. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.259. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.260. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.261. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.262. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.263. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.264. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.265. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.266. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.267. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.268. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.269. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.270. spoolfile</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.271. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.272. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.273. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.274. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.275. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.276. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.277. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.278. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.279. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-dates">3.280. ssl_verify_dates</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-host">3.281. ssl_verify_host</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.282. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.283. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.284. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.285. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.286. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.287. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.288. thorough_search</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.289. thread_received</a></span></dt><dt><span class="sect2"><a href="#tilde">3.290. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.291. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.292. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.293. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.294. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.295. tunnel</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.296. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.297. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.298. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.299. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.300. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.301. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.302. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.303. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.304. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.305. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.306. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.307. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-headers">3.308. wrap_headers</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.309. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.310. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.311. write_bcc</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.312. write_inc</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="#attachment-map">4.6. Attachment 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="#mixmaster-map">4.12. Mixmaster 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">10. 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-line">Most common navigation keys in entry-based menus</a></dt><dt>2.2. <a href="#tab-keys-nav-page">Most common navigation keys in page-based menus</a></dt><dt>2.3. <a href="#tab-keys-editor">Most common line editor keys</a></dt><dt>2.4. <a href="#tab-key-index">Most common message index keys</a></dt><dt>2.5. <a href="#tab-msg-status-flags">Message status flags</a></dt><dt>2.6. <a href="#tab-msg-recip-flags">Message recipient flags</a></dt><dt>2.7. <a href="#tab-key-pager">Most common pager keys</a></dt><dt>2.8. <a href="#tab-ansi-esc">ANSI escape sequences</a></dt><dt>2.9. <a href="#tab-color">Color sequences</a></dt><dt>2.10. <a href="#tab-key-threads">Most common thread mode keys</a></dt><dt>2.11. <a href="#tab-key-send">Most common mail sending keys</a></dt><dt>2.12. <a href="#tab-func-compose">Most common compose menu keys</a></dt><dt>2.13. <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>4.7. <a href="#tab-mailbox-shortcuts">Mailbox shortcuts</a></dt><dt>5.1. <a href="#supported-mime-types">Supported MIME types</a></dt><dt>9.1. <a href="#tab-commandline-options">Command line options</a></dt><dt>9.2. <a href="#tab-generic-bindings">Default Generic Menu Bindings</a></dt><dt>9.3. <a href="#tab-index-bindings">Default Index Menu Bindings</a></dt><dt>9.4. <a href="#tab-pager-bindings">Default Pager Menu Bindings</a></dt><dt>9.5. <a href="#tab-alias-bindings">Default Alias Menu Bindings</a></dt><dt>9.6. <a href="#tab-query-bindings">Default Query Menu Bindings</a></dt><dt>9.7. <a href="#tab-attachment-bindings">Default Attachment Menu Bindings</a></dt><dt>9.8. <a href="#tab-compose-bindings">Default Compose Menu Bindings</a></dt><dt>9.9. <a href="#tab-postpone-bindings">Default Postpone Menu Bindings</a></dt><dt>9.10. <a href="#tab-browser-bindings">Default Browser Menu Bindings</a></dt><dt>9.11. <a href="#tab-pgp-bindings">Default Pgp Menu Bindings</a></dt><dt>9.12. <a href="#tab-smime-bindings">Default Smime Menu Bindings</a></dt><dt>9.13. <a href="#tab-mixmaster-bindings">Default Mixmaster Menu Bindings</a></dt><dt>9.14. <a href="#tab-editor-bindings">Default Editor Menu 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 configuration files</a></dt><dt>3.4. <a href="#ex-rc-split">Splitting long configuration commands over several lines</a></dt><dt>3.5. <a href="#ex-rc-backtick">Using external command's output in configuration files</a></dt><dt>3.6. <a href="#ex-rc-env">Using environment variables in configuration files</a></dt><dt>3.7. <a href="#ex-alias-external">Configuring external alias files</a></dt><dt>3.8. <a href="#ex-folder-sorting">Setting sort method based on mailbox name</a></dt><dt>3.9. <a href="#ex-header-weeding">Header weeding</a></dt><dt>3.10. <a href="#ex-hdr-order">Configuring header display order</a></dt><dt>3.11. <a href="#ex-my-hdr">Defining custom headers</a></dt><dt>3.12. <a href="#ex-save-hook-exando">Using %-expandos in <span class="command">save-hook</span></a></dt><dt>3.13. <a href="#ex-folder-hook-push">Embedding <span class="command">push</span> in <span class="command">folder-hook</span></a></dt><dt>3.14. <a href="#ex-spam">Configuring spam detection</a></dt><dt>3.15. <a href="#ex-myvar1">Using user-defined variables for config file readability</a></dt><dt>3.16. <a href="#ex-myvar2">Using user-defined variables for backing up other config option values</a></dt><dt>3.17. <a href="#ex-myvar3">Deferring user-defined variable expansion to runtime</a></dt><dt>3.18. <a href="#ex-myvar4">Type conversions using variables</a></dt><dt>3.19. <a href="#ex-fmtpipe">Using external filters in format strings</a></dt><dt>4.1. <a href="#ex-recips">Matching all addresses in address lists</a></dt><dt>4.2. <a href="#ex-pattern-bool">Using boolean operators in patterns</a></dt><dt>4.3. <a href="#ex-default-hook">Specifying a <span class="quote">“<span class="quote">default</span>”</span> hook</a></dt><dt>5.1. <a href="#ex-mime-types"><code class="literal">mime.types</code></a></dt><dt>5.2. <a href="#ex-attach-count">Attachment counting</a></dt><dt>6.1. <a href="#ex-url">URLs</a></dt><dt>6.2. <a href="#ex-multiaccount">Managing multiple accounts</a></dt></dl></div><div class="chapter" title="Chapter 1. Introduction"><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. Getting Mutt</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. Typographical Conventions</a></span></dt><dt><span class="sect1"><a href="#copyright">7. Copyright</a></span></dt></dl></div><p>
34 <span class="bold"><strong>Mutt</strong></span> is a small but very powerful
35 text-based MIME mail client.  Mutt is highly configurable, and is well
36 suited to the mail power user with advanced features like key bindings,
37 keyboard macros, mail threading, regular expression searches and a
38 powerful pattern matching language for selecting groups of messages.
39 </p><div class="sect1" title="1. Mutt Home Page"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="homepage"></a>1. Mutt Home Page</h2></div></div></div><p>
40 The official homepage can be found at
41 <a class="ulink" href="http://www.mutt.org/" target="_top">http://www.mutt.org/</a>.
42 </p></div><div class="sect1" title="2. Mailing Lists"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttlists"></a>2. Mailing Lists</h2></div></div></div><p>
43 To subscribe to one of the following mailing lists, send a message with
44 the word <span class="emphasis"><em>subscribe</em></span> in the body to
45 <span class="emphasis"><em>list-name</em></span><code class="literal">-request@mutt.org</code>.
46 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
47 <code class="email">&lt;<a class="email" href="mailto:mutt-announce-request@mutt.org">mutt-announce-request@mutt.org</a>&gt;</code> — low traffic list for
48 announcements
49 </p></li><li class="listitem"><p>
50 <code class="email">&lt;<a class="email" href="mailto:mutt-users-request@mutt.org">mutt-users-request@mutt.org</a>&gt;</code> — help, bug reports and
51 feature requests
52 </p></li><li class="listitem"><p>
53 <code class="email">&lt;<a class="email" href="mailto:mutt-dev-request@mutt.org">mutt-dev-request@mutt.org</a>&gt;</code> — development mailing list
54 </p></li></ul></div><p>
55 All messages posted to <span class="emphasis"><em>mutt-announce</em></span> are
56 automatically forwarded to <span class="emphasis"><em>mutt-users</em></span>, so you do
57 not need to be subscribed to both lists.
58 </p></div><div class="sect1" title="3. Getting Mutt"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="distribution"></a>3. Getting Mutt</h2></div></div></div><p>
59 Mutt releases can be downloaded from <a class="ulink" href="ftp://ftp.mutt.org/mutt/" target="_top">ftp://ftp.mutt.org/mutt/</a>.  For a
60 list of mirror sites, please refer to <a class="ulink" href="http://www.mutt.org/download.html" target="_top">http://www.mutt.org/download.html</a>.
61 </p><p>
62 For nightly tarballs and version control access, please refer to the
63 <a class="ulink" href="http://dev.mutt.org/" target="_top">Mutt development site</a>.
64 </p></div><div class="sect1" title="4. Mutt Online Resources"><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>
65 The official Mutt bug tracking system can be found at
66 <a class="ulink" href="http://bugs.mutt.org/" target="_top">http://bugs.mutt.org/</a>
67 </p></dd><dt><span class="term">Wiki</span></dt><dd><p>
68 An (unofficial) wiki can be found
69 at <a class="ulink" href="http://wiki.mutt.org/" target="_top">http://wiki.mutt.org/</a>.
70 </p></dd><dt><span class="term">IRC</span></dt><dd><p>
71 For the IRC user community, visit channel <span class="emphasis"><em>#mutt</em></span> on
72 <a class="ulink" href="http://www.freenode.net/" target="_top">irc.freenode.net</a>.
73 </p></dd><dt><span class="term">USENET</span></dt><dd><p>
74 For USENET, see the newsgroup <a class="ulink" href="news:comp.mail.mutt" target="_top">comp.mail.mutt</a>.
75 </p></dd></dl></div></div><div class="sect1" title="5. Contributing to Mutt"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="contrib"></a>5. Contributing to Mutt</h2></div></div></div><p>
76 There are various ways to contribute to the Mutt project.
77 </p><p>
78 Especially for new users it may be helpful to meet other new and
79 experienced users to chat about Mutt, talk about problems and share
80 tricks.
81 </p><p>
82 Since translations of Mutt into other languages are highly appreciated,
83 the Mutt developers always look for skilled translators that help
84 improve and continue to maintain stale translations.
85 </p><p>
86 For contributing code patches for new features and bug fixes, please
87 refer to the developer pages at
88 <a class="ulink" href="http://dev.mutt.org/" target="_top">http://dev.mutt.org/</a> for more details.
89 </p></div><div class="sect1" title="6. Typographical Conventions"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="typo"></a>6. Typographical Conventions</h2></div></div></div><p>
90 This section lists typographical conventions followed throughout this
91 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
92 conventions for special terms.
93 </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">&lt;PageUp&gt;</code></td><td>named keys</td></tr><tr><td><code class="literal">&lt;create-alias&gt;</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>$mail_check</td><td>Mutt configuration option</td></tr><tr><td><code class="literal">$HOME</code></td><td>environment variable</td></tr></tbody></table></div></div><br class="table-break" /><p>
94 Examples are presented as:
95 </p><pre class="screen">
96 mutt -v
97 </pre><p>
98 Within command synopsis, curly brackets (<span class="quote">“<span class="quote">{}</span>”</span>) denote a set
99 of options of which one is mandatory, square brackets
100 (<span class="quote">“<span class="quote">[]</span>”</span>) denote optional arguments, three dots
101 denote that the argument may be repeated arbitrary times.
102 </p></div><div class="sect1" title="7. Copyright"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="copyright"></a>7. Copyright</h2></div></div></div><p>
103 Mutt is Copyright © 1996-2009 Michael R. Elkins
104 <code class="email">&lt;<a class="email" href="mailto:me@mutt.org">me@mutt.org</a>&gt;</code> and others.
105 </p><p>
106 This program is free software; you can redistribute it and/or modify it
107 under the terms of the GNU General Public License as published by the
108 Free Software Foundation; either version 2 of the License, or (at your
109 option) any later version.
110 </p><p>
111 This program is distributed in the hope that it will be useful, but
112 WITHOUT ANY WARRANTY; without even the implied warranty of
113 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
114 General Public License for more details.
115 </p><p>
116 You should have received a copy of the GNU General Public License along
117 with this program; if not, write to the Free Software Foundation, Inc.,
118 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
119 </p></div></div><div class="chapter" title="Chapter 2. Getting Started"><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="#concept-screens-and-menus">2. Screens and Menus</a></span></dt><dd><dl><dt><span class="sect2"><a href="#intro-index">2.1. Index</a></span></dt><dt><span class="sect2"><a href="#intro-pager">2.2. Pager</a></span></dt><dt><span class="sect2"><a href="#intro-browser">2.3. File Browser</a></span></dt><dt><span class="sect2"><a href="#intro-help">2.4. Help</a></span></dt><dt><span class="sect2"><a href="#intro-compose">2.5. Compose Menu</a></span></dt><dt><span class="sect2"><a href="#intro-alias">2.6. Alias Menu</a></span></dt><dt><span class="sect2"><a href="#intro-attach">2.7. Attachment Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#menus">3. Moving Around in Menus</a></span></dt><dt><span class="sect1"><a href="#editing">4. Editing Input Fields</a></span></dt><dd><dl><dt><span class="sect2"><a href="#editing-intro">4.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#editing-history">4.2. History</a></span></dt></dl></dd><dt><span class="sect1"><a href="#reading">5. Reading Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#index-menu">5.1. The Message Index</a></span></dt><dt><span class="sect2"><a href="#pager-menu">5.2. The Pager</a></span></dt><dt><span class="sect2"><a href="#threads">5.3. Threaded Mode</a></span></dt><dt><span class="sect2"><a href="#reading-misc">5.4. Miscellaneous Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sending">6. Sending Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#sending-intro">6.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#edit-header">6.2. Editing the Message Header</a></span></dt><dt><span class="sect2"><a href="#sending-crypto">6.3. Sending Cryptographically Signed/Encrypted Messages</a></span></dt><dt><span class="sect2"><a href="#ff">6.4. Sending Format=Flowed Messages</a></span></dt></dl></dd><dt><span class="sect1"><a href="#forwarding-mail">7. Forwarding and Bouncing Mail</a></span></dt><dt><span class="sect1"><a href="#postponing-mail">8. Postponing Mail</a></span></dt></dl></div><p>
120 This section is intended as a brief overview of how to use Mutt.  There
121 are many other features which are described elsewhere in the manual.
122 There is even more information available in the Mutt FAQ and various web
123 pages. See the <a class="ulink" href="http://www.mutt.org/" target="_top">Mutt homepage</a>
124 for more details.
125 </p><p>
126 The keybindings described in this section are the defaults as
127 distributed.  Your local system administrator may have altered the
128 defaults for your site.  You can always type <span class="quote">“<span class="quote">?</span>”</span> in any
129 menu to display the current bindings.
130 </p><p>
131 The first thing you need to do is invoke Mutt, simply by typing
132 <code class="literal">mutt</code> at the command line.  There are various
133 command-line options, see either the Mutt man page or the <a class="link" href="#commandline" title="1. Command-Line Options">reference</a>.
134 </p><div class="sect1" title="1. Core Concepts"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="core-concepts"></a>1. Core Concepts</h2></div></div></div><p>
135 Mutt is a text-based application which interacts with users through
136 different menus which are mostly line-/entry-based or page-based. A
137 line-based menu is the so-called <span class="quote">“<span class="quote">index</span>”</span> menu (listing all
138 messages of the currently opened folder) or the <span class="quote">“<span class="quote">alias</span>”</span>
139 menu (allowing you to select recipients from a list). Examples for
140 page-based menus are the <span class="quote">“<span class="quote">pager</span>”</span> (showing one message at a
141 time) or the <span class="quote">“<span class="quote">help</span>”</span> menu listing all available key
142 bindings.
143 </p><p>
144 The user interface consists of a context sensitive help line at the top,
145 the menu's contents followed by a context sensitive status line and
146 finally the command line. The command line is used to display
147 informational and error messages as well as for prompts and for entering
148 interactive commands.
149 </p><p>
150 Mutt is configured through variables which, if the user wants to
151 permanently use a non-default value, are written to configuration
152 files. Mutt supports a rich config file syntax to make even complex
153 configuration files readable and commentable.
154 </p><p>
155 Because Mutt allows for customizing almost all key bindings, there are
156 so-called <span class="quote">“<span class="quote">functions</span>”</span> which can be executed manually (using
157 the command line) or in macros. Macros allow the user to bind a sequence
158 of commands to a single key or a short key sequence instead of repeating
159 a sequence of actions over and over.
160 </p><p>
161 Many commands (such as saving or copying a message to another folder)
162 can be applied to a single message or a set of messages (so-called
163 <span class="quote">“<span class="quote">tagged</span>”</span> messages). To help selecting messages, Mutt
164 provides a rich set of message patterns (such as recipients, sender,
165 body contents, date sent/received, etc.) which can be combined into
166 complex expressions using the boolean <span class="emphasis"><em>and</em></span> and
167 <span class="emphasis"><em>or</em></span> operations as well as negating. These patterns
168 can also be used to (for example) search for messages or to limit the
169 index to show only matching messages.
170 </p><p>
171 Mutt supports a <span class="quote">“<span class="quote">hook</span>”</span> concept which allows the user to
172 execute arbitrary configuration commands and functions in certain
173 situations such as entering a folder, starting a new message or replying
174 to an existing one. These hooks can be used to highly customize Mutt's
175 behavior including managing multiple identities, customizing the
176 display for a folder or even implementing auto-archiving based on a
177 per-folder basis and much more.
178 </p><p>
179 Besides an interactive mode, Mutt can also be used as a command-line
180 tool only send messages. It also supports a
181 <code class="literal">mailx(1)</code>-compatible interface, see <a class="xref" href="#tab-commandline-options" title="Table 9.1. Command line options">Table 9.1, “Command line options”</a> for a complete list of command-line
182 options.
183 </p></div><div class="sect1" title="2. Screens and Menus"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="concept-screens-and-menus"></a>2. Screens and Menus</h2></div></div></div><div class="sect2" title="2.1. Index"><div class="titlepage"><div><div><h3 class="title"><a id="intro-index"></a>2.1. Index</h3></div></div></div><p>
184 The index is the screen that you usually see first when you start
185 Mutt. It gives an overview over your emails in the currently opened
186 mailbox. By default, this is your system mailbox.  The information you
187 see in the index is a list of emails, each with its number on the left,
188 its flags (new email, important email, email that has been forwarded or
189 replied to, tagged email, ...), the date when email was sent, its
190 sender, the email size, and the subject. Additionally, the index also
191 shows thread hierarchies: when you reply to an email, and the other
192 person replies back, you can see the other person's email in a
193 "sub-tree" below.  This is especially useful for personal email between
194 a group of people or when you've subscribed to mailing lists.
195 </p></div><div class="sect2" title="2.2. Pager"><div class="titlepage"><div><div><h3 class="title"><a id="intro-pager"></a>2.2. Pager</h3></div></div></div><p>
196 The pager is responsible for showing the email content. On the top of
197 the pager you have an overview over the most important email headers
198 like the sender, the recipient, the subject, and much more
199 information. How much information you actually see depends on your
200 configuration, which we'll describe below.
201 </p><p>
202 Below the headers, you see the email body which usually contains the
203 message. If the email contains any attachments, you will see more
204 information about them below the email body, or, if the attachments are
205 text files, you can view them directly in the pager.
206 </p><p>
207 To give the user a good overview, it is possible to configure Mutt to
208 show different things in the pager with different colors. Virtually
209 everything that can be described with a regular expression can be
210 colored, e.g. URLs, email addresses or smileys.
211 </p></div><div class="sect2" title="2.3. File Browser"><div class="titlepage"><div><div><h3 class="title"><a id="intro-browser"></a>2.3. File Browser</h3></div></div></div><p>
212 The file browser is the interface to the local or remote file
213 system. When selecting a mailbox to open, the browser allows custom
214 sorting of items, limiting the items shown by a regular expression and a
215 freely adjustable format of what to display in which way. It also allows
216 for easy navigation through the file system when selecting file(s) to
217 attach to a message, select multiple files to attach and many more.
218 </p></div><div class="sect2" title="2.4. Help"><div class="titlepage"><div><div><h3 class="title"><a id="intro-help"></a>2.4. Help</h3></div></div></div><p>
219 The help screen is meant to offer a quick help to the user. It lists the
220 current configuration of key bindings and their associated commands
221 including a short description, and currently unbound functions that
222 still need to be associated with a key binding (or alternatively, they
223 can be called via the Mutt command prompt).
224 </p></div><div class="sect2" title="2.5. Compose Menu"><div class="titlepage"><div><div><h3 class="title"><a id="intro-compose"></a>2.5. Compose Menu</h3></div></div></div><p>
225 The compose menu features a split screen containing the information
226 which really matter before actually sending a message by mail: who gets
227 the message as what (recipients and who gets what kind of
228 copy). Additionally, users may set security options like deciding
229 whether to sign, encrypt or sign and encrypt a message with/for what
230 keys. Also, it's used to attach messages, to re-edit any attachment
231 including the message itself.
232 </p></div><div class="sect2" title="2.6. Alias Menu"><div class="titlepage"><div><div><h3 class="title"><a id="intro-alias"></a>2.6. Alias Menu</h3></div></div></div><p>
233 The alias menu is used to help users finding the recipients of
234 messages. For users who need to contact many people, there's no need to
235 remember addresses or names completely because it allows for searching,
236 too. The alias mechanism and thus the alias menu also features grouping
237 several addresses by a shorter nickname, the actual alias, so that users
238 don't have to select each single recipient manually.
239 </p></div><div class="sect2" title="2.7. Attachment Menu"><div class="titlepage"><div><div><h3 class="title"><a id="intro-attach"></a>2.7. Attachment Menu</h3></div></div></div><p>
240 As will be later discussed in detail, Mutt features a good and stable
241 MIME implementation, that is, it supports sending and receiving messages
242 of arbitrary MIME types. The attachment menu displays a message's
243 structure in detail: what content parts are attached to which parent
244 part (which gives a true tree structure), which type is of what type and
245 what size.  Single parts may saved, deleted or modified to offer great
246 and easy access to message's internals.
247 </p></div></div><div class="sect1" title="3. Moving Around in Menus"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="menus"></a>3. Moving Around in Menus</h2></div></div></div><p>
248 The most important navigation keys common to line- or entry-based menus
249 are shown in <a class="xref" href="#tab-keys-nav-line" title="Table 2.1. Most common navigation keys in entry-based menus">Table 2.1, “Most common navigation keys in entry-based menus”</a> and in <a class="xref" href="#tab-keys-nav-page" title="Table 2.2. Most common navigation keys in page-based menus">Table 2.2, “Most common navigation keys in page-based menus”</a> for page-based menus.
250 </p><div class="table"><a id="tab-keys-nav-line"></a><p class="title"><b>Table 2.1. Most common navigation keys in entry-based menus</b></p><div class="table-contents"><table summary="Most common navigation keys in entry-based menus" 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 &lt;Down&gt;</td><td><code class="literal">&lt;next-entry&gt;</code></td><td>move to the next entry</td></tr><tr><td>k or &lt;Up&gt;</td><td><code class="literal">&lt;previous-entry&gt;</code></td><td>move to the previous entry</td></tr><tr><td>z or &lt;PageDn&gt;</td><td><code class="literal">&lt;page-down&gt;</code></td><td>go to the next page</td></tr><tr><td>Z or &lt;PageUp&gt;</td><td><code class="literal">&lt;page-up&gt;</code></td><td>go to the previous page</td></tr><tr><td>= or &lt;Home&gt;</td><td><code class="literal">&lt;first-entry&gt;</code></td><td>jump to the first entry</td></tr><tr><td>* or &lt;End&gt;</td><td><code class="literal">&lt;last-entry&gt;</code></td><td>jump to the last entry</td></tr><tr><td>q</td><td><code class="literal">&lt;quit&gt;</code></td><td>exit the current menu</td></tr><tr><td>?</td><td><code class="literal">&lt;help&gt;</code></td><td>list all keybindings for the current menu</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="tab-keys-nav-page"></a><p class="title"><b>Table 2.2. Most common navigation keys in page-based menus</b></p><div class="table-contents"><table summary="Most common navigation keys in page-based menus" 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 &lt;Return&gt;</td><td><code class="literal">&lt;next-line&gt;</code></td><td>scroll down one line</td></tr><tr><td>&lt;Backspace&gt;</td><td><code class="literal">&lt;previous-line&gt;</code></td><td>scroll up one line</td></tr><tr><td>K, &lt;Space&gt; or &lt;PageDn&gt;</td><td><code class="literal">&lt;next-page&gt;</code></td><td>move to the next page</td></tr><tr><td>- or &lt;PageUp&gt;</td><td><code class="literal">&lt;previous-page&gt;</code></td><td>move the previous page</td></tr><tr><td>&lt;Home&gt;</td><td><code class="literal">&lt;top&gt;</code></td><td>move to the top</td></tr><tr><td>&lt;End&gt;</td><td><code class="literal">&lt;bottom&gt;</code></td><td>move to the bottom</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect1" title="4. Editing Input Fields"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing"></a>4. Editing Input Fields</h2></div></div></div><div class="sect2" title="4.1. Introduction"><div class="titlepage"><div><div><h3 class="title"><a id="editing-intro"></a>4.1. Introduction</h3></div></div></div><p>
251 Mutt has a built-in line editor for inputting text, e.g. email addresses
252 or filenames. The keys used to manipulate text input are very similar to
253 those of Emacs. See <a class="xref" href="#tab-keys-editor" title="Table 2.3. Most common line editor keys">Table 2.3, “Most common line editor keys”</a> for a full
254 reference of available functions, their default key bindings, and short
255 descriptions.
256 </p><div class="table"><a id="tab-keys-editor"></a><p class="title"><b>Table 2.3. 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 &lt;Home&gt;</td><td><code class="literal">&lt;bol&gt;</code></td><td>move to the start of the line</td></tr><tr><td>^B or &lt;Left&gt;</td><td><code class="literal">&lt;backward-char&gt;</code></td><td>move back one char</td></tr><tr><td>Esc B</td><td><code class="literal">&lt;backward-word&gt;</code></td><td>move back one word</td></tr><tr><td>^D or &lt;Delete&gt;</td><td><code class="literal">&lt;delete-char&gt;</code></td><td>delete the char under the cursor</td></tr><tr><td>^E or &lt;End&gt;</td><td><code class="literal">&lt;eol&gt;</code></td><td>move to the end of the line</td></tr><tr><td>^F or &lt;Right&gt;</td><td><code class="literal">&lt;forward-char&gt;</code></td><td>move forward one char</td></tr><tr><td>Esc F</td><td><code class="literal">&lt;forward-word&gt;</code></td><td>move forward one word</td></tr><tr><td>&lt;Tab&gt;</td><td><code class="literal">&lt;complete&gt;</code></td><td>complete filename or alias</td></tr><tr><td>^T</td><td><code class="literal">&lt;complete-query&gt;</code></td><td>complete address with query</td></tr><tr><td>^K</td><td><code class="literal">&lt;kill-eol&gt;</code></td><td>delete to the end of the line</td></tr><tr><td>Esc d</td><td><code class="literal">&lt;kill-eow&gt;</code></td><td>delete to the end of the word</td></tr><tr><td>^W</td><td><code class="literal">&lt;kill-word&gt;</code></td><td>kill the word in front of the cursor</td></tr><tr><td>^U</td><td><code class="literal">&lt;kill-line&gt;</code></td><td>delete entire line</td></tr><tr><td>^V</td><td><code class="literal">&lt;quote-char&gt;</code></td><td>quote the next typed key</td></tr><tr><td>&lt;Up&gt;</td><td><code class="literal">&lt;history-up&gt;</code></td><td>recall previous string from history</td></tr><tr><td>&lt;Down&gt;</td><td><code class="literal">&lt;history-down&gt;</code></td><td>recall next string from history</td></tr><tr><td>&lt;BackSpace&gt;</td><td><code class="literal">&lt;backspace&gt;</code></td><td>kill the char in front of the cursor</td></tr><tr><td>Esc u</td><td><code class="literal">&lt;upcase-word&gt;</code></td><td>convert word to upper case</td></tr><tr><td>Esc l</td><td><code class="literal">&lt;downcase-word&gt;</code></td><td>convert word to lower case</td></tr><tr><td>Esc c</td><td><code class="literal">&lt;capitalize-word&gt;</code></td><td>capitalize the word</td></tr><tr><td>^G</td><td>n/a</td><td>abort</td></tr><tr><td>&lt;Return&gt;</td><td>n/a</td><td>finish editing</td></tr></tbody></table></div></div><br class="table-break" /><p>
257 You can remap the <span class="emphasis"><em>editor</em></span> functions using the <a class="link" href="#bind" title="5. Changing the Default Key Bindings"><span class="command"><strong>bind</strong></span></a> command.  For example, to
258 make the &lt;Delete&gt; key delete the character in front of the cursor
259 rather than under, you could use:
260 </p><pre class="screen">
261 bind editor &lt;delete&gt; backspace
262 </pre></div><div class="sect2" title="4.2. History"><div class="titlepage"><div><div><h3 class="title"><a id="editing-history"></a>4.2. History</h3></div></div></div><p>
263 Mutt maintains a history for the built-in editor.  The number of items
264 is controlled by the <a class="link" href="#history" title="3.89. history">$history</a> variable
265 and can be made persistent using an external file specified using <a class="link" href="#history-file" title="3.90. history_file">$history_file</a>.  You may cycle through them
266 at an editor prompt by using the <code class="literal">&lt;history-up&gt;</code>
267 and/or <code class="literal">&lt;history-down&gt;</code> commands. But notice that
268 Mutt does not remember the currently entered text, it only cycles
269 through history and wraps around at the end or beginning.
270 </p><p>
271 Mutt maintains several distinct history lists, one for each of the
272 following categories:
273 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><code class="literal">.muttrc</code> commands</p></li><li class="listitem"><p>addresses and aliases</p></li><li class="listitem"><p>shell commands</p></li><li class="listitem"><p>filenames</p></li><li class="listitem"><p>patterns</p></li><li class="listitem"><p>everything else</p></li></ul></div><p>
274 Mutt automatically filters out consecutively repeated items from the
275 history. It also mimics the behavior of some shells by ignoring items
276 starting with a space. The latter feature can be useful in macros to not
277 clobber the history's valuable entries with unwanted entries.
278 </p></div></div><div class="sect1" title="5. Reading Mail"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="reading"></a>5. Reading Mail</h2></div></div></div><p>
279 Similar to many other mail clients, there are two modes in which mail is
280 read in Mutt.  The first is a list of messages in the mailbox, which is
281 called the <span class="quote">“<span class="quote">index</span>”</span> menu in Mutt.  The second mode is the
282 display of the message contents.  This is called the
283 <span class="quote">“<span class="quote">pager.</span>”</span>
284 </p><p>
285 The next few sections describe the functions provided in each of these
286 modes.
287 </p><div class="sect2" title="5.1. The Message Index"><div class="titlepage"><div><div><h3 class="title"><a id="index-menu"></a>5.1. The Message Index</h3></div></div></div><p>
288 Common keys used to navigate through and manage messages in the index
289 are shown in <a class="xref" href="#tab-key-index" title="Table 2.4. Most common message index keys">Table 2.4, “Most common message index keys”</a>. How messages are presented
290 in the index menu can be customized using the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable.
291 </p><div class="table"><a id="tab-key-index"></a><p class="title"><b>Table 2.4. 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>&lt;Return&gt;</td><td>display-message</td></tr><tr><td>&lt;Tab&gt;</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>
292 In addition to who sent the message and the subject, a short summary of
293 the disposition of each message is printed beside the message number.
294 Zero or more of the <span class="quote">“<span class="quote">flags</span>”</span> in <a class="xref" href="#tab-msg-status-flags" title="Table 2.5. Message status flags">Table 2.5, “Message status flags”</a> may appear, some of which can be turned
295 on or off using these functions: <code class="literal">&lt;set-flag&gt;</code> and
296 <code class="literal">&lt;clear-flag&gt;</code> bound by default to
297 <span class="quote">“<span class="quote">w</span>”</span> and <span class="quote">“<span class="quote">W</span>”</span> respectively.
298 </p><p>
299 Furthermore, the flags in <a class="xref" href="#tab-msg-recip-flags" title="Table 2.6. Message recipient flags">Table 2.6, “Message recipient flags”</a> reflect
300 who the message is addressed to. They can be customized with the <a class="link" href="#to-chars" title="3.294. to_chars">$to_chars</a> variable.
301 </p><div class="table"><a id="tab-msg-status-flags"></a><p class="title"><b>Table 2.5. 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><tr><td>n</td><td>thread contains new messages (only if collapsed)</td></tr><tr><td>o</td><td>thread contains old messages (only if collapsed)</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.6. 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" title="5.2. The Pager"><div class="titlepage"><div><div><h3 class="title"><a id="pager-menu"></a>5.2. The Pager</h3></div></div></div><p>
302 By default, Mutt uses its built-in pager to display the contents of
303 messages (an external pager such as <code class="literal">less(1)</code> can be
304 configured, see <a class="link" href="#pager" title="3.149. pager">$pager</a> variable).  The
305 pager is very similar to the Unix program <code class="literal">less(1)</code>
306 though not nearly as featureful.
307 </p><div class="table"><a id="tab-key-pager"></a><p class="title"><b>Table 2.7. 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>&lt;Return&gt;</td><td>go down one line</td></tr><tr><td>&lt;Space&gt;</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>
308 In addition to key bindings in <a class="xref" href="#tab-key-pager" title="Table 2.7. Most common pager keys">Table 2.7, “Most common pager keys”</a>, many of
309 the functions from the index menu are also available in the pager, such
310 as <code class="literal">&lt;delete-message&gt;</code> or
311 <code class="literal">&lt;copy-message&gt;</code> (this is one advantage over
312 using an external pager to view messages).
313 </p><p>
314 Also, the internal pager supports a couple other advanced features. For
315 one, it will accept and translate the <span class="quote">“<span class="quote">standard</span>”</span> nroff
316 sequences for bold and underline. These sequences are a series of either
317 the letter, backspace (<span class="quote">“<span class="quote">^H</span>”</span>), the letter again for bold or
318 the letter, backspace, <span class="quote">“<span class="quote">_</span>”</span> for denoting underline. Mutt
319 will attempt to display these in bold and underline respectively if your
320 terminal supports them. If not, you can use the bold and underline <a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a> objects to specify a
321 <span class="command"><strong>color</strong></span> or mono attribute for them.
322 </p><p>
323 Additionally, the internal pager supports the ANSI escape sequences for
324 character attributes.  Mutt translates them into the correct color and
325 character settings.  The sequences Mutt supports are:
326 </p><pre class="screen">
327 \e[<span class="emphasis"><em>Ps</em></span>;<span class="emphasis"><em>Ps</em></span>;..<span class="emphasis"><em>Ps</em></span>;m
328 </pre><p>
329 where <span class="emphasis"><em>Ps</em></span> can be one of the codes shown in <a class="xref" href="#tab-ansi-esc" title="Table 2.8. ANSI escape sequences">Table 2.8, “ANSI escape sequences”</a>.
330 </p><div class="table"><a id="tab-ansi-esc"></a><p class="title"><b>Table 2.8. 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>&lt;color&gt;</em></span></td><td>Foreground color is <span class="emphasis"><em>&lt;color&gt;</em></span> (see <a class="xref" href="#tab-color" title="Table 2.9. Color sequences">Table 2.9, “Color sequences”</a>)</td></tr><tr><td>4<span class="emphasis"><em>&lt;color&gt;</em></span></td><td>Background color is <span class="emphasis"><em>&lt;color&gt;</em></span> (see <a class="xref" href="#tab-color" title="Table 2.9. Color sequences">Table 2.9, “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.9. 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>
331 Mutt uses these attributes for handling <code class="literal">text/enriched</code>
332 messages, and they can also be used by an external <a class="link" href="#auto-view" title="4. MIME Autoview">autoview</a> script for highlighting purposes.
333 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
334 If you change the colors for your display, for example by changing the
335 color associated with color2 for your xterm, then that color will be
336 used instead of green.
337 </p></div><div class="note" title="Note"><h3 class="title">Note</h3><p>
338 Note that the search commands in the pager take regular expressions,
339 which are not quite the same as the more complex <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a> used by the search command in the
340 index. This is because patterns are used to select messages by criteria
341 whereas the pager already displays a selected message.
342 </p></div></div><div class="sect2" title="5.3. Threaded Mode"><div class="titlepage"><div><div><h3 class="title"><a id="threads"></a>5.3. Threaded Mode</h3></div></div></div><p>
343 So-called <span class="quote">“<span class="quote">threads</span>”</span> provide a hierarchy of messages where
344 replies are linked to their parent message(s). This organizational form
345 is extremely useful in mailing lists where different parts of the
346 discussion diverge. Mutt displays threads as a tree structure.
347 </p><p>
348 In Mutt, when a mailbox is <a class="link" href="#sort" title="3.264. sort">sorted</a>
349 by <span class="emphasis"><em>threads</em></span>, there are a few additional functions
350 available in the <span class="emphasis"><em>index</em></span>
351 and <span class="emphasis"><em>pager</em></span> modes as shown in
352 <a class="xref" href="#tab-key-threads" title="Table 2.10. Most common thread mode keys">Table 2.10, “Most common thread mode keys”</a>.
353 </p><div class="table"><a id="tab-key-threads"></a><p class="title"><b>Table 2.10. 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">&lt;delete-thread&gt;</code></td><td>delete all messages in the current thread</td></tr><tr><td>^U</td><td><code class="literal">&lt;undelete-thread&gt;</code></td><td>undelete all messages in the current thread</td></tr><tr><td>^N</td><td><code class="literal">&lt;next-thread&gt;</code></td><td>jump to the start of the next thread</td></tr><tr><td>^P</td><td><code class="literal">&lt;previous-thread&gt;</code></td><td>jump to the start of the previous thread</td></tr><tr><td>^R</td><td><code class="literal">&lt;read-thread&gt;</code></td><td>mark the current thread as read</td></tr><tr><td>Esc d</td><td><code class="literal">&lt;delete-subthread&gt;</code></td><td>delete all messages in the current subthread</td></tr><tr><td>Esc u</td><td><code class="literal">&lt;undelete-subthread&gt;</code></td><td>undelete all messages in the current subthread</td></tr><tr><td>Esc n</td><td><code class="literal">&lt;next-subthread&gt;</code></td><td>jump to the start of the next subthread</td></tr><tr><td>Esc p</td><td><code class="literal">&lt;previous-subthread&gt;</code></td><td>jump to the start of the previous subthread</td></tr><tr><td>Esc r</td><td><code class="literal">&lt;read-subthread&gt;</code></td><td>mark the current subthread as read</td></tr><tr><td>Esc t</td><td><code class="literal">&lt;tag-thread&gt;</code></td><td>toggle the tag on the current thread</td></tr><tr><td>Esc v</td><td><code class="literal">&lt;collapse-thread&gt;</code></td><td>toggle collapse for the current thread</td></tr><tr><td>Esc V</td><td><code class="literal">&lt;collapse-all&gt;</code></td><td>toggle collapse for all threads</td></tr><tr><td>P</td><td><code class="literal">&lt;parent-message&gt;</code></td><td>jump to parent message in thread</td></tr></tbody></table></div></div><br class="table-break" /><p>
354 Collapsing a thread displays only the first message in the thread and
355 hides the others. This is useful when threads contain so many messages
356 that you can only see a handful of threads on the screen. See %M in
357 <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.  For example, you
358 could use <span class="quote">“<span class="quote">%?M?(#%03M)&amp;(%4l)?</span>”</span> in <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to optionally display the
359 number of hidden messages if the thread is collapsed. The
360 <code class="literal">%?&lt;char&gt;?&lt;if-part&gt;&amp;&lt;else-part&gt;?</code>
361 syntax is explained in detail in <a class="link" href="#formatstrings-conditionals" title="29.2. Conditionals">format string conditionals</a>.
362 </p><p>
363 Technically, every reply should contain a list of its parent messages in
364 the thread tree, but not all do. In these cases, Mutt groups them by
365 subject which can be controlled using the <a class="link" href="#strict-threads" title="3.285. strict_threads">$strict_threads</a> variable.
366 </p></div><div class="sect2" title="5.4. Miscellaneous Functions"><div class="titlepage"><div><div><h3 class="title"><a id="reading-misc"></a>5.4. Miscellaneous Functions</h3></div></div></div><p>
367 In addition, the <span class="emphasis"><em>index</em></span> and
368 <span class="emphasis"><em>pager</em></span> menus have these interesting functions:
369 </p><div class="variablelist"><dl><dt><span class="term">
370 <code class="literal">&lt;create-alias&gt;</code><a id="create-alias"></a>
371 (default: a)
372 </span></dt><dd><p>
373 Creates a new alias based upon the current message (or prompts for a new
374 one).  Once editing is complete, an <a class="link" href="#alias" title="4. Defining/Using Aliases"><span class="command"><strong>alias</strong></span></a> command is added to the
375 file specified by the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a>
376 variable for future use
377 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
378 Mutt does not read the <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a>
379 upon startup so you must explicitly <a class="link" href="#source" title="27. Reading Initialization Commands From Another File"><span class="command"><strong>source</strong></span></a> the file.
380 </p></div></dd><dt><span class="term">
381 <code class="literal">&lt;check-traditional-pgp&gt;</code><a id="check-traditional-pgp"></a> (default: Esc P)
382 </span></dt><dd><p>
383 This function will search the current message for content signed or
384 encrypted with PGP the <span class="quote">“<span class="quote">traditional</span>”</span> way, that is, without
385 proper MIME tagging.  Technically, this function will temporarily change
386 the MIME content types of the body parts containing PGP data; this is
387 similar to the <a class="link" href="#edit-type"><code class="literal">&lt;edit-type&gt;</code></a>
388 function's effect.
389 </p></dd><dt><span class="term">
390 <code class="literal">&lt;edit&gt;</code><a id="edit"></a> (default: e)
391 </span></dt><dd><p>
392 This command (available in the index and pager) allows you to edit the
393 raw current message as it's present in the mail folder.  After you have
394 finished editing, the changed message will be appended to the current
395 folder, and the original message will be marked for deletion; if the
396 message is unchanged it won't be replaced.
397 </p></dd><dt><span class="term">
398 <code class="literal">&lt;edit-type&gt;</code><a id="edit-type"></a> (default:
399 ^E on the attachment menu, and in the pager and index menus; ^T on the
400 compose menu)
401 </span></dt><dd><p>
402 This command is used to temporarily edit an attachment's content type to
403 fix, for instance, bogus character set parameters.  When invoked from
404 the index or from the pager, you'll have the opportunity to edit the
405 top-level attachment's content type.  On the <a class="link" href="#attach-menu" title="1.3. The Attachment Menu">attachment menu</a>, you can change any
406 attachment's content type. These changes are not persistent, and get
407 lost upon changing folders.
408 </p><p>
409 Note that this command is also available on the <a class="link" href="#compose-menu" title="1.4. The Compose Menu">compose menu</a>.  There, it's used to
410 fine-tune the properties of attachments you are going to send.
411 </p></dd><dt><span class="term">
412 <code class="literal">&lt;enter-command&gt;</code><a id="enter-command"></a>
413 (default: <span class="quote">“<span class="quote">:</span>”</span>)
414 </span></dt><dd><p>
415 This command is used to execute any command you would normally put in a
416 configuration file.  A common use is to check the settings of variables,
417 or in conjunction with <a class="link" href="#macro" title="8. Keyboard Macros">macros</a> to change
418 settings on the fly.
419 </p></dd><dt><span class="term">
420 <code class="literal">&lt;extract-keys&gt;</code><a id="extract-keys"></a>
421 (default: ^K)
422 </span></dt><dd><p>
423 This command extracts PGP public keys from the current or tagged
424 message(s) and adds them to your PGP public key ring.
425 </p></dd><dt><span class="term">
426 <code class="literal">&lt;forget-passphrase&gt;</code><a id="forget-passphrase"></a> (default: ^F)
427 </span></dt><dd><p>
428 This command wipes the passphrase(s) from memory. It is useful, if you
429 misspelled the passphrase.
430 </p></dd><dt><span class="term">
431 <code class="literal">&lt;list-reply&gt;</code><a id="list-reply"></a> (default:
432 L)
433 </span></dt><dd><p>
434 Reply to the current or tagged message(s) by extracting any addresses
435 which match the regular expressions given by the <a class="link" href="#lists" title="12. Mailing Lists"><span class="command"><strong>lists</strong></span> or
436 <span class="command"><strong>subscribe</strong></span></a> commands, but also honor any
437 <code class="literal">Mail-Followup-To</code> header(s) if the <a class="link" href="#honor-followup-to" title="3.92. honor_followup_to">$honor_followup_to</a> configuration
438 variable is set.  Using this when replying to messages posted to mailing
439 lists helps avoid duplicate copies being sent to the author of the
440 message you are replying to.
441 </p></dd><dt><span class="term">
442 <code class="literal">&lt;pipe-message&gt;</code><a id="pipe-message"></a>
443 (default: |)
444 </span></dt><dd><p>
445 Asks for an external Unix command and pipes the current or tagged
446 message(s) to it.  The variables <a class="link" href="#pipe-decode" title="3.183. pipe_decode">$pipe_decode</a>, <a class="link" href="#pipe-split" title="3.185. pipe_split">$pipe_split</a>, <a class="link" href="#pipe-sep" title="3.184. pipe_sep">$pipe_sep</a> and <a class="link" href="#wait-key" title="3.305. wait_key">$wait_key</a> control the exact behavior of this
447 function.
448 </p></dd><dt><span class="term">
449 <code class="literal">&lt;resend-message&gt;</code><a id="resend-message"></a>
450 (default: Esc e)
451 </span></dt><dd><p>
452 Mutt takes the current message as a template for a new message.  This
453 function is best described as "recall from arbitrary folders".  It can
454 conveniently be used to forward MIME messages while preserving the
455 original mail structure. Note that the amount of headers included here
456 depends on the value of the <a class="link" href="#weed" title="3.306. weed">$weed</a> variable.
457 </p><p>
458 This function is also available from the attachment menu. You can use
459 this to easily resend a message which was included with a bounce message
460 as a <code class="literal">message/rfc822</code> body part.
461 </p></dd><dt><span class="term">
462 <code class="literal">&lt;shell-escape&gt;</code><a id="shell-escape"></a>
463 (default: !)
464 </span></dt><dd><p>
465 Asks for an external Unix command and executes it.  The <a class="link" href="#wait-key" title="3.305. wait_key">$wait_key</a> can be used to control whether Mutt
466 will wait for a key to be pressed when the command returns (presumably
467 to let the user read the output of the command), based on the return
468 status of the named command. If no command is given, an interactive
469 shell is executed.
470 </p></dd><dt><span class="term">
471 <code class="literal">&lt;toggle-quoted&gt;</code><a id="toggle-quoted"></a>
472 (default: T)
473 </span></dt><dd><p>
474 The pager uses the <a class="link" href="#quote-regexp" title="3.207. quote_regexp">$quote_regexp</a>
475 variable to detect quoted text when displaying the body of the message.
476 This function toggles the display of the quoted material in the message.
477 It is particularly useful when being interested in just the response and
478 there is a large amount of quoted text in the way.
479 </p></dd><dt><span class="term">
480 <code class="literal">&lt;skip-quoted&gt;</code><a id="skip-quoted"></a>
481 (default: S)
482 </span></dt><dd><p>
483 This function will go to the next line of non-quoted text which comes
484 after a line of quoted text in the internal pager.
485 </p></dd></dl></div></div></div><div class="sect1" title="6. Sending Mail"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sending"></a>6. Sending Mail</h2></div></div></div><div class="sect2" title="6.1. Introduction"><div class="titlepage"><div><div><h3 class="title"><a id="sending-intro"></a>6.1. Introduction</h3></div></div></div><p>
486 The bindings shown in <a class="xref" href="#tab-key-send" title="Table 2.11. Most common mail sending keys">Table 2.11, “Most common mail sending keys”</a> are available in
487 the <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span> to start a
488 new message.
489 </p><div class="table"><a id="tab-key-send"></a><p class="title"><b>Table 2.11. 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">&lt;compose&gt;</code></td><td>compose a new message</td></tr><tr><td>r</td><td><code class="literal">&lt;reply&gt;</code></td><td>reply to sender</td></tr><tr><td>g</td><td><code class="literal">&lt;group-reply&gt;</code></td><td>reply to all recipients</td></tr><tr><td>L</td><td><code class="literal">&lt;list-reply&gt;</code></td><td>reply to mailing list address</td></tr><tr><td>f</td><td><code class="literal">&lt;forward&gt;</code></td><td>forward message</td></tr><tr><td>b</td><td><code class="literal">&lt;bounce&gt;</code></td><td>bounce (remail) message</td></tr><tr><td>Esc k</td><td><code class="literal">&lt;mail-key&gt;</code></td><td>mail a PGP public key to someone</td></tr></tbody></table></div></div><br class="table-break" /><p>
490 <span class="emphasis"><em>Bouncing</em></span> a message sends the message as-is to the
491 recipient you specify.  <span class="emphasis"><em>Forwarding</em></span> a message allows
492 you to add comments or modify the message you are forwarding.  These
493 items are discussed in greater detail in the next section <span class="quote">“<span class="quote"><a class="link" href="#forwarding-mail" title="7. Forwarding and Bouncing Mail">Forwarding and Bouncing Mail</a>.</span>”</span>
494 </p><p>
495 Mutt will then enter the <span class="emphasis"><em>compose</em></span> menu and prompt
496 you for the recipients to place on the <span class="quote">“<span class="quote">To:</span>”</span> header field
497 when you hit <code class="literal">m</code> to start a new message. Next, it will
498 ask you for the <span class="quote">“<span class="quote">Subject:</span>”</span> field for the message, providing
499 a default if you are replying to or forwarding a message. You again have
500 the chance to adjust recipients, subject, and security settings right
501 before actually sending the message. See also <a class="link" href="#askcc" title="3.10. askcc">$askcc</a>, <a class="link" href="#askbcc" title="3.9. askbcc">$askbcc</a>,
502 <a class="link" href="#autoedit" title="3.18. autoedit">$autoedit</a>, <a class="link" href="#bounce" title="3.21. bounce">$bounce</a>, <a class="link" href="#fast-reply" title="3.63. fast_reply">$fast_reply</a>, and <a class="link" href="#include" title="3.111. include">$include</a> for changing how and if Mutt asks
503 these questions.
504 </p><p>
505 When replying, Mutt fills these fields with proper values depending on
506 the reply type.  The types of replying supported are:
507 </p><div class="variablelist"><dl><dt><span class="term">Simple reply</span></dt><dd><p>
508 Reply to the author directly.
509 </p></dd><dt><span class="term">Group reply</span></dt><dd><p>
510 Reply to the author as well to all recipients except you; this consults
511 <a class="link" href="#alternates" title="11. Alternative Addresses"><span class="command"><strong>alternates</strong></span></a>.
512 </p></dd><dt><span class="term">List reply</span></dt><dd><p>
513 Reply to all mailing list addresses found, either specified via
514 configuration or auto-detected.  See <a class="xref" href="#lists" title="12. Mailing Lists">Section 12, “Mailing Lists”</a> for
515 details.
516 </p></dd></dl></div><p>
517 After getting recipients for new messages, forwards or replies, Mutt
518 will then automatically start your <a class="link" href="#editor" title="3.58. editor">$editor</a>
519 on the message body. If the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> variable is set, the headers
520 will be at the top of the message in your editor.  Any messages you are
521 replying to will be added in sort order to the message, with appropriate
522 <a class="link" href="#attribution" title="3.16. attribution">$attribution</a>, <a class="link" href="#indent-string" title="3.113. indent_string">$indent_string</a> and <a class="link" href="#post-indent-string" title="3.195. post_indent_string">$post_indent_string</a>.  When
523 forwarding a message, if the <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> variable is unset, a copy of
524 the forwarded message will be included.  If you have specified a <a class="link" href="#signature" title="3.236. signature">$signature</a>, it will be appended to the
525 message.
526 </p><p>
527 Once you have finished editing the body of your mail message, you are
528 returned to the <span class="emphasis"><em>compose</em></span> menu providing the
529 functions shown in <a class="xref" href="#tab-func-compose" title="Table 2.12. Most common compose menu keys">Table 2.12, “Most common compose menu keys”</a> to modify, send or
530 postpone the message.
531 </p><div class="table"><a id="tab-func-compose"></a><p class="title"><b>Table 2.12. 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">&lt;attach-file&gt;</code></td><td>attach a file</td></tr><tr><td>A</td><td><code class="literal">&lt;attach-message&gt;</code></td><td>attach message(s) to the message</td></tr><tr><td>Esc k</td><td><code class="literal">&lt;attach-key&gt;</code></td><td>attach a PGP public key</td></tr><tr><td>d</td><td><code class="literal">&lt;edit-description&gt;</code></td><td>edit description on attachment</td></tr><tr><td>D</td><td><code class="literal">&lt;detach-file&gt;</code></td><td>detach a file</td></tr><tr><td>t</td><td><code class="literal">&lt;edit-to&gt;</code></td><td>edit the To field</td></tr><tr><td>Esc f</td><td><code class="literal">&lt;edit-from&gt;</code></td><td>edit the From field</td></tr><tr><td>r</td><td><code class="literal">&lt;edit-reply-to&gt;</code></td><td>edit the Reply-To field</td></tr><tr><td>c</td><td><code class="literal">&lt;edit-cc&gt;</code></td><td>edit the Cc field</td></tr><tr><td>b</td><td><code class="literal">&lt;edit-bcc&gt;</code></td><td>edit the Bcc field</td></tr><tr><td>y</td><td><code class="literal">&lt;send-message&gt;</code></td><td>send the message</td></tr><tr><td>s</td><td><code class="literal">&lt;edit-subject&gt;</code></td><td>edit the Subject</td></tr><tr><td>S</td><td><code class="literal">&lt;smime-menu&gt;</code></td><td>select S/MIME options</td></tr><tr><td>f</td><td><code class="literal">&lt;edit-fcc&gt;</code></td><td>specify an <span class="quote">“<span class="quote">Fcc</span>”</span> mailbox</td></tr><tr><td>p</td><td><code class="literal">&lt;pgp-menu&gt;</code></td><td>select PGP options</td></tr><tr><td>P</td><td><code class="literal">&lt;postpone-message&gt;</code></td><td>postpone this message until later</td></tr><tr><td>q</td><td><code class="literal">&lt;quit&gt;</code></td><td>quit (abort) sending the message</td></tr><tr><td>w</td><td><code class="literal">&lt;write-fcc&gt;</code></td><td>write the message to a folder</td></tr><tr><td>i</td><td><code class="literal">&lt;ispell&gt;</code></td><td>check spelling (if available on your system)</td></tr><tr><td>^F</td><td><code class="literal">&lt;forget-passphrase&gt;</code></td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><br class="table-break" /><p>
532 The compose menu is also used to edit the attachments for a message
533 which can be either files or other messages. The
534 <code class="literal">&lt;attach-message&gt;</code> function to will prompt you
535 for a folder to attach messages from. You can now tag messages in that
536 folder and they will be attached to the message you are sending.
537 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
538 Note that certain operations like composing a new mail, replying,
539 forwarding, etc. are not permitted when you are in that folder. The %r
540 in <a class="link" href="#status-format" title="3.283. status_format">$status_format</a> will change to a
541 <span class="quote">“<span class="quote">A</span>”</span> to indicate that you are in attach-message mode.
542 </p></div></div><div class="sect2" title="6.2. Editing the Message Header"><div class="titlepage"><div><div><h3 class="title"><a id="edit-header"></a>6.2. Editing the Message Header</h3></div></div></div><p>
543 When editing the header because of <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> being set, there are a
544 several pseudo headers available which will not be included in sent
545 messages but trigger special Mutt behavior.
546 </p><div class="sect3" title="6.2.1. Fcc: Pseudo Header"><div class="titlepage"><div><div><h4 class="title"><a id="fcc-header"></a>6.2.1. Fcc: Pseudo Header</h4></div></div></div><p>
547 If you specify
548 </p><p>
549 <code class="literal">Fcc:</code> <span class="emphasis"><em>filename</em></span>
550 </p><p>
551 as a header, Mutt will pick up <span class="emphasis"><em>filename</em></span> just as if
552 you had used the <code class="literal">&lt;edit-fcc&gt;</code> function in the
553 <span class="emphasis"><em>compose</em></span> menu.  It can later be changed from the
554 compose menu.
555 </p></div><div class="sect3" title="6.2.2. Attach: Pseudo Header"><div class="titlepage"><div><div><h4 class="title"><a id="attach-header"></a>6.2.2. Attach: Pseudo Header</h4></div></div></div><p>
556 You can also attach files to your message by specifying
557 </p><p>
558 <code class="literal">Attach:</code> <span class="emphasis"><em>filename</em></span>
559 [ <span class="emphasis"><em>description</em></span> ]
560 </p><p>
561 where <span class="emphasis"><em>filename</em></span> is the file to attach and
562 <span class="emphasis"><em>description</em></span> is an optional string to use as the
563 description of the attached file. Spaces in filenames have to be escaped
564 using backslash (<span class="quote">“<span class="quote">\</span>”</span>).  The file can be removed as well as
565 more added from the compose menu.
566 </p></div><div class="sect3" title="6.2.3. Pgp: Pseudo Header"><div class="titlepage"><div><div><h4 class="title"><a id="pgp-header"></a>6.2.3. Pgp: Pseudo Header</h4></div></div></div><p>
567 If you want to use PGP, you can specify
568 </p><p>
569 <code class="literal">Pgp:</code> [ <code class="literal">E</code> | <code class="literal">S</code> | <code class="literal">S</code><span class="emphasis"><em>&lt;id&gt;</em></span> ]
570
571 </p><p>
572 <span class="quote">“<span class="quote">E</span>”</span> selects encryption, <span class="quote">“<span class="quote">S</span>”</span> selects signing
573 and <span class="quote">“<span class="quote">S&lt;id&gt;</span>”</span> selects signing with the given key,
574 setting <a class="link" href="#pgp-sign-as" title="3.175. pgp_sign_as">$pgp_sign_as</a> permanently. The
575 selection can later be changed in the compose menu.
576 </p></div><div class="sect3" title="6.2.4. In-Reply-To: Header"><div class="titlepage"><div><div><h4 class="title"><a id="in-reply-to-header"></a>6.2.4. In-Reply-To: Header</h4></div></div></div><p>
577 When replying to messages, the <span class="emphasis"><em>In-Reply-To:</em></span> header
578 contains the Message-Id of the message(s) you reply to. If you remove or
579 modify its value, Mutt will not generate a
580 <span class="emphasis"><em>References:</em></span> field, which allows you to create a new
581 message thread, for example to create a new message to a mailing list
582 without having to enter the mailing list's address.
583 </p><p>
584 If you intend to start a new thread by replying, please make really sure
585 you remove the <span class="emphasis"><em>In-Reply-To:</em></span> header in your
586 editor. Otherwise, though you'll produce a technically valid reply, some
587 netiquette guardians will be annoyed by this so-called <span class="quote">“<span class="quote">thread
588 hijacking</span>”</span>.
589 </p></div></div><div class="sect2" title="6.3. Sending Cryptographically Signed/Encrypted Messages"><div class="titlepage"><div><div><h3 class="title"><a id="sending-crypto"></a>6.3. Sending Cryptographically Signed/Encrypted Messages</h3></div></div></div><p>
590 If you have told Mutt to PGP or S/MIME encrypt a message, it will guide
591 you through a key selection process when you try to send the message.
592 Mutt will not ask you any questions about keys which have a certified
593 user ID matching one of the message recipients' mail addresses.
594 However, there may be situations in which there are several keys, weakly
595 certified user ID fields, or where no matching keys can be found.
596 </p><p>
597 In these cases, you are dropped into a menu with a list of keys from
598 which you can select one.  When you quit this menu, or Mutt can't find
599 any matching keys, you are prompted for a user ID.  You can, as usually,
600 abort this prompt using <code class="literal">^G</code>.  When you do so, Mutt
601 will return to the compose screen.
602 </p><p>
603 Once you have successfully finished the key selection, the message will
604 be encrypted using the selected public keys when sent out.
605 </p><p>
606 Most fields of the entries in the key selection menu (see also <a class="link" href="#pgp-entry-format" title="3.162. pgp_entry_format">$pgp_entry_format</a>) have obvious
607 meanings.  But some explanations on the capabilities, flags, and
608 validity fields are in order.
609 </p><p>
610 The flags sequence (<span class="quote">“<span class="quote">%f</span>”</span>) will expand to one of the flags
611 in <a class="xref" href="#tab-pgp-menuflags" title="Table 2.13. PGP key menu flags">Table 2.13, “PGP key menu flags”</a>.
612 </p><div class="table"><a id="tab-pgp-menuflags"></a><p class="title"><b>Table 2.13. 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>
613 The capabilities field (<span class="quote">“<span class="quote">%c</span>”</span>) expands to a two-character
614 sequence representing a key's capabilities.  The first character gives
615 the key's encryption capabilities: A minus sign (<span class="quote">“<span class="quote">-</span>”</span>) means
616 that the key cannot be used for encryption.  A dot (<span class="quote">“<span class="quote">.</span>”</span>)
617 means that it's marked as a signature key in one of the user IDs, but
618 may also be used for encryption.  The letter <span class="quote">“<span class="quote">e</span>”</span> indicates
619 that this key can be used for encryption.
620 </p><p>
621 The second character indicates the key's signing capabilities.  Once
622 again, a <span class="quote">“<span class="quote">-</span>”</span> implies <span class="quote">“<span class="quote">not for signing</span>”</span>,
623 <span class="quote">“<span class="quote">.</span>”</span> implies that the key is marked as an encryption key in
624 one of the user-ids, and <span class="quote">“<span class="quote">s</span>”</span> denotes a key which can be
625 used for signing.
626 </p><p>
627 Finally, the validity field (<span class="quote">“<span class="quote">%t</span>”</span>) indicates how
628 well-certified a user-id is.  A question mark (<span class="quote">“<span class="quote">?</span>”</span>)
629 indicates undefined validity, a minus character (<span class="quote">“<span class="quote">-</span>”</span>) marks
630 an untrusted association, a space character means a partially trusted
631 association, and a plus character (<span class="quote">“<span class="quote">+</span>”</span>) indicates complete
632 validity.
633 </p></div><div class="sect2" title="6.4. Sending Format=Flowed Messages"><div class="titlepage"><div><div><h3 class="title"><a id="ff"></a>6.4. Sending Format=Flowed Messages</h3></div></div></div><div class="sect3" title="6.4.1. Concept"><div class="titlepage"><div><div><h4 class="title"><a id="ff-concept"></a>6.4.1. Concept</h4></div></div></div><p>
634 <code class="literal">format=flowed</code>-style messages (or
635 <code class="literal">f=f</code> for short) are <code class="literal">text/plain</code>
636 messages that consist of paragraphs which a receiver's mail client may
637 reformat to its own needs which mostly means to customize line lengths
638 regardless of what the sender sent. Technically this is achieved by
639 letting lines of a <span class="quote">“<span class="quote">flowable</span>”</span> paragraph end in spaces
640 except for the last line.
641 </p><p>
642 While for text-mode clients like Mutt it's the best way to assume only a
643 standard 80x25 character cell terminal, it may be desired to let the
644 receiver decide completely how to view a message.
645 </p></div><div class="sect3" title="6.4.2. Mutt Support"><div class="titlepage"><div><div><h4 class="title"><a id="ff-support"></a>6.4.2. Mutt Support</h4></div></div></div><p>
646 Mutt only supports setting the required <code class="literal">format=flowed</code>
647 MIME parameter on outgoing messages if the <a class="link" href="#text-flowed" title="3.287. text_flowed">$text_flowed</a> variable is set, specifically
648 it does not add the trailing spaces.
649 </p><p>
650 After editing the initial message text and before entering the compose
651 menu, Mutt properly space-stuffs the message.
652 <span class="emphasis"><em>Space-stuffing</em></span> is required by RfC3676 defining
653 <code class="literal">format=flowed</code> and means to prepend a space to:
654 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>all lines starting with a space</p></li><li class="listitem"><p>lines starting with the word
655 <span class="quote">“<span class="quote"><code class="literal">From</code></span>”</span> followed by
656 space</p></li><li class="listitem"><p>all lines starting with
657 <span class="quote">“<span class="quote"><code class="literal">&gt;</code></span>”</span> which is not intended to be a
658 quote character</p></li></ul></div><div class="note" title="Note"><h3 class="title">Note</h3><p>
659 Mutt only supports space-stuffing for the first two types of lines but
660 not for the third: It is impossible to safely detect whether a leading
661 <code class="literal">&gt;</code> character starts a quote or not. Furthermore,
662 Mutt only applies space-stuffing <span class="emphasis"><em>once</em></span> after the
663 initial edit is finished.
664 </p></div><p>
665 All leading spaces are to be removed by receiving clients to restore the
666 original message prior to further processing.
667 </p></div><div class="sect3" title="6.4.3. Editor Considerations"><div class="titlepage"><div><div><h4 class="title"><a id="ff-editor"></a>6.4.3. Editor Considerations</h4></div></div></div><p>
668 As Mutt provides no additional features to compose
669 <code class="literal">f=f</code> messages, it's completely up to the user and his
670 editor to produce proper messages. Please consider your editor's
671 documentation if you intend to send <code class="literal">f=f</code> messages.
672 </p><p>
673 Please note that when editing messages from the compose menu several
674 times before really sending a mail, it's up to the user to ensure that
675 the message is properly space-stuffed.
676 </p><p>
677 For example, <span class="emphasis"><em>vim</em></span> provides the <code class="literal">w</code>
678 flag for its <code class="literal">formatoptions</code> setting to assist in
679 creating <code class="literal">f=f</code> messages, see <code class="literal">:help
680 fo-table</code> for details.
681 </p></div></div></div><div class="sect1" title="7. Forwarding and Bouncing Mail"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="forwarding-mail"></a>7. Forwarding and Bouncing Mail</h2></div></div></div><p>
682 Bouncing and forwarding let you send an existing message to recipients
683 that you specify. Bouncing a message sends a verbatim copy of a message
684 to alternative addresses as if they were the message's original
685 recipients specified in the Bcc header.  Forwarding a message, on the
686 other hand, allows you to modify the message before it is resent (for
687 example, by adding your own comments). Bouncing is done using the
688 <code class="literal">&lt;bounce&gt;</code> function and forwarding using the
689 <code class="literal">&lt;forward&gt;</code> function bound to <span class="quote">“<span class="quote">b</span>”</span>
690 and <span class="quote">“<span class="quote">f</span>”</span> respectively.
691 </p><p>
692 Forwarding can be done by including the original message in the new
693 message's body (surrounded by indicating lines) or including it as a
694 MIME attachment, depending on the value of the <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> variable.  Decoding of
695 attachments, like in the pager, can be controlled by the <a class="link" href="#forward-decode" title="3.70. forward_decode">$forward_decode</a> and <a class="link" href="#mime-forward-decode" title="3.142. mime_forward_decode">$mime_forward_decode</a> variables,
696 respectively.  The desired forwarding format may depend on the content,
697 therefore <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> is a
698 quadoption which, for example, can be set to <span class="quote">“<span class="quote">ask-no</span>”</span>.
699 </p><p>
700 The inclusion of headers is controlled by the current setting of the
701 <a class="link" href="#weed" title="3.306. weed">$weed</a> variable, unless <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> is set.
702 </p><p>
703 Editing the message to forward follows the same procedure as sending or
704 replying to a message does.
705 </p></div><div class="sect1" title="8. Postponing Mail"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="postponing-mail"></a>8. Postponing Mail</h2></div></div></div><p>
706 At times it is desirable to delay sending a message that you have
707 already begun to compose.  When the
708 <code class="literal">&lt;postpone-message&gt;</code> function is used in the
709 <span class="emphasis"><em>compose</em></span> menu, the body of your message and
710 attachments are stored in the mailbox specified by the <a class="link" href="#postponed" title="3.197. postponed">$postponed</a> variable.  This means that you can
711 recall the message even if you exit Mutt and then restart it at a later
712 time.
713 </p><p>
714 Once a message is postponed, there are several ways to resume it.  From
715 the command line you can use the <span class="quote">“<span class="quote">-p</span>”</span> option, or if you
716 compose a new message from the <span class="emphasis"><em>index</em></span> or
717 <span class="emphasis"><em>pager</em></span> you will be prompted if postponed messages
718 exist.  If multiple messages are currently postponed, the
719 <span class="emphasis"><em>postponed</em></span> menu will pop up and you can select which
720 message you would like to resume.
721 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
722 If you postpone a reply to a message, the reply setting of the message
723 is only updated when you actually finish the message and send it.  Also,
724 you must be in the same folder with the message you replied to for the
725 status of the message to be updated.
726 </p></div><p>
727 See also the <a class="link" href="#postpone" title="3.196. postpone">$postpone</a> quad-option.
728 </p></div></div><div class="chapter" title="Chapter 3. Configuration"><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="#msg-hdr-display">10. Message Header Display</a></span></dt><dd><dl><dt><span class="sect2"><a href="#hdr-folding">10.1. Header Display</a></span></dt><dt><span class="sect2"><a href="#ignore">10.2. Selecting Headers</a></span></dt><dt><span class="sect2"><a href="#hdr-order">10.3. Ordering Displayed Headers</a></span></dt></dl></dd><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="#var-types">26.1. Variable Types</a></span></dt><dt><span class="sect2"><a href="#set-commands">26.2. Commands</a></span></dt><dt><span class="sect2"><a href="#set-myvar">26.3. User-Defined Variables</a></span></dt><dt><span class="sect2"><a href="#set-conversions">26.4. Type Conversions</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-conditionals">29.2. Conditionals</a></span></dt><dt><span class="sect2"><a href="#formatstrings-filters">29.3. Filters</a></span></dt><dt><span class="sect2"><a href="#formatstrings-padding">29.4. Padding</a></span></dt></dl></dd></dl></div><div class="sect1" title="1. Location of Initialization Files"><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>
729 While the default configuration (or <span class="quote">“<span class="quote">preferences</span>”</span>) make
730 Mutt usable right out of the box, it is often desirable to tailor Mutt
731 to suit your own tastes. When Mutt is first invoked, it will attempt to
732 read the <span class="quote">“<span class="quote">system</span>”</span> configuration file (defaults set by your
733 local system administrator), unless the <span class="quote">“<span class="quote">-n</span>”</span> <a class="link" href="#commandline" title="1. Command-Line Options">command line</a> option is specified.  This
734 file is typically <code class="literal">/usr/local/share/mutt/Muttrc</code> or
735 <code class="literal">/etc/Muttrc</code>. Mutt will next look for a file named
736 <code class="literal">.muttrc</code> in your home directory.  If this file does
737 not exist and your home directory has a subdirectory named
738 <code class="literal">.mutt</code>, Mutt tries to load a file named
739 <code class="literal">.mutt/muttrc</code>.
740 </p><p>
741 <code class="literal">.muttrc</code> is the file where you will usually place your
742 <a class="link" href="#commands" title="2. Configuration Commands">commands</a> to configure Mutt.
743 </p><p>
744 In addition, Mutt supports version specific configuration files that are
745 parsed instead of the default files as explained above.  For instance,
746 if your system has a <code class="literal">Muttrc-0.88</code> file in the system
747 configuration directory, and you are running version 0.88 of Mutt, this
748 file will be sourced instead of the <code class="literal">Muttrc</code> file.  The
749 same is true of the user configuration file, if you have a file
750 <code class="literal">.muttrc-0.88.6</code> in your home directory, when you run
751 Mutt version 0.88.6, it will source this file instead of the default
752 <code class="literal">.muttrc</code> file.  The version number is the same which
753 is visible using the <span class="quote">“<span class="quote">-v</span>”</span> <a class="link" href="#commandline" title="1. Command-Line Options">command line</a> switch or using the
754 <code class="literal">show-version</code> key (default: V) from the index menu.
755 </p></div><div class="sect1" title="2. Syntax of Initialization Files"><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>
756 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
757 one or more commands.  When multiple commands are used, they must be
758 separated by a semicolon (<span class="quote">“<span class="quote">;</span>”</span>).
759 </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">
760 set realname='Mutt user' ; ignore x-
761 </pre></div></div><br class="example-break" /><p>
762 The hash mark, or pound sign (<span class="quote">“<span class="quote">#</span>”</span>), is used as a
763 <span class="quote">“<span class="quote">comment</span>”</span> character. You can use it to annotate your
764 initialization file. All text after the comment character to the end of
765 the line is ignored.
766 </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">
767 my_hdr X-Disclaimer: Why are you listening to me? <span class="comment"># This is a comment</span>
768 </pre></div></div><br class="example-break" /><p>
769 Single quotes (<span class="quote">“<span class="quote">'</span>”</span>) and double quotes (<span class="quote">“<span class="quote">"</span>”</span>)
770 can be used to quote strings which contain spaces or other special
771 characters.  The difference between the two types of quotes is similar
772 to that of many popular shell programs, namely that a single quote is
773 used to specify a literal string (one that is not interpreted for shell
774 variables or quoting with a backslash [see next paragraph]), while
775 double quotes indicate a string for which should be evaluated.  For
776 example, backticks are evaluated inside of double quotes, but
777 <span class="emphasis"><em>not</em></span> for single quotes.
778 </p><p>
779 <span class="quote">“<span class="quote">\</span>”</span> quotes the next character, just as in shells such as
780 bash and zsh.  For example, if want to put quotes <span class="quote">“<span class="quote">"</span>”</span>
781 inside of a string, you can use <span class="quote">“<span class="quote">\</span>”</span> to force the next
782 character to be a literal instead of interpreted character.
783 </p><div class="example"><a id="ex-rc-quote"></a><p class="title"><b>Example 3.3. Escaping quotes in configuration files</b></p><div class="example-contents"><pre class="screen">
784 set realname="Michael \"MuttDude\" Elkins"
785 </pre></div></div><br class="example-break" /><p>
786 <span class="quote">“<span class="quote">\\</span>”</span> means to insert a literal <span class="quote">“<span class="quote">\</span>”</span> into the line.
787 <span class="quote">“<span class="quote">\n</span>”</span> and <span class="quote">“<span class="quote">\r</span>”</span> have their usual C meanings of linefeed and
788 carriage-return, respectively.
789 </p><p>
790 A <span class="quote">“<span class="quote">\</span>”</span> at the end of a line can be used to split commands
791 over multiple lines as it <span class="quote">“<span class="quote">escapes</span>”</span> the line end, provided
792 that the split points don't appear in the middle of command names. Lines
793 are first concatenated before interpretation so that a multi-line can be
794 commented by commenting out the first line only.
795 </p><div class="example"><a id="ex-rc-split"></a><p class="title"><b>Example 3.4. Splitting long configuration commands over several lines</b></p><div class="example-contents"><pre class="screen">
796 set status_format="some very \
797 long value split \
798 over several lines"
799 </pre></div></div><br class="example-break" /><p>
800 It is also possible to substitute the output of a Unix command in an
801 initialization file.  This is accomplished by enclosing the command in
802 backticks (``). In <a class="xref" href="#ex-rc-backtick" title="Example 3.5. Using external command's output in configuration files">Example 3.5, “Using external command's output in configuration files”</a>, the output of the
803 Unix command <span class="quote">“<span class="quote">uname -a</span>”</span> will be substituted before the line
804 is parsed.  Since initialization files are line oriented, only the first
805 line of output from the Unix command will be substituted.
806 </p><div class="example"><a id="ex-rc-backtick"></a><p class="title"><b>Example 3.5. Using external command's output in configuration files</b></p><div class="example-contents"><pre class="screen">
807 my_hdr X-Operating-System: `uname -a`
808 </pre></div></div><br class="example-break" /><p>
809 Both environment variables and Mutt variables can be accessed by
810 prepending <span class="quote">“<span class="quote">$</span>”</span> to the name of the variable. For example,
811 </p><div class="example"><a id="ex-rc-env"></a><p class="title"><b>Example 3.6. Using environment variables in configuration files</b></p><div class="example-contents"><pre class="screen">
812 set record=+sent_on_$HOSTNAME
813 </pre></div></div><br class="example-break" /><p>
814 will cause Mutt to save outgoing messages to a folder named
815 <span class="quote">“<span class="quote">sent_on_kremvax</span>”</span> if the environment variable
816 <code class="literal">$HOSTNAME</code> is set to <span class="quote">“<span class="quote">kremvax.</span>”</span> (See
817 <a class="link" href="#record" title="3.212. record">$record</a> for details.)
818 </p><p>
819 Mutt expands the variable when it is assigned, not when it is used. If
820 the value of a variable on the right-hand side of an assignment changes
821 after the assignment, the variable on the left-hand side will not be
822 affected.
823 </p><p>
824 The commands understood by Mutt are explained in the next paragraphs.
825 For a complete list, see the <a class="link" href="#commands" title="2. Configuration Commands">command
826 reference</a>.
827 </p><p>
828 All configuration files are expected to be in the current locale as
829 specified by the <a class="link" href="#charset" title="3.25. charset">$charset</a> variable which
830 doesn't have a default value since it's determined by Mutt at startup.
831 If a configuration file is not encoded in the same character set the
832 <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> variable should be
833 used: all lines starting with the next are recoded from <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> to <a class="link" href="#charset" title="3.25. charset">$charset</a>.
834 </p><p>
835 This mechanism should be avoided if possible as it has the following
836 implications:
837 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>These variables should be set early in a configuration
838 file with <a class="link" href="#charset" title="3.25. charset">$charset</a> preceding <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> so Mutt knows what
839 character set to convert to.</p></li><li class="listitem"><p>If <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>
840 is set, it should be set in each configuration file because the value is
841 global and <span class="emphasis"><em>not</em></span> per configuration
842 file.</p></li><li class="listitem"><p>Because Mutt first recodes a line before it attempts to
843 parse it, a conversion introducing question marks or other characters as
844 part of errors (unconvertable characters, transliteration) may introduce
845 syntax errors or silently change the meaning of certain tokens
846 (e.g. inserting question marks into regular
847 expressions).</p></li></ul></div></div><div class="sect1" title="3. Address Groups"><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>  [
848 <code class="option">-group</code>
849 <em class="replaceable"><code>name</code></em>
850 ...] { 
851 <code class="option">-rx</code>
852 <em class="replaceable"><code>expr</code></em>
853 ...  |   
854 <code class="option">-addr</code>
855 <em class="replaceable"><code>expr</code></em>
856 ... }<br /><code class="command">ungroup</code>  [
857 <code class="option">-group</code>
858 <em class="replaceable"><code>name</code></em>
859 ...] { 
860 <em class="replaceable"><code>*</code></em>
861   |   
862 <code class="option">-rx</code>
863 <em class="replaceable"><code>expr</code></em>
864 ...  |   
865 <code class="option">-addr</code>
866 <em class="replaceable"><code>expr</code></em>
867 ... }</p></div><p>
868 Mutt supports grouping addresses logically into named groups. An address
869 or address pattern can appear in several groups at the same time. These
870 groups can be used in <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a> (for searching, limiting and tagging) and
871 in hooks by using group patterns. This can be useful to classify mail
872 and take certain actions depending on in what groups the message is.
873 For example, the mutt user's mailing list would fit into the categories
874 <span class="quote">“<span class="quote">mailing list</span>”</span> and <span class="quote">“<span class="quote">mutt-related</span>”</span>. Using <a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients"><code class="literal">send-hook</code></a>, the sender can
875 be set to a dedicated one for writing mailing list messages, and the
876 signature could be set to a mutt-related one for writing to a mutt list
877 — for other lists, the list sender setting still applies but a
878 different signature can be selected. Or, given a group only containing
879 recipients known to accept encrypted mail,
880 <span class="quote">“<span class="quote">auto-encryption</span>”</span> can be achieved easily.
881 </p><p>
882 The <span class="command"><strong>group</strong></span> command is used to directly add either
883 addresses or regular expressions to the specified group or groups. The
884 different categories of arguments to the <span class="command"><strong>group</strong></span>
885 command can be in any order. The flags <code class="literal">-rx</code> and
886 <code class="literal">-addr</code> specify what the following strings (that cannot
887 begin with a hyphen) should be interpreted as: either a regular
888 expression or an email address, respectively.
889 </p><p>
890 These address groups can also be created implicitly by the <a class="link" href="#alias" title="4. Defining/Using Aliases"><span class="command"><strong>alias</strong></span></a>, <a class="link" href="#lists" title="12. Mailing Lists"><span class="command"><strong>lists</strong></span></a>, <a class="link" href="#lists" title="12. Mailing Lists"><span class="command"><strong>subscribe</strong></span></a> and <a class="link" href="#alternates" title="11. Alternative Addresses"><span class="command"><strong>alternates</strong></span></a> commands by
891 specifying the optional <code class="literal">-group</code> option. For example,
892 </p><pre class="screen">
893 alternates -group me address1 address2
894 alternates -group me -group work address3
895 </pre><p>
896 would create a group named <span class="quote">“<span class="quote">me</span>”</span> which contains all your
897 addresses and a group named <span class="quote">“<span class="quote">work</span>”</span> which contains only your
898 work address <span class="emphasis"><em>address3</em></span>. Besides many other
899 possibilities, this could be used to automatically mark your own
900 messages in a mailing list folder as read or use a special signature for
901 work-related messages.
902 </p><p>
903 The <span class="command"><strong>ungroup</strong></span> command is used to remove addresses or
904 regular expressions from the specified group or groups. The syntax is
905 similar to the <span class="command"><strong>group</strong></span> command, however the special
906 character <code class="literal">*</code> can be used to empty a group of all of
907 its contents. As soon as a group gets empty because all addresses and
908 regular expressions have been removed, it'll internally be removed, too
909 (i.e. there cannot be an empty group). When removing regular expressions
910 from a group, the pattern must be specified exactly as given to the
911 <span class="command"><strong>group</strong></span> command or <code class="literal">-group</code> argument.
912 </p></div><div class="sect1" title="4. Defining/Using Aliases"><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>  [
913 <code class="option">-group</code>
914 <em class="replaceable"><code>name</code></em>
915 ...]  
916 <em class="replaceable"><code>key</code></em>
917    
918 <em class="replaceable"><code>address</code></em>
919   [
920 <em class="replaceable"><code>address</code></em>
921 ...]<br /><code class="command">unalias</code>  [
922 <code class="option">-group</code>
923 <em class="replaceable"><code>name</code></em>
924 ...] { 
925 <em class="replaceable"><code>*</code></em>
926   |   
927 <em class="replaceable"><code>key</code></em>
928 ... }</p></div><p>
929 It's usually very cumbersome to remember or type out the address of
930 someone you are communicating with.  Mutt allows you to create
931 <span class="quote">“<span class="quote">aliases</span>”</span> which map a short string to a full address.
932 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
933 If you want to create an alias for more than one address, you
934 <span class="emphasis"><em>must</em></span> separate the addresses with a comma
935 (<span class="quote">“<span class="quote">,</span>”</span>).
936 </p></div><p>
937 The optional <code class="literal">-group</code> argument to
938 <span class="command"><strong>alias</strong></span> causes the aliased address(es) to be added to
939 the named <span class="emphasis"><em>group</em></span>.
940 </p><p>
941 To remove an alias or aliases (<span class="quote">“<span class="quote">*</span>”</span> means all aliases):
942 </p><pre class="screen">
943 alias muttdude me@cs.hmc.edu (Michael Elkins)
944 alias theguys manny, moe, jack
945 </pre><p>
946 Unlike other mailers, Mutt doesn't require aliases to be defined in a
947 special file.  The <span class="command"><strong>alias</strong></span> command can appear anywhere
948 in a configuration file, as long as this file is <a class="link" href="#source" title="27. Reading Initialization Commands From Another File"><span class="command"><strong>source</strong></span>d</a>.  Consequently, you
949 can have multiple alias files, or you can have all aliases defined in
950 your <code class="literal">.muttrc</code>.
951 </p><p>
952 On the other hand, the <a class="link" href="#create-alias"><code class="literal">&lt;create-alias&gt;</code></a>
953 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
954 <code class="literal">~/.muttrc</code> by default). This file is not special
955 either, in the sense that Mutt will happily append aliases to any file,
956 but in order for the new aliases to take effect you need to explicitly
957 <a class="link" href="#source" title="27. Reading Initialization Commands From Another File"><span class="command"><strong>source</strong></span></a> this file too.
958 </p><div class="example"><a id="ex-alias-external"></a><p class="title"><b>Example 3.7. Configuring external alias files</b></p><div class="example-contents"><pre class="screen">
959 source /usr/local/share/Mutt.aliases
960 source ~/.mail_aliases
961 set alias_file=~/.mail_aliases
962 </pre></div></div><br class="example-break" /><p>
963 To use aliases, you merely use the alias at any place in Mutt where Mutt
964 prompts for addresses, such as the <span class="emphasis"><em>To:</em></span> or
965 <span class="emphasis"><em>Cc:</em></span> prompt.  You can also enter aliases in your
966 editor at the appropriate headers if you have the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> variable set.
967 </p><p>
968 In addition, at the various address prompts, you can use the tab
969 character to expand a partial alias to the full alias.  If there are
970 multiple matches, Mutt will bring up a menu with the matching aliases.
971 In order to be presented with the full list of aliases, you must hit tab
972 without a partial alias, such as at the beginning of the prompt or after
973 a comma denoting multiple addresses.
974 </p><p>
975 In the alias menu, you can select as many aliases as you want with the
976 <code class="literal">select-entry</code> key (default: &lt;Return&gt;), and use
977 the <span class="emphasis"><em>exit</em></span> key (default: q) to return to the address
978 prompt.
979 </p></div><div class="sect1" title="5. Changing the Default Key Bindings"><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>   
980 <em class="replaceable"><code>map</code></em>
981    
982 <em class="replaceable"><code>key</code></em>
983    
984 <em class="replaceable"><code>function</code></em>
985  </p></div><p>
986 This command allows you to change the default key bindings (operation
987 invoked when pressing a key).
988 </p><p>
989 <span class="emphasis"><em>map</em></span> specifies in which menu the binding belongs.
990 Multiple maps may be specified by separating them with commas (no
991 additional whitespace is allowed). The currently defined maps are:
992 </p><a id="maps"></a><div class="variablelist"><dl><dt><span class="term">generic</span></dt><dd><p>
993 This is not a real menu, but is used as a fallback for all of the other
994 menus except for the pager and editor modes.  If a key is not defined in
995 another menu, Mutt will look for a binding to use in this menu.  This
996 allows you to bind a key to a certain function in multiple menus instead
997 of having multiple <span class="command"><strong>bind</strong></span> statements to accomplish the
998 same task.
999 </p></dd><dt><span class="term">alias</span></dt><dd><p>
1000 The alias menu is the list of your personal aliases as defined in your
1001 <code class="literal">.muttrc</code>.  It is the mapping from a short alias name
1002 to the full email address(es) of the recipient(s).
1003 </p></dd><dt><span class="term">attach</span></dt><dd><p>
1004 The attachment menu is used to access the attachments on received
1005 messages.
1006 </p></dd><dt><span class="term">browser</span></dt><dd><p>
1007 The browser is used for both browsing the local directory structure, and
1008 for listing all of your incoming mailboxes.
1009 </p></dd><dt><span class="term">editor</span></dt><dd><p>
1010 The editor is used to allow the user to enter a single line of text, such as
1011 the <span class="emphasis"><em>To</em></span> or <span class="emphasis"><em>Subject</em></span> prompts in the
1012 <code class="literal">compose</code> menu.
1013 </p></dd><dt><span class="term">index</span></dt><dd><p>
1014 The index is the list of messages contained in a mailbox.
1015 </p></dd><dt><span class="term">compose</span></dt><dd><p>
1016 The compose menu is the screen used when sending a new message.
1017 </p></dd><dt><span class="term">pager</span></dt><dd><p>
1018 The pager is the mode used to display message/attachment data, and help
1019 listings.
1020 </p></dd><dt><span class="term">pgp</span></dt><dd><p>
1021 The pgp menu is used to select the OpenPGP keys used to encrypt outgoing
1022 messages.
1023 </p></dd><dt><span class="term">smime</span></dt><dd><p>
1024 The smime menu is used to select the OpenSSL certificates used to
1025 encrypt outgoing messages.
1026 </p></dd><dt><span class="term">postpone</span></dt><dd><p>
1027 The postpone menu is similar to the index menu, except is used when
1028 recalling a message the user was composing, but saved until later.
1029 </p></dd><dt><span class="term">query</span></dt><dd><p>
1030 The query menu is the browser for results returned by <a class="link" href="#query-command" title="3.204. query_command">$query_command</a>.
1031 </p></dd><dt><span class="term">mix</span></dt><dd><p>
1032 The mixmaster screen is used to select remailer options for outgoing
1033 messages (if Mutt is compiled with Mixmaster support).
1034 </p></dd></dl></div><p>
1035 <span class="emphasis"><em>key</em></span> is the key (or key sequence) you wish to bind.
1036 To specify a control character, use the sequence
1037 <span class="emphasis"><em>\Cx</em></span>, where <span class="emphasis"><em>x</em></span> is the letter of
1038 the control character (for example, to specify control-A use
1039 <span class="quote">“<span class="quote">\Ca</span>”</span>).  Note that the case of <span class="emphasis"><em>x</em></span> as
1040 well as <span class="emphasis"><em>\C</em></span> is ignored, so that
1041 <span class="emphasis"><em>\CA</em></span>, <span class="emphasis"><em>\Ca</em></span>,
1042 <span class="emphasis"><em>\cA</em></span> and <span class="emphasis"><em>\ca</em></span> are all
1043 equivalent.  An alternative form is to specify the key as a three digit
1044 octal number prefixed with a <span class="quote">“<span class="quote">\</span>”</span> (for example
1045 <span class="emphasis"><em>\177</em></span> is equivalent to <span class="emphasis"><em>\c?</em></span>). In
1046 addition, <span class="emphasis"><em>key</em></span> may be a symbolic name as shown in
1047 <a class="xref" href="#tab-key-names" title="Table 3.1. Symbolic key names">Table 3.1, “Symbolic key names”</a>.
1048 </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>&lt;tab&gt;</td><td>tab</td></tr><tr><td>&lt;backtab&gt;</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>&lt;esc&gt;</td><td>escape</td></tr><tr><td>&lt;up&gt;</td><td>up arrow</td></tr><tr><td>&lt;down&gt;</td><td>down arrow</td></tr><tr><td>&lt;left&gt;</td><td>left arrow</td></tr><tr><td>&lt;right&gt;</td><td>right arrow</td></tr><tr><td>&lt;pageup&gt;</td><td>Page Up</td></tr><tr><td>&lt;pagedown&gt;</td><td>Page Down</td></tr><tr><td>&lt;backspace&gt;</td><td>Backspace</td></tr><tr><td>&lt;delete&gt;</td><td>Delete</td></tr><tr><td>&lt;insert&gt;</td><td>Insert</td></tr><tr><td>&lt;enter&gt;</td><td>Enter</td></tr><tr><td>&lt;return&gt;</td><td>Return</td></tr><tr><td>&lt;home&gt;</td><td>Home</td></tr><tr><td>&lt;end&gt;</td><td>End</td></tr><tr><td>&lt;space&gt;</td><td>Space bar</td></tr><tr><td>&lt;f1&gt;</td><td>function key 1</td></tr><tr><td>&lt;f10&gt;</td><td>function key 10</td></tr></tbody></table></div></div><br class="table-break" /><p>
1049 <span class="emphasis"><em>key</em></span> does not need to be enclosed in quotes unless
1050 it contains a space (<span class="quote">“<span class="quote"> </span>”</span>) or semi-colon
1051 (<span class="quote">“<span class="quote">;</span>”</span>).
1052 </p><p>
1053 <span class="emphasis"><em>function</em></span> specifies which action to take when
1054 <span class="emphasis"><em>key</em></span> is pressed.  For a complete list of functions,
1055 see the <a class="link" href="#functions" title="4. Functions">reference</a>. Note that the
1056 <span class="command"><strong>bind</strong></span> expects <span class="emphasis"><em>function</em></span> to be
1057 specified without angle brackets.
1058 </p><p>
1059 The special function <code class="literal">&lt;noop&gt;</code> unbinds the
1060 specified key sequence.
1061 </p></div><div class="sect1" title="6. Defining Aliases for Character Sets"><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>   
1062 <em class="replaceable"><code>alias</code></em>
1063    
1064 <em class="replaceable"><code>charset</code></em>
1065  <br /><code class="command">iconv-hook<a id="iconv-hook"></a></code>   
1066 <em class="replaceable"><code>charset</code></em>
1067    
1068 <em class="replaceable"><code>local-charset</code></em>
1069  </p></div><p>
1070 The <span class="command"><strong>charset-hook</strong></span> command defines an alias for a
1071 character set.  This is useful to properly display messages which are
1072 tagged with a character set name not known to Mutt.
1073 </p><p>
1074 The <span class="command"><strong>iconv-hook</strong></span> command defines a system-specific name
1075 for a character set.  This is helpful when your systems character
1076 conversion library insists on using strange, system-specific names for
1077 character sets.
1078 </p></div><div class="sect1" title="7. Setting Variables Based Upon Mailbox"><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>   
1079 <em class="replaceable"><code>[!]regexp</code></em>
1080    
1081 <em class="replaceable"><code>command</code></em>
1082  </p></div><p>
1083 It is often desirable to change settings based on which mailbox you are
1084 reading.  The <span class="command"><strong>folder-hook</strong></span> command provides a method
1085 by which you can execute any configuration command.
1086 <span class="emphasis"><em>regexp</em></span> is a regular expression specifying in which
1087 mailboxes to execute <span class="emphasis"><em>command</em></span> before loading.  If a
1088 mailbox matches multiple <span class="command"><strong>folder-hook</strong></span>s, they are
1089 executed in the order given in the <code class="literal">.muttrc</code>.
1090 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
1091 If you use the <span class="quote">“<span class="quote">!</span>”</span> shortcut for <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a> at the beginning of the pattern,
1092 you must place it inside of double or single quotes in order to
1093 distinguish it from the logical <span class="emphasis"><em>not</em></span> operator for
1094 the expression.
1095 </p></div><div class="note" title="Note"><h3 class="title">Note</h3><p>
1096 Settings are <span class="emphasis"><em>not</em></span> restored when you leave the
1097 mailbox.  For example, a command action to perform is to change the
1098 sorting method based upon the mailbox being read:
1099 </p><pre class="screen">
1100 folder-hook mutt "set sort=threads"</pre><p>
1101 However, the sorting method is not restored to its previous value when
1102 reading a different mailbox.  To specify a <span class="emphasis"><em>default</em></span>
1103 command, use the pattern <span class="quote">“<span class="quote">.</span>”</span> before other
1104 <span class="command"><strong>folder-hook</strong></span>s adjusting a value on a per-folder basis
1105 because <span class="command"><strong>folder-hook</strong></span>s are evaluated in the order given
1106 in the configuration file.
1107 </p></div><p>
1108 The following example will set the <a class="link" href="#sort" title="3.264. sort">sort</a>
1109 variable to <code class="literal">date-sent</code> for all folders but to
1110 <code class="literal">threads</code> for all folders containing
1111 <span class="quote">“<span class="quote">mutt</span>”</span> in their name.
1112 </p><div class="example"><a id="ex-folder-sorting"></a><p class="title"><b>Example 3.8. Setting sort method based on mailbox name</b></p><div class="example-contents"><pre class="screen">
1113 folder-hook . "set sort=date-sent"
1114 folder-hook mutt "set sort=threads"
1115 </pre></div></div><br class="example-break" /></div><div class="sect1" title="8. Keyboard Macros"><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>   
1116 <em class="replaceable"><code>menu</code></em>
1117    
1118 <em class="replaceable"><code>key</code></em>
1119    
1120 <em class="replaceable"><code>sequence</code></em>
1121   [
1122 <em class="replaceable"><code>description</code></em>
1123 ]</p></div><p>
1124 Macros are useful when you would like a single key to perform a series
1125 of actions.  When you press <span class="emphasis"><em>key</em></span> in menu
1126 <span class="emphasis"><em>menu</em></span>, Mutt will behave as if you had typed
1127 <span class="emphasis"><em>sequence</em></span>.  So if you have a common sequence of
1128 commands you type, you can create a macro to execute those commands with
1129 a single key or fewer keys.
1130 </p><p>
1131 <span class="emphasis"><em>menu</em></span> is the <a class="link" href="#maps">map</a> which
1132 the macro will be bound in.  Multiple maps may be specified by
1133 separating multiple menu arguments by commas. Whitespace may not be used
1134 in between the menu arguments and the commas separating them.
1135 </p><p>
1136 <span class="emphasis"><em>key</em></span> and <span class="emphasis"><em>sequence</em></span> are expanded
1137 by the same rules as the <a class="link" href="#bind" title="5. Changing the Default Key Bindings">key bindings</a> with
1138 some additions.  The first is that control characters in
1139 <span class="emphasis"><em>sequence</em></span> can also be specified as
1140 <span class="emphasis"><em>^x</em></span>.  In order to get a caret (<span class="quote">“<span class="quote">^</span>”</span>) you
1141 need to use <span class="emphasis"><em>^^</em></span>.  Secondly, to specify a certain key
1142 such as <span class="emphasis"><em>up</em></span> or to invoke a function directly, you
1143 can use the format <span class="emphasis"><em>&lt;key name&gt;</em></span> and
1144 <span class="emphasis"><em>&lt;function name&gt;</em></span>.  For a listing of key names
1145 see the section on <a class="link" href="#bind" title="5. Changing the Default Key Bindings">key bindings</a>.  Functions
1146 are listed in the <a class="link" href="#functions" title="4. Functions">reference</a>.
1147 </p><p>
1148 The advantage with using function names directly is that the macros will
1149 work regardless of the current key bindings, so they are not dependent
1150 on the user having particular key definitions.  This makes them more
1151 robust and portable, and also facilitates defining of macros in files
1152 used by more than one user (e.g., the system Muttrc).
1153 </p><p>
1154 Optionally you can specify a descriptive text after
1155 <span class="emphasis"><em>sequence</em></span>, which is shown in the help screens if
1156 they contain a description.
1157 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
1158 Macro definitions (if any) listed in the help screen(s), are
1159 silently truncated at the screen width, and are not wrapped.
1160 </p></div></div><div class="sect1" title="9. Using Color and Mono Video Attributes"><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>   
1161 <em class="replaceable"><code>object</code></em>
1162    
1163 <em class="replaceable"><code>foreground</code></em>
1164    
1165 <em class="replaceable"><code>background</code></em>
1166  <br /><code class="command">color</code>  { 
1167 <code class="option">header</code>
1168   |   
1169 <code class="option">body</code>
1170  }  
1171 <em class="replaceable"><code>foreground</code></em>
1172    
1173 <em class="replaceable"><code>background</code></em>
1174    
1175 <em class="replaceable"><code>regexp</code></em>
1176  <br /><code class="command">color</code>   
1177 <code class="option">index</code>
1178    
1179 <em class="replaceable"><code>foreground</code></em>
1180    
1181 <em class="replaceable"><code>background</code></em>
1182    
1183 <em class="replaceable"><code>pattern</code></em>
1184  <br /><code class="command">uncolor</code>  { 
1185 <code class="option">index</code>
1186   |   
1187 <code class="option">header</code>
1188   |   
1189 <code class="option">body</code>
1190  } { 
1191 <em class="replaceable"><code>*</code></em>
1192   |   
1193 <em class="replaceable"><code>pattern</code></em>
1194 ... }</p></div><p>
1195 If your terminal supports color, you can spice up Mutt by creating your
1196 own color scheme.  To define the color of an object (type of
1197 information), you must specify both a foreground color
1198 <span class="emphasis"><em>and</em></span> a background color (it is not possible to only
1199 specify one or the other).
1200 </p><p>
1201 <span class="emphasis"><em>header</em></span> and <span class="emphasis"><em>body</em></span> match
1202 <span class="emphasis"><em>regexp</em></span> in the header/body of a message,
1203 <span class="emphasis"><em>index</em></span> matches <span class="emphasis"><em>pattern</em></span> (see
1204 <a class="xref" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">Section 3, “Patterns: Searching, Limiting and Tagging”</a>) in the message index.
1205 </p><p>
1206 <span class="emphasis"><em>object</em></span> can be one of:
1207 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>attachment</p></li><li class="listitem"><p>bold (highlighting bold patterns in the body of messages)</p></li><li class="listitem"><p>error (error messages printed by Mutt)</p></li><li class="listitem"><p>hdrdefault (default color of the message header in the pager)</p></li><li class="listitem"><p>indicator (arrow or bar used to indicate the current item in a menu)</p></li><li class="listitem"><p>markers (the <span class="quote">“<span class="quote">+</span>”</span> markers at the beginning of wrapped lines in the pager)</p></li><li class="listitem"><p>message (informational messages)</p></li><li class="listitem"><p>normal</p></li><li class="listitem"><p>quoted (text matching <a class="link" href="#quote-regexp" title="3.207. quote_regexp">$quote_regexp</a> in the body of a message)</p></li><li class="listitem"><p>quoted1, quoted2, ..., quoted<span class="emphasis"><em>N</em></span> (higher levels of quoting)</p></li><li class="listitem"><p>search (highlighting of words in the pager)</p></li><li class="listitem"><p>signature</p></li><li class="listitem"><p>status (mode lines used to display info about the mailbox or message)</p></li><li class="listitem"><p>tilde (the <span class="quote">“<span class="quote">~</span>”</span> used to pad blank lines in the pager)</p></li><li class="listitem"><p>tree (thread tree drawn in the message index and attachment menu)</p></li><li class="listitem"><p>underline (highlighting underlined patterns in the body of messages)</p></li></ul></div><p>
1208 <span class="emphasis"><em>foreground</em></span> and <span class="emphasis"><em>background</em></span> can
1209 be one of the following:
1210 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>white</p></li><li class="listitem"><p>black</p></li><li class="listitem"><p>green</p></li><li class="listitem"><p>magenta</p></li><li class="listitem"><p>blue</p></li><li class="listitem"><p>cyan</p></li><li class="listitem"><p>yellow</p></li><li class="listitem"><p>red</p></li><li class="listitem"><p>default</p></li><li class="listitem"><p>color<span class="emphasis"><em>x</em></span></p></li></ul></div><p>
1211 <span class="emphasis"><em>foreground</em></span> can optionally be prefixed with the
1212 keyword <code class="literal">bright</code> to make the foreground color boldfaced
1213 (e.g., <code class="literal">brightred</code>).
1214 </p><p>
1215 If your terminal supports it, the special keyword
1216 <span class="emphasis"><em>default</em></span> can be used as a transparent color.  The
1217 value <span class="emphasis"><em>brightdefault</em></span> is also valid.  If Mutt is
1218 linked against the <span class="emphasis"><em>S-Lang</em></span> library, you also need to
1219 set the <code class="literal">$COLORFGBG</code> environment variable to the
1220 default colors of your terminal for this to work; for example (for
1221 Bourne-like shells):
1222 </p><pre class="screen">
1223 set COLORFGBG="green;black"
1224 export COLORFGBG
1225 </pre><div class="note" title="Note"><h3 class="title">Note</h3><p>
1226 The <span class="emphasis"><em>S-Lang</em></span> library requires you to use the
1227 <span class="emphasis"><em>lightgray</em></span> and <span class="emphasis"><em>brown</em></span> keywords
1228 instead of <span class="emphasis"><em>white</em></span> and <span class="emphasis"><em>yellow</em></span>
1229 when setting this variable.
1230 </p></div><div class="note" title="Note"><h3 class="title">Note</h3><p>
1231 The <span class="command"><strong>uncolor</strong></span> command can be applied to the index,
1232 header and body objects only.  It removes entries from the list. You
1233 <span class="emphasis"><em>must</em></span> specify the same pattern specified in the
1234 <span class="command"><strong>color</strong></span> command for it to be removed.  The pattern
1235 <span class="quote">“<span class="quote">*</span>”</span> is a special token which means to clear the color list
1236 of all entries.
1237 </p></div><p>
1238 Mutt also recognizes the keywords <span class="emphasis"><em>color0</em></span>,
1239 <span class="emphasis"><em>color1</em></span>, ...,
1240 <span class="emphasis"><em>color</em></span><span class="emphasis"><em>N-1</em></span>
1241 (<span class="emphasis"><em>N</em></span> being the number of colors supported by your
1242 terminal).  This is useful when you remap the colors for your display
1243 (for example by changing the color associated with
1244 <span class="emphasis"><em>color2</em></span> for your xterm), since color names may then
1245 lose their normal meaning.
1246 </p><a id="mono"></a><p>
1247 If your terminal does not support color, it is still possible change the
1248 video attributes through the use of the <span class="quote">“<span class="quote">mono</span>”</span>
1249 command. Usage:
1250 </p><div class="cmdsynopsis"><p><code class="command">mono</code>   
1251 <em class="replaceable"><code>object</code></em>
1252    
1253 <em class="replaceable"><code>attribute</code></em>
1254  <br /><code class="command">mono</code>  { 
1255 <code class="option">header</code>
1256   |   
1257 <code class="option">body</code>
1258  }  
1259 <em class="replaceable"><code>attribute</code></em>
1260    
1261 <em class="replaceable"><code>regexp</code></em>
1262  <br /><code class="command">mono</code>   
1263 <code class="option">index</code>
1264    
1265 <em class="replaceable"><code>attribute</code></em>
1266    
1267 <em class="replaceable"><code>pattern</code></em>
1268  <br /><code class="command">unmono</code>  { 
1269 <code class="option">index</code>
1270   |   
1271 <code class="option">header</code>
1272   |   
1273 <code class="option">body</code>
1274  } { 
1275 <em class="replaceable"><code>*</code></em>
1276   |   
1277 <em class="replaceable"><code>pattern</code></em>
1278 ... }</p></div><p>
1279 For <span class="emphasis"><em>object</em></span>, see the <span class="command"><strong>color</strong></span>
1280 command. <span class="emphasis"><em>attribute</em></span> can be one of the following:
1281 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>none</p></li><li class="listitem"><p>bold</p></li><li class="listitem"><p>underline</p></li><li class="listitem"><p>reverse</p></li><li class="listitem"><p>standout</p></li></ul></div></div><div class="sect1" title="10. Message Header Display"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="msg-hdr-display"></a>10. Message Header Display</h2></div></div></div><div class="sect2" title="10.1. Header Display"><div class="titlepage"><div><div><h3 class="title"><a id="hdr-folding"></a>10.1. Header Display</h3></div></div></div><p>
1282 When displaying a message in the pager, Mutt folds long header lines at
1283 <a class="link" href="#wrap" title="3.307. wrap">$wrap</a> columns. Though there're precise rules
1284 about where to break and how, Mutt always folds headers using a tab for
1285 readability. (Note that the sending side is not affected by this, Mutt
1286 tries to implement standards compliant folding.)
1287 </p></div><div class="sect2" title="10.2. Selecting Headers"><div class="titlepage"><div><div><h3 class="title"><a id="ignore"></a>10.2. Selecting Headers</h3></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">ignore</code>   
1288 <em class="replaceable"><code>pattern</code></em>
1289   [
1290 <em class="replaceable"><code>pattern</code></em>
1291 ...]<br /><code class="command">unignore</code>  { 
1292 <em class="replaceable"><code>*</code></em>
1293   |   
1294 <em class="replaceable"><code>pattern</code></em>
1295 ... }</p></div><p>
1296 Messages often have many header fields added by automatic processing
1297 systems, or which may not seem useful to display on the screen.  This
1298 command allows you to specify header fields which you don't normally
1299 want to see in the pager.
1300 </p><p>
1301 You do not need to specify the full header field name.  For example,
1302 <span class="quote">“<span class="quote">ignore content-</span>”</span> will ignore all header fields that begin
1303 with the pattern <span class="quote">“<span class="quote">content-</span>”</span>. <span class="quote">“<span class="quote">ignore *</span>”</span> will
1304 ignore all headers.
1305 </p><p>
1306 To remove a previously added token from the list, use the
1307 <span class="quote">“<span class="quote">unignore</span>”</span> command.  The <span class="quote">“<span class="quote">unignore</span>”</span> command
1308 will make Mutt display headers with the given pattern.  For example, if
1309 you do <span class="quote">“<span class="quote">ignore x-</span>”</span> it is possible to <span class="quote">“<span class="quote">unignore
1310 x-mailer</span>”</span>.
1311 </p><p>
1312 <span class="quote">“<span class="quote">unignore *</span>”</span> will remove all tokens from the ignore list.
1313 </p><div class="example"><a id="ex-header-weeding"></a><p class="title"><b>Example 3.9. Header weeding</b></p><div class="example-contents"><pre class="screen">
1314 <span class="comment"># Sven's draconian header weeding</span>
1315 ignore *
1316 unignore from date subject to cc
1317 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
1318 unignore posted-to:
1319 </pre></div></div><br class="example-break" /></div><div class="sect2" title="10.3. Ordering Displayed Headers"><div class="titlepage"><div><div><h3 class="title"><a id="hdr-order"></a>10.3. Ordering Displayed Headers</h3></div></div></div><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">hdr_order</code>   
1320 <em class="replaceable"><code>header</code></em>
1321   [
1322 <em class="replaceable"><code>header</code></em>
1323 ...]<br /><code class="command">unhdr_order</code>  { 
1324 <em class="replaceable"><code>*</code></em>
1325   |   
1326 <em class="replaceable"><code>header</code></em>
1327 ... }</p></div><p>
1328 With the <span class="command"><strong>hdr_order</strong></span> command you can specify an order
1329 in which Mutt will attempt to present these headers to you when viewing
1330 messages.
1331 </p><p>
1332 <span class="quote">“<span class="quote"><span class="command"><strong>unhdr_order</strong></span> *</span>”</span> will clear all previous
1333 headers from the order list, thus removing the header order effects set
1334 by the system-wide startup file.
1335 </p><div class="example"><a id="ex-hdr-order"></a><p class="title"><b>Example 3.10. Configuring header display order</b></p><div class="example-contents"><pre class="screen">
1336 hdr_order From Date: From: To: Cc: Subject:
1337 </pre></div></div><br class="example-break" /></div></div><div class="sect1" title="11. Alternative Addresses"><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>  [
1338 <code class="option">-group</code>
1339 <em class="replaceable"><code>name</code></em>
1340 ...]  
1341 <em class="replaceable"><code>regexp</code></em>
1342   [
1343 <em class="replaceable"><code>regexp</code></em>
1344 ...]<br /><code class="command">unalternates</code>  [
1345 <code class="option">-group</code>
1346 <em class="replaceable"><code>name</code></em>
1347 ...] { 
1348 <em class="replaceable"><code>*</code></em>
1349   |   
1350 <em class="replaceable"><code>regexp</code></em>
1351 ... }</p></div><p>
1352 With various functions, Mutt will treat messages differently, depending
1353 on whether you sent them or whether you received them from someone else.
1354 For instance, when replying to a message that you sent to a different
1355 party, Mutt will automatically suggest to send the response to the
1356 original message's recipients — responding to yourself won't make
1357 much sense in many cases.  (See <a class="link" href="#reply-to" title="3.215. reply_to">$reply_to</a>.)
1358 </p><p>
1359 Many users receive e-mail under a number of different addresses. To
1360 fully use Mutt's features here, the program must be able to recognize
1361 what e-mail addresses you receive mail under. That's the purpose of the
1362 <span class="command"><strong>alternates</strong></span> command: It takes a list of regular
1363 expressions, each of which can identify an address under which you
1364 receive e-mail.
1365 </p><p>
1366 As addresses are matched using regular expressions and not exact strict
1367 comparisons, you should make sure you specify your addresses as precise
1368 as possible to avoid mismatches. For example, if you specify:
1369 </p><pre class="screen">
1370 alternates user@example
1371 </pre><p>
1372 Mutt will consider <span class="quote">“<span class="quote"><code class="literal">some-user@example</code></span>”</span>
1373 as being your address, too which may not be desired. As a solution, in
1374 such cases addresses should be specified as:
1375 </p><pre class="screen">
1376 alternates '^user@example$'
1377 </pre><p>
1378 The <code class="literal">-group</code> flag causes all of the subsequent regular
1379 expressions to be added to the named group.
1380 </p><p>
1381 The <span class="command"><strong>unalternates</strong></span> command can be used to write
1382 exceptions to <span class="command"><strong>alternates</strong></span> patterns. If an address
1383 matches something in an <span class="command"><strong>alternates</strong></span> command, but you
1384 nonetheless do not think it is from you, you can list a more precise
1385 pattern under an <span class="command"><strong>unalternates</strong></span> command.
1386 </p><p>
1387 To remove a regular expression from the <span class="command"><strong>alternates</strong></span>
1388 list, use the <span class="command"><strong>unalternates</strong></span> command with exactly the
1389 same <span class="emphasis"><em>regexp</em></span>.  Likewise, if the
1390 <span class="emphasis"><em>regexp</em></span> for an <span class="command"><strong>alternates</strong></span> command
1391 matches an entry on the <span class="command"><strong>unalternates</strong></span> list, that
1392 <span class="command"><strong>unalternates</strong></span> entry will be removed. If the
1393 <span class="emphasis"><em>regexp</em></span> for <span class="command"><strong>unalternates</strong></span> is
1394 <span class="quote">“<span class="quote">*</span>”</span>, <span class="emphasis"><em>all entries</em></span> on
1395 <span class="command"><strong>alternates</strong></span> will be removed.
1396 </p></div><div class="sect1" title="12. Mailing Lists"><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>  [
1397 <code class="option">-group</code>
1398 <em class="replaceable"><code>name</code></em>
1399 ...]  
1400 <em class="replaceable"><code>regexp</code></em>
1401   [
1402 <em class="replaceable"><code>regexp</code></em>
1403 ...]<br /><code class="command">unlists</code>  { 
1404 <em class="replaceable"><code>*</code></em>
1405   |   
1406 <em class="replaceable"><code>regexp</code></em>
1407 ... }<br /><code class="command">subscribe</code>  [
1408 <code class="option">-group</code>
1409 <em class="replaceable"><code>name</code></em>
1410 ...]  
1411 <em class="replaceable"><code>regexp</code></em>
1412   [
1413 <em class="replaceable"><code>regexp</code></em>
1414 ...]<br /><code class="command">unsubscribe</code>  { 
1415 <em class="replaceable"><code>*</code></em>
1416   |   
1417 <em class="replaceable"><code>regexp</code></em>
1418 ... }</p></div><p>
1419 Mutt has a few nice features for <a class="link" href="#using-lists" title="9. Handling Mailing Lists">handling
1420 mailing lists</a>.  In order to take advantage of them, you must
1421 specify which addresses belong to mailing lists, and which mailing lists
1422 you are subscribed to. Mutt also has limited support for auto-detecting
1423 mailing lists: it supports parsing <code class="literal">mailto:</code> links in
1424 the common <code class="literal">List-Post:</code> header which has the same
1425 effect as specifying the list address via the <span class="command"><strong>lists</strong></span>
1426 command (except the group feature). Once you have done this, the <a class="link" href="#list-reply"><code class="literal">&lt;list-reply&gt;</code></a>
1427 function will work for all known lists.  Additionally, when you send a
1428 message to a subscribed list, Mutt will add a Mail-Followup-To header to
1429 tell other users' mail user agents not to send copies of replies to your
1430 personal address.
1431 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
1432 The Mail-Followup-To header is a non-standard extension which is not
1433 supported by all mail user agents.  Adding it is not bullet-proof
1434 against receiving personal CCs of list messages.  Also note that the
1435 generation of the Mail-Followup-To header is controlled by the <a class="link" href="#followup-to" title="3.68. followup_to">$followup_to</a> configuration variable since
1436 it's common practice on some mailing lists to send Cc upon replies
1437 (which is more a group- than a list-reply).
1438 </p></div><p>
1439 More precisely, Mutt maintains lists of patterns for the addresses of
1440 known and subscribed mailing lists.  Every subscribed mailing list is
1441 known. To mark a mailing list as known, use the <span class="command"><strong>list</strong></span>
1442 command.  To mark it as subscribed, use <span class="command"><strong>subscribe</strong></span>.
1443 </p><p>
1444 You can use regular expressions with both commands. To mark all messages
1445 sent to a specific bug report's address on Debian's bug tracking system
1446 as list mail, for instance, you could say
1447 </p><pre class="screen">
1448 subscribe [0-9]*.*@bugs.debian.org</pre><p>
1449 as it's often sufficient to just give a portion of the list's e-mail
1450 address.
1451 </p><p>
1452 Specify as much of the address as you need to to remove ambiguity.  For
1453 example, if you've subscribed to the Mutt mailing list, you will receive
1454 mail addressed to <code class="literal">mutt-users@mutt.org</code>.  So, to tell
1455 Mutt that this is a mailing list, you could add <code class="literal">lists
1456 mutt-users@</code> to your initialization file.  To tell Mutt that
1457 you are subscribed to it, add <code class="literal"><span class="command"><strong>subscribe</strong></span>
1458 mutt-users</code> to your initialization file instead.  If you also
1459 happen to get mail from someone whose address is
1460 <code class="literal">mutt-users@example.com</code>, you could use
1461 <code class="literal"><span class="command"><strong>lists</strong></span> ^mutt-users@mutt\\.org$</code> or
1462 <code class="literal"><span class="command"><strong>subscribe</strong></span> ^mutt-users@mutt\\.org$</code>
1463 to match only mail from the actual list.
1464 </p><p>
1465 The <code class="literal">-group</code> flag adds all of the subsequent regular
1466 expressions to the named <a class="link" href="#addrgroup" title="3. Address Groups">address group</a>
1467 in addition to adding to the specified address list.
1468 </p><p>
1469 The <span class="quote">“<span class="quote">unlists</span>”</span> command is used to remove a token from the
1470 list of known and subscribed mailing-lists. Use <span class="quote">“<span class="quote">unlists *</span>”</span>
1471 to remove all tokens.
1472 </p><p>
1473 To remove a mailing list from the list of subscribed mailing lists, but
1474 keep it on the list of known mailing lists, use
1475 <span class="command"><strong>unsubscribe</strong></span>.
1476 </p></div><div class="sect1" title="13. Using Multiple Spool Mailboxes"><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>   
1477 <em class="replaceable"><code>[!]pattern</code></em>
1478    
1479 <em class="replaceable"><code>mailbox</code></em>
1480  </p></div><p>
1481 This command is used to move read messages from a specified mailbox to a
1482 different mailbox automatically when you quit or change folders.
1483 <span class="emphasis"><em>pattern</em></span> is a regular expression specifying the
1484 mailbox to treat as a <span class="quote">“<span class="quote">spool</span>”</span> mailbox and
1485 <span class="emphasis"><em>mailbox</em></span> specifies where mail should be saved when
1486 read.
1487 </p><p>
1488 Unlike some of the other <span class="emphasis"><em>hook</em></span> commands, only the
1489 <span class="emphasis"><em>first</em></span> matching pattern is used (it is not possible
1490 to save read mail in more than a single mailbox).
1491 </p></div><div class="sect1" title="14. Monitoring Incoming Mail"><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>   
1492 <em class="replaceable"><code>mailbox</code></em>
1493   [
1494 <em class="replaceable"><code>mailbox</code></em>
1495 ...]<br /><code class="command">unmailboxes</code>  { 
1496 <em class="replaceable"><code>*</code></em>
1497   |   
1498 <em class="replaceable"><code>mailbox</code></em>
1499 ... }</p></div><p>
1500 This command specifies folders which can receive mail and which will be
1501 checked for new messages periodically.
1502 </p><p>
1503 <span class="emphasis"><em>folder</em></span> can either be a local file or directory
1504 (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
1505 support, <span class="emphasis"><em>folder</em></span> can also be a POP/IMAP folder
1506 URL. The URL syntax is described in <a class="xref" href="#url-syntax" title="1.2. URL Syntax">Section 1.2, “URL Syntax”</a>, POP
1507 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> respectively.
1508 </p><p>
1509 Mutt provides a number of advanced features for handling (possibly many)
1510 folders and new mail within them, please refer to <a class="xref" href="#new-mail" title="10. New Mail Detection">Section 10, “New Mail Detection”</a> for details (including in what situations and how
1511 often Mutt checks for new mail).
1512 </p><p>
1513 The <span class="quote">“<span class="quote">unmailboxes</span>”</span> command is used to remove a token from
1514 the list of folders which receive mail. Use <span class="quote">“<span class="quote">unmailboxes *</span>”</span>
1515 to remove all tokens.
1516 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
1517 The folders in the <span class="command"><strong>mailboxes</strong></span> command are resolved
1518 when the command is executed, so if these names contain <a class="link" href="#shortcuts" title="8. Mailbox Shortcuts">shortcut characters</a> (such as <span class="quote">“<span class="quote">=</span>”</span>
1519 and <span class="quote">“<span class="quote">!</span>”</span>), any variable definition that affects these
1520 characters (like <a class="link" href="#folder" title="3.66. folder">$folder</a> and <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a>) should be set before the
1521 <span class="command"><strong>mailboxes</strong></span> command. If none of these shortcuts are
1522 used, a local path should be absolute as otherwise Mutt tries to find it
1523 relative to the directory from where Mutt was started which may not
1524 always be desired.
1525 </p></div></div><div class="sect1" title="15. User-Defined Headers"><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>   
1526 <em class="replaceable"><code>string</code></em>
1527  <br /><code class="command">unmy_hdr</code>  { 
1528 <em class="replaceable"><code>*</code></em>
1529   |   
1530 <em class="replaceable"><code>field</code></em>
1531 ... }</p></div><p>
1532 The <span class="command"><strong>my_hdr</strong></span> command allows you to create your own
1533 header fields which will be added to every message you send and appear
1534 in the editor if <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> is
1535 set.
1536 </p><p>
1537 For example, if you would like to add an <span class="quote">“<span class="quote">Organization:</span>”</span>
1538 header field to all of your outgoing messages, you can put the command
1539 something like shown in <a class="xref" href="#ex-my-hdr" title="Example 3.11. Defining custom headers">Example 3.11, “Defining custom headers”</a> in your
1540 <code class="literal">.muttrc</code>.
1541 </p><div class="example"><a id="ex-my-hdr"></a><p class="title"><b>Example 3.11. Defining custom headers</b></p><div class="example-contents"><pre class="screen">
1542 my_hdr Organization: A Really Big Company, Anytown, USA
1543 </pre></div></div><br class="example-break" /><div class="note" title="Note"><h3 class="title">Note</h3><p>
1544 Space characters are <span class="emphasis"><em>not</em></span> allowed between the
1545 keyword and the colon (<span class="quote">“<span class="quote">:</span>”</span>). The standard for electronic
1546 mail (RFC2822) says that space is illegal there, so Mutt enforces the
1547 rule.
1548 </p></div><p>
1549 If you would like to add a header field to a single message, you should
1550 either set the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a>
1551 variable, or use the <code class="literal">&lt;edit-headers&gt;</code> function
1552 (default: <span class="quote">“<span class="quote">E</span>”</span>) in the compose menu so that you can edit the
1553 header of your message along with the body.
1554 </p><p>
1555 To remove user defined header fields, use the
1556 <span class="command"><strong>unmy_hdr</strong></span> command. You may specify an asterisk
1557 (<span class="quote">“<span class="quote">*</span>”</span>) to remove all header fields, or the fields to
1558 remove. For example, to remove all <span class="quote">“<span class="quote">To</span>”</span> and
1559 <span class="quote">“<span class="quote">Cc</span>”</span> header fields, you could use:
1560 </p><pre class="screen">
1561 unmy_hdr to cc
1562 </pre></div><div class="sect1" title="16. Specify Default Save Mailbox"><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>   
1563 <em class="replaceable"><code>[!]pattern</code></em>
1564    
1565 <em class="replaceable"><code>mailbox</code></em>
1566  </p></div><p>
1567 This command is used to override the default mailbox used when saving
1568 messages. <span class="emphasis"><em>mailbox</em></span> will be used as the default if
1569 the message matches <span class="emphasis"><em>pattern</em></span>, see <a class="xref" href="#pattern-hook" title="5.1. Message Matching in Hooks">Message Matching in Hooks</a> for information on the exact format.
1570 </p><p>
1571 To provide more flexibility and good defaults, Mutt applies the expandos
1572 of <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to
1573 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1574 </p><div class="example"><a id="ex-save-hook-exando"></a><p class="title"><b>Example 3.12. Using %-expandos in <span class="command">save-hook</span></b></p><div class="example-contents"><pre class="screen">
1575 <span class="comment"># default: save all to ~/Mail/&lt;author name&gt;</span>
1576 save-hook . ~/Mail/%F
1577
1578 <span class="comment"># save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins</span>
1579 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
1580
1581 <span class="comment"># save from aol.com to $folder/spam</span>
1582 save-hook aol\\.com$ +spam
1583 </pre></div></div><br class="example-break" /><p>
1584 Also see the <a class="link" href="#fcc-save-hook" title="18. Specify Default Save Filename and Default Fcc: Mailbox at Once"><span class="command"><strong>fcc-save-hook</strong></span></a> command.
1585 </p></div><div class="sect1" title="17. Specify Default Fcc: Mailbox When Composing"><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>   
1586 <em class="replaceable"><code>[!]pattern</code></em>
1587    
1588 <em class="replaceable"><code>mailbox</code></em>
1589  </p></div><p>
1590 This command is used to save outgoing mail in a mailbox other than <a class="link" href="#record" title="3.212. record">$record</a>.  Mutt searches the initial list of
1591 message recipients for the first matching <span class="emphasis"><em>regexp</em></span>
1592 and uses <span class="emphasis"><em>mailbox</em></span> as the default Fcc: mailbox.  If
1593 no match is found the message will be saved to <a class="link" href="#record" title="3.212. record">$record</a> mailbox.
1594 </p><p>
1595 To provide more flexibility and good defaults, Mutt applies the
1596 expandos of <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to
1597 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1598 </p><p>
1599 See <a class="xref" href="#pattern-hook" title="5.1. Message Matching in Hooks">Message Matching in Hooks</a> for information on the exact format
1600 of <span class="emphasis"><em>pattern</em></span>.
1601 </p><pre class="screen">fcc-hook [@.]aol\\.com$ +spammers</pre><p>
1602 ...will save a copy of all messages going to the aol.com domain to the
1603 `+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"><span class="command"><strong>fcc-save-hook</strong></span></a> command.
1604 </p></div><div class="sect1" title="18. Specify Default Save Filename and Default Fcc: Mailbox at Once"><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>   
1605 <em class="replaceable"><code>[!]pattern</code></em>
1606    
1607 <em class="replaceable"><code>mailbox</code></em>
1608  </p></div><p>
1609 This command is a shortcut, equivalent to doing both a <a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing"><span class="command"><strong>fcc-hook</strong></span></a> and a <a class="link" href="#save-hook" title="16. Specify Default Save Mailbox"><span class="command"><strong>save-hook</strong></span></a> with its
1610 arguments, including %-expansion on <span class="emphasis"><em>mailbox</em></span>
1611 according to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.
1612 </p></div><div class="sect1" title="19. Change Settings Based Upon Message Recipients"><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>   
1613 <em class="replaceable"><code>[!]pattern</code></em>
1614    
1615 <em class="replaceable"><code>command</code></em>
1616  <br /><code class="command">send-hook</code>   
1617 <em class="replaceable"><code>[!]pattern</code></em>
1618    
1619 <em class="replaceable"><code>command</code></em>
1620  <br /><code class="command">send2-hook</code>   
1621 <em class="replaceable"><code>[!]pattern</code></em>
1622    
1623 <em class="replaceable"><code>command</code></em>
1624  </p></div><p>
1625 These commands can be used to execute arbitrary configuration commands
1626 based upon recipients of the message.  <span class="emphasis"><em>pattern</em></span> is
1627 used to match the message, see <a class="xref" href="#pattern-hook" title="5.1. Message Matching in Hooks">Message Matching in Hooks</a> for
1628 details. <span class="emphasis"><em>command</em></span> is executed when
1629 <span class="emphasis"><em>pattern</em></span> matches.
1630 </p><p>
1631 <span class="command"><strong>reply-hook</strong></span> is matched against the message you are
1632 <span class="emphasis"><em>replying to</em></span>, instead of the message you are
1633 <span class="emphasis"><em>sending</em></span>.  <span class="command"><strong>send-hook</strong></span> is matched
1634 against all messages, both <span class="emphasis"><em>new</em></span> and
1635 <span class="emphasis"><em>replies</em></span>.
1636 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
1637 <span class="command"><strong>reply-hook</strong></span>s are matched <span class="emphasis"><em>before</em></span>
1638 the <span class="command"><strong>send-hook</strong></span>, <span class="emphasis"><em>regardless</em></span> of the
1639 order specified in the user's configuration file.
1640 </p></div><p>
1641 <span class="command"><strong>send2-hook</strong></span> is matched every time a message is
1642 changed, either by editing it, or by using the compose menu to change
1643 its recipients or subject.  <span class="command"><strong>send2-hook</strong></span> is executed
1644 after <span class="command"><strong>send-hook</strong></span>, and can, e.g., be used to set
1645 parameters such as the <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a>
1646 variable depending on the message's sender address.
1647 </p><p>
1648 For each type of <span class="command"><strong>send-hook</strong></span> or
1649 <span class="command"><strong>reply-hook</strong></span>, when multiple matches occur, commands are
1650 executed in the order they are specified in the
1651 <code class="literal">.muttrc</code> (for that type of hook).
1652 </p><p>
1653 Example: <code class="literal"><span class="command"><strong>send-hook</strong></span> mutt
1654 "<span class="command"><strong>set</strong></span> mime_forward signature=''"</code>
1655 </p><p>
1656 Another typical use for this command is to change the values of the
1657 <a class="link" href="#attribution" title="3.16. attribution">$attribution</a>, <a class="link" href="#signature" title="3.236. signature">$signature</a> and <a class="link" href="#locale" title="3.117. locale">$locale</a> variables in order to change the
1658 language of the attributions and signatures based upon the recipients.
1659 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
1660 <span class="command"><strong>send-hook</strong></span>'s are only executed once after getting the
1661 initial list of recipients.  Adding a recipient after replying or
1662 editing the message will not cause any <span class="command"><strong>send-hook</strong></span> to
1663 be executed, similarly if <a class="link" href="#autoedit" title="3.18. autoedit">$autoedit</a> is
1664 set (as then the initial list of recipients is empty). Also note that
1665 <a class="link" href="#my-hdr" title="15. User-Defined Headers"><span class="command"><strong>my_hdr</strong></span></a> commands which
1666 modify recipient headers, or the message's subject, don't have any
1667 effect on the current message when executed from a
1668 <span class="command"><strong>send-hook</strong></span>.
1669 </p></div></div><div class="sect1" title="20. Change Settings Before Formatting a Message"><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>   
1670 <em class="replaceable"><code>[!]pattern</code></em>
1671    
1672 <em class="replaceable"><code>command</code></em>
1673  </p></div><p>
1674 This command can be used to execute arbitrary configuration commands
1675 before viewing or formatting a message based upon information about the
1676 message.  <span class="emphasis"><em>command</em></span> is executed if the
1677 <span class="emphasis"><em>pattern</em></span> matches the message to be displayed. When
1678 multiple matches occur, commands are executed in the order they are
1679 specified in the <code class="literal">.muttrc</code>.
1680 </p><p>
1681 See <a class="xref" href="#pattern-hook" title="5.1. Message Matching in Hooks">Message Matching in Hooks</a> for information on the exact format
1682 of <span class="emphasis"><em>pattern</em></span>.
1683 </p><p>
1684 Example:
1685 </p><pre class="screen">
1686 message-hook ~A 'set pager=builtin'
1687 message-hook '~f freshmeat-news' 'set pager="less \"+/^  subject: .*\""'
1688 </pre></div><div class="sect1" title="21. Choosing the Cryptographic Key of the Recipient"><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>   
1689 <em class="replaceable"><code>pattern</code></em>
1690    
1691 <em class="replaceable"><code>keyid</code></em>
1692  </p></div><p>
1693 When encrypting messages with PGP/GnuPG or OpenSSL, you may want to
1694 associate a certain key with a given e-mail address automatically,
1695 either because the recipient's public key can't be deduced from the
1696 destination address, or because, for some reasons, you need to override
1697 the key Mutt would normally use.  The <span class="command"><strong>crypt-hook</strong></span>
1698 command provides a method by which you can specify the ID of the public
1699 key to be used when encrypting messages to a certain recipient.
1700 </p><p>
1701 The meaning of <span class="emphasis"><em>keyid</em></span> is to be taken broadly in this
1702 context: You can either put a numerical key ID here, an e-mail address,
1703 or even just a real name.
1704 </p></div><div class="sect1" title="22. Adding Key Sequences to the Keyboard Buffer"><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>   
1705 <em class="replaceable"><code>string</code></em>
1706  </p></div><p>
1707 This command adds the named string to the keyboard buffer. The string
1708 may contain control characters, key names and function names like the
1709 sequence string in the <a class="link" href="#macro" title="8. Keyboard Macros">macro</a> command. You
1710 may use it to automatically run a sequence of commands at startup, or
1711 when entering certain folders. For example, <a class="xref" href="#ex-folder-hook-push" title="Example 3.13. Embedding push in folder-hook">Example 3.13, “Embedding <span class="command">push</span> in <span class="command">folder-hook</span>”</a> shows how to automatically collapse all
1712 threads when entering a folder.
1713 </p><div class="example"><a id="ex-folder-hook-push"></a><p class="title"><b>Example 3.13. Embedding <span class="command">push</span> in <span class="command">folder-hook</span></b></p><div class="example-contents"><pre class="screen">
1714 folder-hook . 'push &lt;collapse-all&gt;'
1715 </pre></div></div><br class="example-break" /><p>
1716 For using functions like shown in the example, it's important to use
1717 angle brackets (<span class="quote">“<span class="quote">&lt;</span>”</span> and <span class="quote">“<span class="quote">&gt;</span>”</span>) to make
1718 Mutt recognize the input as a function name. Otherwise it will simulate
1719 individual just keystrokes, i.e. <span class="quote">“<span class="quote"><code class="literal">push
1720 collapse-all</code></span>”</span> would be interpreted as if you had typed
1721 <span class="quote">“<span class="quote">c</span>”</span>, followed by <span class="quote">“<span class="quote">o</span>”</span>, followed by
1722 <span class="quote">“<span class="quote">l</span>”</span>, ..., which is not desired and may lead to very
1723 unexpected behavior.
1724 </p><p>
1725 Keystrokes can be used, too, but are less portable because of
1726 potentially changed key bindings. With default bindings, this is
1727 equivalent to the above example:
1728 </p><pre class="screen">
1729 folder-hook . 'push \eV'
1730 </pre><p>
1731 because it simulates that Esc+V was pressed (which is the default
1732 binding of <code class="literal">&lt;collapse-all&gt;</code>).
1733 </p></div><div class="sect1" title="23. Executing Functions"><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>   
1734 <em class="replaceable"><code>function</code></em>
1735   [
1736 <em class="replaceable"><code>function</code></em>
1737 ...]</p></div><p>
1738 This command can be used to execute any function. Functions are listed
1739 in the <a class="link" href="#functions" title="4. Functions">function reference</a>.
1740 <span class="quote">“<span class="quote"><span class="command"><strong>exec</strong></span> <code class="literal">function</code></span>”</span> is
1741 equivalent to <span class="quote">“<span class="quote"><code class="literal">push &lt;function&gt;</code></span>”</span>.
1742 </p></div><div class="sect1" title="24. Message Scoring"><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>   
1743 <em class="replaceable"><code>pattern</code></em>
1744    
1745 <em class="replaceable"><code>value</code></em>
1746  <br /><code class="command">unscore</code>  { 
1747 <em class="replaceable"><code>*</code></em>
1748   |   
1749 <em class="replaceable"><code>pattern</code></em>
1750 ... }</p></div><p>
1751 The <span class="command"><strong>score</strong></span> commands adds <span class="emphasis"><em>value</em></span> to
1752 a message's score if <span class="emphasis"><em>pattern</em></span> matches it.
1753 <span class="emphasis"><em>pattern</em></span> is a string in the format described in the
1754 <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a> section (note: For efficiency
1755 reasons, patterns which scan information not available in the index,
1756 such as <code class="literal">~b</code>, <code class="literal">~B</code> or
1757 <code class="literal">~h</code>, may not be used).  <span class="emphasis"><em>value</em></span> is
1758 a positive or negative integer.  A message's final score is the sum
1759 total of all matching <span class="command"><strong>score</strong></span> entries.  However, you
1760 may optionally prefix <span class="emphasis"><em>value</em></span> with an equal sign
1761 (<span class="quote">“<span class="quote">=</span>”</span>) to cause evaluation to stop at a particular entry if
1762 there is a match.  Negative final scores are rounded up to 0.
1763 </p><p>
1764 The <span class="command"><strong>unscore</strong></span> command removes score entries from the
1765 list.  You <span class="emphasis"><em>must</em></span> specify the same pattern specified
1766 in the <span class="command"><strong>score</strong></span> command for it to be removed.  The
1767 pattern <span class="quote">“<span class="quote">*</span>”</span> is a special token which means to clear the
1768 list of all score entries.
1769 </p></div><div class="sect1" title="25. Spam Detection"><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>   
1770 <em class="replaceable"><code>pattern</code></em>
1771    
1772 <em class="replaceable"><code>format</code></em>
1773  <br /><code class="command">nospam</code>  { 
1774 <em class="replaceable"><code>*</code></em>
1775   |   
1776 <em class="replaceable"><code>pattern</code></em>
1777  }</p></div><p>
1778 Mutt has generalized support for external spam-scoring filters.  By
1779 defining your spam patterns with the <span class="command"><strong>spam</strong></span> and
1780 <code class="literal">nospam</code> commands, you can <span class="emphasis"><em>limit</em></span>,
1781 <span class="emphasis"><em>search</em></span>, and <span class="emphasis"><em>sort</em></span> your mail
1782 based on its spam attributes, as determined by the external filter. You
1783 also can display the spam attributes in your index display using the
1784 <code class="literal">%H</code> selector in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable. (Tip: try
1785 <code class="literal">%?H?[%H] ?</code> to display spam tags only when they are
1786 defined for a given message.)
1787 </p><p>
1788 Your first step is to define your external filter's spam patterns using
1789 the <span class="command"><strong>spam</strong></span> command. <span class="emphasis"><em>pattern</em></span> should
1790 be a regular expression that matches a header in a mail message. If any
1791 message in the mailbox matches this regular expression, it will receive
1792 a <span class="quote">“<span class="quote">spam tag</span>”</span> or <span class="quote">“<span class="quote">spam attribute</span>”</span> (unless it
1793 also matches a <span class="command"><strong>nospam</strong></span> pattern — see below.) The
1794 appearance of this attribute is entirely up to you, and is governed by
1795 the <span class="emphasis"><em>format</em></span> parameter. <span class="emphasis"><em>format</em></span>
1796 can be any static text, but it also can include back-references from the
1797 <span class="emphasis"><em>pattern</em></span> expression. (A regular expression
1798 <span class="quote">“<span class="quote">back-reference</span>”</span> refers to a sub-expression contained
1799 within parentheses.) <code class="literal">%1</code> is replaced with the first
1800 back-reference in the regex, <code class="literal">%2</code> with the second, etc.
1801 </p><p>
1802 To match spam tags, mutt needs the corresponding header information
1803 which is always the case for local and POP folders but not for IMAP in
1804 the default configuration. Depending on the spam header to be analyzed,
1805 <a class="link" href="#imap-headers" title="3.99. imap_headers">$imap_headers</a> may need to be
1806 adjusted.
1807 </p><p>
1808 If you're using multiple spam filters, a message can have more than one
1809 spam-related header. You can define <span class="command"><strong>spam</strong></span> patterns for
1810 each filter you use. If a message matches two or more of these patterns,
1811 and the <a class="link" href="#spam-separator" title="3.269. spam_separator">$spam_separator</a> variable
1812 is set to a string, then the message's spam tag will consist of all the
1813 <span class="emphasis"><em>format</em></span> strings joined together, with the value of
1814 <a class="link" href="#spam-separator" title="3.269. spam_separator">$spam_separator</a> separating them.
1815 </p><p>
1816 For example, suppose one uses DCC, SpamAssassin, and PureMessage, then
1817 the configuration might look like in <a class="xref" href="#ex-spam" title="Example 3.14. Configuring spam detection">Example 3.14, “Configuring spam detection”</a>.
1818 </p><div class="example"><a id="ex-spam"></a><p class="title"><b>Example 3.14. Configuring spam detection</b></p><div class="example-contents"><pre class="screen">
1819 spam "X-DCC-.*-Metrics:.*(....)=many"         "90+/DCC-%1"
1820 spam "X-Spam-Status: Yes"                     "90+/SA"
1821 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
1822 set spam_separator=", "
1823 </pre></div></div><br class="example-break" /><p>
1824 If then a message is received that DCC registered with
1825 <span class="quote">“<span class="quote">many</span>”</span> hits under the <span class="quote">“<span class="quote">Fuz2</span>”</span> checksum, and
1826 that PureMessage registered with a 97% probability of being spam, that
1827 message's spam tag would read <code class="literal">90+/DCC-Fuz2,
1828 97/PM</code>. (The four characters before <span class="quote">“<span class="quote">=many</span>”</span> in a
1829 DCC report indicate the checksum used — in this case,
1830 <span class="quote">“<span class="quote">Fuz2</span>”</span>.)
1831 </p><p>
1832 If the <a class="link" href="#spam-separator" title="3.269. spam_separator">$spam_separator</a> variable is
1833 unset, then each spam pattern match supersedes the previous one. Instead
1834 of getting joined <span class="emphasis"><em>format</em></span> strings, you'll get only
1835 the last one to match.
1836 </p><p>
1837 The spam tag is what will be displayed in the index when you use
1838 <code class="literal">%H</code> in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable. It's also the
1839 string that the <code class="literal">~H</code> pattern-matching expression
1840 matches against for <code class="literal">&lt;search&gt;</code> and
1841 <code class="literal">&lt;limit&gt;</code> functions. And it's what sorting by
1842 spam attribute will use as a sort key.
1843 </p><p>
1844 That's a pretty complicated example, and most people's actual
1845 environments will have only one spam filter. The simpler your
1846 configuration, the more effective Mutt can be, especially when it comes
1847 to sorting.
1848 </p><p>
1849 Generally, when you sort by spam tag, Mutt will sort
1850 <span class="emphasis"><em>lexically</em></span> — that is, by ordering strings
1851 alphanumerically. However, if a spam tag begins with a number, Mutt will
1852 sort numerically first, and lexically only when two numbers are equal in
1853 value. (This is like UNIX's <code class="literal">sort -n</code>.) A message with
1854 no spam attributes at all — that is, one that didn't match
1855 <span class="emphasis"><em>any</em></span> of your <span class="command"><strong>spam</strong></span> patterns
1856 — is sorted at lowest priority. Numbers are sorted next, beginning
1857 with 0 and ranging upward. Finally, non-numeric strings are sorted, with
1858 <span class="quote">“<span class="quote">a</span>”</span> taking lower priority than <span class="quote">“<span class="quote">z</span>”</span>. Clearly,
1859 in general, sorting by spam tags is most effective when you can coerce
1860 your filter to give you a raw number. But in case you can't, Mutt can
1861 still do something useful.
1862 </p><p>
1863 The <span class="command"><strong>nospam</strong></span> command can be used to write exceptions to
1864 <span class="command"><strong>spam</strong></span> patterns. If a header pattern matches something
1865 in a <span class="command"><strong>spam</strong></span> command, but you nonetheless do not want it
1866 to receive a spam tag, you can list a more precise pattern under a
1867 <span class="command"><strong>nospam</strong></span> command.
1868 </p><p>
1869 If the <span class="emphasis"><em>pattern</em></span> given to <span class="command"><strong>nospam</strong></span>
1870 is exactly the same as the <span class="emphasis"><em>pattern</em></span> on an existing
1871 <span class="command"><strong>spam</strong></span> list entry, the effect will be to remove the
1872 entry from the spam list, instead of adding an exception.  Likewise, if
1873 the <span class="emphasis"><em>pattern</em></span> for a <span class="command"><strong>spam</strong></span> command
1874 matches an entry on the <span class="command"><strong>nospam</strong></span> list, that nospam
1875 entry will be removed. If the <span class="emphasis"><em>pattern</em></span> for
1876 <span class="command"><strong>nospam</strong></span> is <span class="quote">“<span class="quote">*</span>”</span>, <span class="emphasis"><em>all entries on
1877 both lists</em></span> will be removed. This might be the default action
1878 if you use <span class="command"><strong>spam</strong></span> and <span class="command"><strong>nospam</strong></span> in
1879 conjunction with a <span class="command"><strong>folder-hook</strong></span>.
1880 </p><p>
1881 You can have as many <span class="command"><strong>spam</strong></span> or
1882 <span class="command"><strong>nospam</strong></span> commands as you like.  You can even do your
1883 own primitive <span class="command"><strong>spam</strong></span> detection within Mutt — for
1884 example, if you consider all mail from <code class="literal">MAILER-DAEMON</code>
1885 to be spam, you can use a <span class="command"><strong>spam</strong></span> command like this:
1886 </p><pre class="screen">
1887 spam "^From: .*MAILER-DAEMON"       "999"
1888 </pre></div><div class="sect1" title="26. Setting and Querying Variables"><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" title="26.1. Variable Types"><div class="titlepage"><div><div><h3 class="title"><a id="var-types"></a>26.1. Variable Types</h3></div></div></div><p>
1889 Mutt supports these types of configuration variables:
1890 </p><div class="variablelist"><dl><dt><span class="term">boolean</span></dt><dd><p>
1891 A boolean expression, either <span class="quote">“<span class="quote">yes</span>”</span> or <span class="quote">“<span class="quote">no</span>”</span>.
1892 </p></dd><dt><span class="term">number</span></dt><dd><p>
1893 A signed integer number in the range -32768 to 32767.
1894 </p></dd><dt><span class="term">string</span></dt><dd><p>
1895 Arbitrary text.
1896 </p></dd><dt><span class="term">path</span></dt><dd><p>
1897 A specialized string for representing paths including support for
1898 mailbox shortcuts (see <a class="xref" href="#shortcuts" title="8. Mailbox Shortcuts">Section 8, “Mailbox Shortcuts”</a>) as well as tilde
1899 (<span class="quote">“<span class="quote">~</span>”</span>) for a user's home directory and more.
1900 </p></dd><dt><span class="term">quadoption</span></dt><dd><p>
1901 Like a boolean but triggers a prompt when set to <span class="quote">“<span class="quote">ask-yes</span>”</span>
1902 or <span class="quote">“<span class="quote">ask-no</span>”</span> with <span class="quote">“<span class="quote">yes</span>”</span> and <span class="quote">“<span class="quote">no</span>”</span>
1903 preselected respectively.
1904 </p></dd><dt><span class="term">sort order</span></dt><dd><p>
1905 A specialized string allowing only particular words as values depending
1906 on the variable.
1907 </p></dd><dt><span class="term">regular expression</span></dt><dd><p>
1908 A regular expression, see <a class="xref" href="#regexp" title="2. Regular Expressions">Section 2, “Regular Expressions”</a> for an introduction.
1909 </p></dd><dt><span class="term">folder magic</span></dt><dd><p>
1910 Specifies the type of folder to use: <span class="emphasis"><em>mbox</em></span>,
1911 <span class="emphasis"><em>mmdf</em></span>, <span class="emphasis"><em>mh</em></span> or
1912 <span class="emphasis"><em>maildir</em></span>.  Currently only used to determine the type
1913 for newly created folders.
1914 </p></dd><dt><span class="term">e-mail address</span></dt><dd><p>
1915 An e-mail address either with or without realname. The older
1916 <span class="quote">“<span class="quote"><code class="literal">user@example.org (Joe User)</code></span>”</span> form is
1917 supported but strongly deprecated.
1918 </p></dd><dt><span class="term">user-defined</span></dt><dd><p>
1919 Arbitrary text, see <a class="xref" href="#set-myvar" title="26.3. User-Defined Variables">Section 26.3, “User-Defined Variables”</a> for details.
1920 </p></dd></dl></div></div><div class="sect2" title="26.2. Commands"><div class="titlepage"><div><div><h3 class="title"><a id="set-commands"></a>26.2. Commands</h3></div></div></div><p>
1921 The following commands are available to manipulate and query variables:
1922 </p><p>Usage:</p><div class="cmdsynopsis"><p><code class="command">set</code>  { 
1923 [ <code class="option">no</code>  |   <code class="option">inv</code> ]
1924 <em class="replaceable"><code>variable</code></em>
1925   |   
1926 <em class="replaceable"><code>variable=value</code></em>
1927  } [...]<br /><code class="command">toggle</code>   
1928 <em class="replaceable"><code>variable</code></em>
1929   [
1930 <em class="replaceable"><code>variable</code></em>
1931 ...]<br /><code class="command">unset</code>   
1932 <em class="replaceable"><code>variable</code></em>
1933   [
1934 <em class="replaceable"><code>variable</code></em>
1935 ...]<br /><code class="command">reset</code>   
1936 <em class="replaceable"><code>variable</code></em>
1937   [
1938 <em class="replaceable"><code>variable</code></em>
1939 ...]</p></div><p>
1940 This command is used to set (and unset) <a class="link" href="#variables" title="3. Configuration Variables">configuration variables</a>.  There are four
1941 basic types of variables: boolean, number, string and quadoption.
1942 <span class="emphasis"><em>boolean</em></span> variables can be <span class="emphasis"><em>set</em></span>
1943 (true) or <span class="emphasis"><em>unset</em></span> (false).
1944 <span class="emphasis"><em>number</em></span> variables can be assigned a positive integer
1945 value.  <span class="emphasis"><em>string</em></span> variables consist of any number of
1946 printable characters and must be enclosed in quotes if they contain
1947 spaces or tabs.  You may also use the escape sequences <span class="quote">“<span class="quote">\n</span>”</span>
1948 and <span class="quote">“<span class="quote">\t</span>”</span> for newline and tab, respectively.
1949 <span class="emphasis"><em>quadoption</em></span> variables are used to control whether or
1950 not to be prompted for certain actions, or to specify a default action.
1951 A value of <span class="emphasis"><em>yes</em></span> will cause the action to be carried
1952 out automatically as if you had answered yes to the question.
1953 Similarly, a value of <span class="emphasis"><em>no</em></span> will cause the action to
1954 be carried out as if you had answered <span class="quote">“<span class="quote">no.</span>”</span> A value of
1955 <span class="emphasis"><em>ask-yes</em></span> will cause a prompt with a default answer
1956 of <span class="quote">“<span class="quote">yes</span>”</span> and <span class="emphasis"><em>ask-no</em></span> will provide a
1957 default answer of <span class="quote">“<span class="quote">no.</span>”</span>
1958 </p><p>
1959 Prefixing a variable with <span class="quote">“<span class="quote">no</span>”</span> will unset it.  Example:
1960 <code class="literal"><span class="command"><strong>set</strong></span> noaskbcc</code>.
1961 </p><p>
1962 For <span class="emphasis"><em>boolean</em></span> variables, you may optionally prefix
1963 the variable name with <code class="literal">inv</code> to toggle the value (on or
1964 off).  This is useful when writing macros.  Example:
1965 <code class="literal"><span class="command"><strong>set</strong></span> invsmart_wrap</code>.
1966 </p><p>
1967 The <span class="command"><strong>toggle</strong></span> command automatically prepends the
1968 <code class="literal">inv</code> prefix to all specified variables.
1969 </p><p>
1970 The <span class="command"><strong>unset</strong></span> command automatically prepends the
1971 <code class="literal">no</code> prefix to all specified variables.
1972 </p><p>
1973 Using the <code class="literal">&lt;enter-command&gt;</code> function in the
1974 <span class="emphasis"><em>index</em></span> menu, you can query the value of a variable
1975 by prefixing the name of the variable with a question mark:
1976 </p><pre class="screen">
1977 set ?allow_8bit
1978 </pre><p>
1979 The question mark is actually only required for boolean and quadoption
1980 variables.
1981 </p><p>
1982 The <span class="command"><strong>reset</strong></span> command resets all given variables to the
1983 compile time defaults (hopefully mentioned in this manual). If you use
1984 the command <span class="command"><strong>set</strong></span> and prefix the variable with
1985 <span class="quote">“<span class="quote">&amp;</span>”</span> this has the same behavior as the
1986 <span class="command"><strong>reset</strong></span> command.
1987 </p><p>
1988 With the <span class="command"><strong>reset</strong></span> command there exists the special
1989 variable <span class="quote">“<span class="quote">all</span>”</span>, which allows you to reset all variables to
1990 their system defaults.
1991 </p></div><div class="sect2" title="26.3. User-Defined Variables"><div class="titlepage"><div><div><h3 class="title"><a id="set-myvar"></a>26.3. User-Defined Variables</h3></div></div></div><div class="sect3" title="26.3.1. Introduction"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-intro"></a>26.3.1. Introduction</h4></div></div></div><p>
1992 Along with the variables listed in the <a class="link" href="#variables" title="3. Configuration Variables">Configuration variables</a> section, Mutt
1993 supports user-defined variables with names starting with
1994 <code class="literal">my_</code> as in, for example, <code class="literal">my_cfgdir</code>.
1995 </p><p>
1996 The <span class="command"><strong>set</strong></span> command either creates a custom
1997 <code class="literal">my_</code> variable or changes its value if it does exist
1998 already. The <span class="command"><strong>unset</strong></span> and <span class="command"><strong>reset</strong></span>
1999 commands remove the variable entirely.
2000 </p><p>
2001 Since user-defined variables are expanded in the same way that
2002 environment variables are (except for the <a class="link" href="#shell-escape">shell-escape</a> command and backtick
2003 expansion), this feature can be used to make configuration files more
2004 readable.
2005 </p></div><div class="sect3" title="26.3.2. Examples"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-examples"></a>26.3.2. Examples</h4></div></div></div><p>
2006 The following example defines and uses the variable
2007 <code class="literal">my_cfgdir</code> to abbreviate the calls of the <a class="link" href="#source" title="27. Reading Initialization Commands From Another File"><span class="command"><strong>source</strong></span></a> command:
2008 </p><div class="example"><a id="ex-myvar1"></a><p class="title"><b>Example 3.15. Using user-defined variables for config file readability</b></p><div class="example-contents"><pre class="screen">
2009 set my_cfgdir = $HOME/mutt/config
2010
2011 source $my_cfgdir/hooks
2012 source $my_cfgdir/macros
2013 <span class="comment"># more source commands...</span>
2014 </pre></div></div><br class="example-break" /><p>
2015 A custom variable can also be used in macros to backup the current value
2016 of another variable. In the following example, the value of the <a class="link" href="#delete" title="3.49. delete">$delete</a> is changed temporarily while its
2017 original value is saved as <code class="literal">my_delete</code>.  After the
2018 macro has executed all commands, the original value of <a class="link" href="#delete" title="3.49. delete">$delete</a> is restored.
2019 </p><div class="example"><a id="ex-myvar2"></a><p class="title"><b>Example 3.16. Using user-defined variables for backing up other config option values</b></p><div class="example-contents"><pre class="screen">
2020 macro pager ,x '\
2021 &lt;enter-command&gt;set my_delete=$delete&lt;enter&gt;\
2022 &lt;enter-command&gt;set delete=yes&lt;enter&gt;\
2023 ...\
2024 &lt;enter-command&gt;set delete=$my_delete&lt;enter&gt;'
2025 </pre></div></div><br class="example-break" /><p>
2026 Since Mutt expands such values already when parsing the configuration
2027 file(s), the value of <code class="literal">$my_delete</code> in the
2028 last example would be the value of <a class="link" href="#delete" title="3.49. delete">$delete</a> exactly
2029 as it was at that point during parsing the configuration file. If
2030 another statement would change the value for <a class="link" href="#delete" title="3.49. delete">$delete</a>
2031 later in the same or another file, it would have no effect on
2032 <code class="literal">$my_delete</code>. However, the expansion can
2033 be deferred to runtime, as shown in the next example, when escaping the
2034 dollar sign.
2035 </p><div class="example"><a id="ex-myvar3"></a><p class="title"><b>Example 3.17. Deferring user-defined variable expansion to runtime</b></p><div class="example-contents"><pre class="screen">
2036 macro pager &lt;PageDown&gt; "\
2037 &lt;enter-command&gt; set my_old_pager_stop=\$pager_stop pager_stop&lt;Enter&gt;\
2038 &lt;next-page&gt;\
2039 &lt;enter-command&gt; set pager_stop=\$my_old_pager_stop&lt;Enter&gt;\
2040 &lt;enter-command&gt; unset my_old_pager_stop&lt;Enter&gt;"
2041 </pre></div></div><br class="example-break" /><p>
2042 Note that there is a space between
2043 <code class="literal">&lt;enter-command&gt;</code> and the <span class="command"><strong>set</strong></span>
2044 configuration command, preventing Mutt from recording the
2045 <span class="command"><strong>macro</strong></span>'s commands into its history.
2046 </p></div></div><div class="sect2" title="26.4. Type Conversions"><div class="titlepage"><div><div><h3 class="title"><a id="set-conversions"></a>26.4. Type Conversions</h3></div></div></div><p>
2047 Variables are always assigned string values which Mutt parses into its
2048 internal representation according to the type of the variable, for
2049 example an integer number for numeric types. For all queries (including
2050 $-expansion) the value is converted from its internal type back into
2051 string. As a result, any variable can be assigned any value given that
2052 its content is valid for the target. This also counts for custom
2053 variables which are of type string. In case of parsing errors, Mutt will
2054 print error messages. <a class="xref" href="#ex-myvar4" title="Example 3.18. Type conversions using variables">Example 3.18, “Type conversions using variables”</a> demonstrates type
2055 conversions.
2056 </p><div class="example"><a id="ex-myvar4"></a><p class="title"><b>Example 3.18. Type conversions using variables</b></p><div class="example-contents"><pre class="screen">
2057 set my_lines = "5"                <span class="comment"># value is string "5"</span>
2058 set pager_index_lines = $my_lines <span class="comment"># value is integer 5</span>
2059
2060 set my_sort = "date-received"     <span class="comment"># value is string "date-received"</span>
2061 set sort = "last-$my_sort"        <span class="comment"># value is sort last-date-received</span>
2062
2063 set my_inc = $read_inc            <span class="comment"># value is string "10" (default of $read_inc)</span>
2064 set my_foo = $my_inc              <span class="comment"># value is string "10"</span>
2065 </pre></div></div><br class="example-break" /><p>
2066 These assignments are all valid. If, however, the value of
2067 <code class="literal">$my_lines</code> would have been
2068 <span class="quote">“<span class="quote">five</span>”</span> (or something else that cannot be parsed into a
2069 number), the assignment to
2070 <code class="literal">$pager_index_lines</code> would have
2071 produced an error message.
2072 </p><p>
2073 Type conversion applies to all configuration commands which take
2074 arguments. But please note that every expanded value of a variable is
2075 considered just a single token. A working example is:
2076 </p><pre class="screen">
2077 set my_pattern = "~A"
2078 set my_number = "10"
2079
2080 <span class="comment"># same as: score ~A +10</span>
2081 score $my_pattern +$my_number</pre><p>
2082 What does <span class="emphasis"><em>not</em></span> work is:
2083 </p><pre class="screen">
2084 set my_mx = "+mailbox1 +mailbox2"
2085 mailboxes $my_mx +mailbox3</pre><p>
2086 because the value of <code class="literal">$my_mx</code> is interpreted as a
2087 single mailbox named <span class="quote">“<span class="quote">+mailbox1 +mailbox2</span>”</span> and not two
2088 distinct mailboxes.
2089 </p></div></div><div class="sect1" title="27. Reading Initialization Commands From Another File"><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>   
2090 <em class="replaceable"><code>filename</code></em>
2091  </p></div><p>
2092 This command allows the inclusion of initialization commands from other
2093 files.  For example, I place all of my aliases in
2094 <code class="literal">~/.mail_aliases</code> so that I can make my
2095 <code class="literal">~/.muttrc</code> readable and keep my aliases private.
2096 </p><p>
2097 If the filename begins with a tilde (<span class="quote">“<span class="quote">~</span>”</span>), it will be
2098 expanded to the path of your home directory.
2099 </p><p>
2100 If the filename ends with a vertical bar (<span class="quote">“<span class="quote">|</span>”</span>), then
2101 <span class="emphasis"><em>filename</em></span> is considered to be an executable program
2102 from which to read input (e.g.  <code class="literal"><span class="command"><strong>source</strong></span>
2103 ~/bin/myscript|</code>).
2104 </p></div><div class="sect1" title="28. Removing Hooks"><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>  { 
2105 <em class="replaceable"><code>*</code></em>
2106   |   
2107 <em class="replaceable"><code>hook-type</code></em>
2108  }</p></div><p>
2109 This command permits you to flush hooks you have previously defined.
2110 You can either remove all hooks by giving the <span class="quote">“<span class="quote">*</span>”</span> character
2111 as an argument, or you can remove all hooks of a specific type by saying
2112 something like <code class="literal"><span class="command"><strong>unhook</strong></span> send-hook</code>.
2113 </p></div><div class="sect1" title="29. Format Strings"><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" title="29.1. Basic usage"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-basics"></a>29.1. Basic usage</h3></div></div></div><p>
2114 Format strings are a general concept you'll find in several locations
2115 through the Mutt configuration, especially in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, <a class="link" href="#pager-format" title="3.151. pager_format">$pager_format</a>, <a class="link" href="#status-format" title="3.283. status_format">$status_format</a>, and other related
2116 variables. These can be very straightforward, and it's quite possible
2117 you already know how to use them.
2118 </p><p>
2119 The most basic format string element is a percent symbol followed by
2120 another character. For example, <code class="literal">%s</code> represents a
2121 message's Subject: header in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable. The
2122 <span class="quote">“<span class="quote">expandos</span>”</span> available are documented with each format
2123 variable, but there are general modifiers available with all formatting
2124 expandos, too. Those are our concern here.
2125 </p><p>
2126 Some of the modifiers are borrowed right out of C (though you might know
2127 them from Perl, Python, shell, or another language). These are the
2128 <code class="literal">[-]m.n</code> modifiers, as in
2129 <code class="literal">%-12.12s</code>. As with such programming languages, these
2130 modifiers allow you to specify the minimum and maximum size of the
2131 resulting string, as well as its justification. If the <span class="quote">“<span class="quote">-</span>”</span>
2132 sign follows the percent, the string will be left-justified instead of
2133 right-justified. If there's a number immediately following that, it's
2134 the minimum amount of space the formatted string will occupy — if
2135 it's naturally smaller than that, it will be padded out with spaces.  If
2136 a decimal point and another number follow, that's the maximum space
2137 allowable — the string will not be permitted to exceed that width,
2138 no matter its natural size. Each of these three elements is optional, so
2139 that all these are legal format strings: <code class="literal">%-12s</code>,
2140 <code class="literal">%4c</code>, <code class="literal">%.15F</code> and
2141 <code class="literal">%-12.15L</code>.
2142 </p><p>
2143 Mutt adds some other modifiers to format strings. If you use an equals
2144 symbol (<code class="literal">=</code>) as a numeric prefix (like the minus
2145 above), it will force the string to be centered within its minimum space
2146 range. For example, <code class="literal">%=14y</code> will reserve 14 characters
2147 for the %y expansion — that's the X-Label: header, in <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>. If the expansion results in
2148 a string less than 14 characters, it will be centered in a 14-character
2149 space.  If the X-Label for a message were <span class="quote">“<span class="quote">test</span>”</span>, that
2150 expansion would look like
2151 <span class="quote">“<span class="quote">     test     </span>”</span>.
2152 </p><p>
2153 There are two very little-known modifiers that affect the way that an
2154 expando is replaced. If there is an underline (<span class="quote">“<span class="quote">_</span>”</span>)
2155 character between any format modifiers (as above) and the expando
2156 letter, it will expands in all lower case. And if you use a colon
2157 (<span class="quote">“<span class="quote">:</span>”</span>), it will replace all decimal points with underlines.
2158 </p></div><div class="sect2" title="29.2. Conditionals"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-conditionals"></a>29.2. Conditionals</h3></div></div></div><p>
2159 Depending on the format string variable, some of its sequences can be
2160 used to optionally print a string if their value is nonzero. For
2161 example, you may only want to see the number of flagged messages if such
2162 messages exist, since zero is not particularly meaningful. To optionally
2163 print a string based upon one of the above sequences, the following
2164 construct is used:
2165 </p><pre class="screen">
2166 %?&lt;sequence_char&gt;?&lt;optional_string&gt;?</pre><p>
2167 where <span class="emphasis"><em>sequence_char</em></span> is an expando, and
2168 <span class="emphasis"><em>optional_string</em></span> is the string you would like
2169 printed if <span class="emphasis"><em>sequence_char</em></span> is nonzero.
2170 <span class="emphasis"><em>optional_string</em></span> may contain other sequences as well
2171 as normal text, but you may not nest optional strings.
2172 </p><p>
2173 Here is an example illustrating how to optionally print the number of
2174 new messages in a mailbox in <a class="link" href="#status-format" title="3.283. status_format">$status_format</a>:
2175 </p><pre class="screen">
2176 %?n?%n new messages.?</pre><p>
2177 You can also switch between two strings using the following construct:
2178 </p><pre class="screen">
2179 %?&lt;sequence_char&gt;?&lt;if_string&gt;&amp;&lt;else_string&gt;?</pre><p>
2180 If the value of <span class="emphasis"><em>sequence_char</em></span> is non-zero,
2181 <span class="emphasis"><em>if_string</em></span> will be expanded, otherwise
2182 <span class="emphasis"><em>else_string</em></span> will be expanded.
2183 </p></div><div class="sect2" title="29.3. Filters"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-filters"></a>29.3. Filters</h3></div></div></div><p>
2184 Any format string ending in a vertical bar (<span class="quote">“<span class="quote">|</span>”</span>) will be
2185 expanded and piped through the first word in the string, using spaces as
2186 separator. The string returned will be used for display.  If the
2187 returned string ends in %, it will be passed through the formatter a
2188 second time. This allows the filter to generate a replacement format
2189 string including % expandos.
2190 </p><p>
2191 All % expandos in a format string are expanded before the script is
2192 called so that:
2193 </p><div class="example"><a id="ex-fmtpipe"></a><p class="title"><b>Example 3.19. Using external filters in format strings</b></p><div class="example-contents"><pre class="screen">
2194 set status_format="script.sh '%r %f (%L)'|"
2195 </pre></div></div><br class="example-break" /><p>
2196 will make Mutt expand <code class="literal">%r</code>, <code class="literal">%f</code> and
2197 <code class="literal">%L</code> before calling the script. The example also shows
2198 that arguments can be quoted: the script will receive the expanded
2199 string between the single quotes as the only argument.
2200 </p><p>
2201 A practical example is the <code class="literal">mutt_xtitle</code> script
2202 installed in the <code class="literal">samples</code> subdirectory of the Mutt
2203 documentation: it can be used as filter for <a class="link" href="#status-format" title="3.283. status_format">$status_format</a> to set the current
2204 terminal's title, if supported.
2205 </p></div><div class="sect2" title="29.4. Padding"><div class="titlepage"><div><div><h3 class="title"><a id="formatstrings-padding"></a>29.4. Padding</h3></div></div></div><p>
2206 In most format strings, Mutt supports different types of padding using
2207 special %-expandos:
2208 </p><div class="variablelist"><dl><dt><span class="term"><code class="literal">%|X</code></span></dt><dd><p>
2209 When this occurs, Mutt will fill the rest of the line with the character
2210 <code class="literal">X</code>. For example, filling the rest of the line with
2211 dashes is done by setting:
2212 </p><pre class="screen">
2213 set status_format = "%v on %h: %B: %?n?%n&amp;no? new messages %|-"</pre></dd><dt><span class="term">
2214 <code class="literal">%&gt;X</code>
2215 </span></dt><dd><p>
2216 Since the previous expando stops at the end of line, there must be a way
2217 to fill the gap between two items via the <code class="literal">%&gt;X</code>
2218 expando: it puts as many characters <code class="literal">X</code> in between two
2219 items so that the rest of the line will be right-justified. For example,
2220 to not put the version string and hostname the above example on the left
2221 but on the right and fill the gap with spaces, one might use (note the
2222 space after <code class="literal">%&gt;</code>):
2223 </p><pre class="screen">
2224 set status_format = "%B: %?n?%n&amp;no? new messages %&gt; (%v on %h)"</pre></dd><dt><span class="term"><code class="literal">%*X</code>
2225 </span></dt><dd><p>
2226 Normal right-justification will print everything to the left of the
2227 <code class="literal">%&gt;</code>, displaying padding and whatever lies to the
2228 right only if there's room. By contrast, <span class="quote">“<span class="quote">soft-fill</span>”</span> gives
2229 priority to the right-hand side, guaranteeing space to display it and
2230 showing padding only if there's still room. If necessary, soft-fill will
2231 eat text leftwards to make room for rightward text. For example, to
2232 right-justify the subject making sure as much as possible of it fits on
2233 screen, one might use (note two spaces after <code class="literal">%* </code>: the
2234 second ensures there's a space between the truncated right-hand side and
2235 the subject):
2236 </p><pre class="screen">
2237 set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?)%*  %s"</pre></dd></dl></div></div></div></div><div class="chapter" title="Chapter 4. Advanced Usage"><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="#charset-handling">1. Character Set Handling</a></span></dt><dt><span class="sect1"><a href="#regexp">2. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">3. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#patterns-modifier">3.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#simple-searches">3.2. Simple Searches</a></span></dt><dt><span class="sect2"><a href="#complex-patterns">3.3. Nesting and Boolean Operators</a></span></dt><dt><span class="sect2"><a href="#date-patterns">3.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">4. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">5. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">5.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">6. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">7. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">8. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">9. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#new-mail">10. New Mail Detection</a></span></dt><dd><dl><dt><span class="sect2"><a href="#new-mail-formats">10.1. How New Mail Detection Works</a></span></dt><dt><span class="sect2"><a href="#new-mail-polling">10.2. Polling For New Mail</a></span></dt></dl></dd><dt><span class="sect1"><a href="#editing-threads">11. Editing Threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#link-threads">11.1. Linking Threads</a></span></dt><dt><span class="sect2"><a href="#break-threads">11.2. Breaking Threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">12. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">13. Start a WWW Browser on URLs</a></span></dt><dt><span class="sect1"><a href="#misc-topics">14. Miscellany</a></span></dt></dl></div><div class="sect1" title="1. Character Set Handling"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="charset-handling"></a>1. Character Set Handling</h2></div></div></div><p>
2238 A <span class="quote">“<span class="quote">character set</span>”</span> is basically a mapping between bytes and
2239 glyphs and implies a certain character encoding scheme. For example, for
2240 the ISO 8859 family of character sets, an encoding of 8bit per character
2241 is used. For the Unicode character set, different character encodings
2242 may be used, UTF-8 being the most popular. In UTF-8, a character is
2243 represented using a variable number of bytes ranging from 1 to 4.
2244 </p><p>
2245 Since Mutt is a command-line tool run from a shell, and delegates
2246 certain tasks to external tools (such as an editor for composing/editing
2247 messages), all of these tools need to agree on a character set and
2248 encoding. There exists no way to reliably deduce the character set a
2249 plain text file has. Interoperability is gained by the use of
2250 well-defined environment variables. The full set can be printed by
2251 issuing <code class="literal">locale</code> on the command line.
2252 </p><p>
2253 Upon startup, Mutt determines the character set on its own using
2254 routines that inspect locale-specific environment variables. Therefore,
2255 it is generally not necessary to set the <code class="literal">$charset</code>
2256 variable in Mutt. It may even be counter-productive as Mutt uses system
2257 and library functions that derive the character set themselves and on
2258 which Mutt has no influence. It's safest to let Mutt work out the locale
2259 setup itself.
2260 </p><p>
2261 If you happen to work with several character sets on a regular basis,
2262 it's highly advisable to use Unicode and an UTF-8 locale. Unicode can
2263 represent nearly all characters in a message at the same time.  When not
2264 using a Unicode locale, it may happen that you receive messages with
2265 characters not representable in your locale. When displaying such a
2266 message, or replying to or forwarding it, information may get lost
2267 possibly rendering the message unusable (not only for you but also for
2268 the recipient, this breakage is not reversible as lost information
2269 cannot be guessed).
2270 </p><p>
2271 A Unicode locale makes all conversions superfluous which eliminates the
2272 risk of conversion errors. It also eliminates potentially wrong
2273 expectations about the character set between Mutt and external programs.
2274 </p><p>
2275 The terminal emulator used also must be properly configured for the
2276 current locale. Terminal emulators usually do <span class="emphasis"><em>not</em></span>
2277 derive the locale from environment variables, they need to be configured
2278 separately. If the terminal is incorrectly configured, Mutt may display
2279 random and unexpected characters (question marks, octal codes, or just
2280 random glyphs), format strings may not work as expected, you may not be
2281 abled to enter non-ascii characters, and possible more.  Data is always
2282 represented using bytes and so a correct setup is very important as to
2283 the machine, all character sets <span class="quote">“<span class="quote">look</span>”</span> the same.
2284 </p><p>
2285 Warning: A mismatch between what system and library functions think the
2286 locale is and what Mutt was told what the locale is may make it behave
2287 badly with non-ascii input: it will fail at seemingly random places.
2288 This warning is to be taken seriously since not only local mail handling
2289 may suffer: sent messages may carry wrong character set information the
2290 <span class="emphasis"><em>receiver</em></span> has too deal with. The need to set
2291 <code class="literal">$charset</code> directly in most cases points at terminal
2292 and environment variable setup problems, not Mutt problems.
2293 </p><p>
2294 A list of officially assigned and known character sets can be found at
2295 <a class="ulink" href="http://www.iana.org/assignments/character-sets" target="_top">IANA</a>,
2296 a list of locally supported locales can be obtained by running
2297 <code class="literal">locale -a</code>.
2298 </p></div><div class="sect1" title="2. Regular Expressions"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="regexp"></a>2. Regular Expressions</h2></div></div></div><p>
2299 All string patterns in Mutt including those in more complex <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a> must be specified using regular
2300 expressions (regexp) in the <span class="quote">“<span class="quote">POSIX extended</span>”</span> syntax (which
2301 is more or less the syntax used by egrep and GNU awk).  For your
2302 convenience, we have included below a brief description of this syntax.
2303 </p><p>
2304 The search is case sensitive if the pattern contains at least one upper
2305 case letter, and case insensitive otherwise.
2306 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2307 <span class="quote">“<span class="quote">\</span>”</span> must be quoted if used for a regular expression in an
2308 initialization command: <span class="quote">“<span class="quote">\\</span>”</span>.
2309 </p></div><p>
2310 A regular expression is a pattern that describes a set of strings.
2311 Regular expressions are constructed analogously to arithmetic
2312 expressions, by using various operators to combine smaller expressions.
2313 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2314 The regular expression can be enclosed/delimited by either " or ' which
2315 is useful if the regular expression includes a white-space character.
2316 See <a class="xref" href="#muttrc-syntax" title="2. Syntax of Initialization Files">Syntax of Initialization Files</a> for more information on " and '
2317 delimiter processing.  To match a literal " or ' you must preface it
2318 with \ (backslash).
2319 </p></div><p>
2320 The fundamental building blocks are the regular expressions that match a
2321 single character.  Most characters, including all letters and digits,
2322 are regular expressions that match themselves.  Any metacharacter with
2323 special meaning may be quoted by preceding it with a backslash.
2324 </p><p>
2325 The period <span class="quote">“<span class="quote">.</span>”</span> matches any single character.  The caret
2326 <span class="quote">“<span class="quote">^</span>”</span> and the dollar sign <span class="quote">“<span class="quote">$</span>”</span> are metacharacters
2327 that respectively match the empty string at the beginning and end of a
2328 line.
2329 </p><p>
2330 A list of characters enclosed by <span class="quote">“<span class="quote">[</span>”</span> and <span class="quote">“<span class="quote">]</span>”</span>
2331 matches any single character in that list; if the first character of the
2332 list is a caret <span class="quote">“<span class="quote">^</span>”</span> then it matches any character
2333 <span class="emphasis"><em>not</em></span> in the list.  For example, the regular
2334 expression <span class="emphasis"><em>[0123456789]</em></span> matches any single digit.
2335 A range of ASCII characters may be specified by giving the first and
2336 last characters, separated by a hyphen <span class="quote">“<span class="quote">-</span>”</span>.  Most
2337 metacharacters lose their special meaning inside lists.  To include a
2338 literal <span class="quote">“<span class="quote">]</span>”</span> place it first in the list.  Similarly, to
2339 include a literal <span class="quote">“<span class="quote">^</span>”</span> place it anywhere but first.
2340 Finally, to include a literal hyphen <span class="quote">“<span class="quote">-</span>”</span> place it last.
2341 </p><p>
2342 Certain named classes of characters are predefined.  Character classes
2343 consist of <span class="quote">“<span class="quote">[:</span>”</span>, a keyword denoting the class, and
2344 <span class="quote">“<span class="quote">:]</span>”</span>.  The following classes are defined by the POSIX
2345 standard in
2346 <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>
2347 </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">“<span class="quote">a</span>”</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>
2348 A character class is only valid in a regular expression inside the
2349 brackets of a character list.
2350 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2351 Note that the brackets in these class names are part of the symbolic
2352 names, and must be included in addition to the brackets delimiting the
2353 bracket list. For example, <span class="emphasis"><em>[[:digit:]]</em></span> is
2354 equivalent to <span class="emphasis"><em>[0-9]</em></span>.
2355 </p></div><p>
2356 Two additional special sequences can appear in character lists.  These
2357 apply to non-ASCII character sets, which can have single symbols (called
2358 collating elements) that are represented with more than one character,
2359 as well as several characters that are equivalent for collating or
2360 sorting purposes:
2361 </p><div class="variablelist"><dl><dt><span class="term">Collating Symbols</span></dt><dd><p>
2362 A collating symbol is a multi-character collating element enclosed in
2363 <span class="quote">“<span class="quote">[.</span>”</span> and <span class="quote">“<span class="quote">.]</span>”</span>.  For example, if
2364 <span class="quote">“<span class="quote">ch</span>”</span> is a collating element, then
2365 <span class="emphasis"><em>[[.ch.]]</em></span> is a regexp that matches this collating
2366 element, while <span class="emphasis"><em>[ch]</em></span> is a regexp that matches either
2367 <span class="quote">“<span class="quote">c</span>”</span> or <span class="quote">“<span class="quote">h</span>”</span>.
2368 </p></dd><dt><span class="term">Equivalence Classes</span></dt><dd><p>
2369 An equivalence class is a locale-specific name for a list of characters
2370 that are equivalent. The name is enclosed in <span class="quote">“<span class="quote">[=</span>”</span> and
2371 <span class="quote">“<span class="quote">=]</span>”</span>.  For example, the name <span class="quote">“<span class="quote">e</span>”</span> might be used
2372 to represent all of <span class="quote">“<span class="quote">e</span>”</span> with grave
2373 (<span class="quote">“<span class="quote">è</span>”</span>), <span class="quote">“<span class="quote">e</span>”</span> with acute
2374 (<span class="quote">“<span class="quote">é</span>”</span>) and <span class="quote">“<span class="quote">e</span>”</span>.  In this case,
2375 <span class="emphasis"><em>[[=e=]]</em></span> is a regexp that matches any of:
2376 <span class="quote">“<span class="quote">e</span>”</span> with grave (<span class="quote">“<span class="quote">è</span>”</span>), <span class="quote">“<span class="quote">e</span>”</span>
2377 with acute (<span class="quote">“<span class="quote">é</span>”</span>) and <span class="quote">“<span class="quote">e</span>”</span>.
2378 </p></dd></dl></div><p>
2379 A regular expression matching a single character may be followed by one
2380 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>.
2381 </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>
2382 Two regular expressions may be concatenated; the resulting regular
2383 expression matches any string formed by concatenating two substrings
2384 that respectively match the concatenated subexpressions.
2385 </p><p>
2386 Two regular expressions may be joined by the infix operator
2387 <span class="quote">“<span class="quote">|</span>”</span>; the resulting regular expression matches any string
2388 matching either subexpression.
2389 </p><p>
2390 Repetition takes precedence over concatenation, which in turn takes
2391 precedence over alternation.  A whole subexpression may be enclosed in
2392 parentheses to override these precedence rules.
2393 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2394 If you compile Mutt with the included regular expression engine, the
2395 following operators may also be used in regular expressions as described
2396 in <a class="xref" href="#regex-gnu-ext" title="Table 4.3. GNU regular expression extensions">Table 4.3, “GNU regular expression extensions”</a>.
2397 </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>\\&lt;</td><td>Matches the empty string at the beginning of a word</td></tr><tr><td>\\&gt;</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>
2398 Please note however that these operators are not defined by POSIX, so
2399 they may or may not be available in stock libraries on various systems.
2400 </p></div><div class="sect1" title="3. Patterns: Searching, Limiting and Tagging"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="patterns"></a>3. Patterns: Searching, Limiting and Tagging</h2></div></div></div><div class="sect2" title="3.1. Pattern Modifier"><div class="titlepage"><div><div><h3 class="title"><a id="patterns-modifier"></a>3.1. Pattern Modifier</h3></div></div></div><p>
2401 Many of Mutt's commands allow you to specify a pattern to match
2402 (<code class="literal">limit</code>, <code class="literal">tag-pattern</code>,
2403 <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>
2404 shows several ways to select messages.
2405 </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">“<span class="quote">date-sent</span>”</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">“<span class="quote">Sender</span>”</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">“<span class="quote">Sender</span>”</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">“<span class="quote">Message-ID</span>”</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 <span class="command"><strong>alternates</strong></span>)</td></tr><tr><td>~P</td><td>messages from you (consults <span class="command"><strong>alternates</strong></span>)</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">“<span class="quote">date-received</span>”</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">“<span class="quote">Subject</span>”</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">“<span class="quote">References</span>”</span> or <span class="quote">“<span class="quote">In-Reply-To</span>”</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">“<span class="quote">X-Label</span>”</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.56. 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
2406 containing messages matching <span class="emphasis"><em>PATTERN</em></span>, e.g. all
2407 threads containing messages from you: ~(~P)</td></tr></tbody></table></div></div><br class="table-break" /><p>
2408 Where <span class="emphasis"><em>EXPR</em></span> is a <a class="link" href="#regexp" title="2. Regular Expressions">regular expression</a>, and <span class="emphasis"><em>GROUP</em></span> is an
2409 <a class="link" href="#addrgroup" title="3. Address Groups">address group</a>.
2410 </p><p>
2411 *) The forms <span class="quote">“<span class="quote">&lt;[<span class="emphasis"><em>MAX</em></span>]</span>”</span>,
2412 <span class="quote">“<span class="quote">&gt;[<span class="emphasis"><em>MIN</em></span>]</span>”</span>,
2413 <span class="quote">“<span class="quote">[<span class="emphasis"><em>MIN</em></span>]-</span>”</span> and
2414 <span class="quote">“<span class="quote">-[<span class="emphasis"><em>MAX</em></span>]</span>”</span> are allowed, too.
2415 </p><p>
2416 **) The suffixes <span class="quote">“<span class="quote">K</span>”</span> and <span class="quote">“<span class="quote">M</span>”</span> are allowed to
2417 specify kilobyte and megabyte respectively.
2418 </p><p>
2419 Special attention has to be payed when using regular expressions inside
2420 of patterns.  Specifically, Mutt's parser for these patterns will strip
2421 one level of backslash (<span class="quote">“<span class="quote">\</span>”</span>), which is normally used for
2422 quoting.  If it is your intention to use a backslash in the regular
2423 expression, you will need to use two backslashes instead
2424 (<span class="quote">“<span class="quote">\\</span>”</span>). You can force Mutt to treat
2425 <span class="emphasis"><em>EXPR</em></span> as a simple string instead of a regular
2426 expression by using = instead of ~ in the pattern name. For example,
2427 <code class="literal">=b *.*</code> will find all messages that contain the
2428 literal string <span class="quote">“<span class="quote">*.*</span>”</span>. Simple string matches are less
2429 powerful than regular expressions but can be considerably faster. This
2430 is especially true for IMAP folders, because string matches can be
2431 performed on the server instead of by fetching every message. IMAP
2432 treats <code class="literal">=h</code> specially: it must be of the form
2433 <span class="quote">“<span class="quote">header: substring</span>”</span> and will not partially match header
2434 names. The substring part may be omitted if you simply wish to find
2435 messages containing a particular header without regard to its value.
2436 </p><p>
2437 Patterns matching lists of addresses (notably c, C, p, P and t) match if
2438 there is at least one match in the whole list. If you want to make sure
2439 that all elements of that list match, you need to prefix your pattern
2440 with <span class="quote">“<span class="quote">^</span>”</span>.  This example matches all mails which only has
2441 recipients from Germany.
2442 </p><div class="example"><a id="ex-recips"></a><p class="title"><b>Example 4.1. Matching all addresses in address lists</b></p><div class="example-contents"><pre class="screen">
2443 ^~C \.de$
2444 </pre></div></div><br class="example-break" /></div><div class="sect2" title="3.2. Simple Searches"><div class="titlepage"><div><div><h3 class="title"><a id="simple-searches"></a>3.2. Simple Searches</h3></div></div></div><p>
2445 Mutt supports two versions of so called <span class="quote">“<span class="quote">simple
2446 searches</span>”</span>. These are issued if the query entered for searching,
2447 limiting and similar operations does not seem to contain a valid pattern
2448 modifier (i.e. it does not contain one of these characters:
2449 <span class="quote">“<span class="quote">~</span>”</span>, <span class="quote">“<span class="quote">=</span>”</span> or <span class="quote">“<span class="quote">%</span>”</span>). If the query is
2450 supposed to contain one of these special characters, they must be
2451 escaped by prepending a backslash (<span class="quote">“<span class="quote">\</span>”</span>).
2452 </p><p>
2453 The first type is by checking whether the query string equals
2454 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>:
2455 If that is the case, Mutt will use the shown pattern modifier instead.
2456 If a keyword would conflict with your search keyword, you need to turn
2457 it into a regular expression to avoid matching the keyword table. For
2458 example, if you want to find all messages matching <span class="quote">“<span class="quote">flag</span>”</span>
2459 (using <a class="link" href="#simple-search" title="3.237. simple_search">$simple_search</a>)
2460 but don't want to match flagged messages, simply search for
2461 <span class="quote">“<span class="quote"><code class="literal">[f]lag</code></span>”</span>.
2462 </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>
2463 The second type of simple search is to build a complex search pattern
2464 using <a class="link" href="#simple-search" title="3.237. simple_search">$simple_search</a> as a
2465 template. Mutt will insert your query properly quoted and search for the
2466 composed complex query.
2467 </p></div><div class="sect2" title="3.3. Nesting and Boolean Operators"><div class="titlepage"><div><div><h3 class="title"><a id="complex-patterns"></a>3.3. Nesting and Boolean Operators</h3></div></div></div><p>
2468 Logical AND is performed by specifying more than one criterion.  For
2469 example:
2470 </p><pre class="screen">
2471 ~t mutt ~f elkins
2472 </pre><p>
2473 would select messages which contain the word <span class="quote">“<span class="quote">mutt</span>”</span> in the
2474 list of recipients <span class="emphasis"><em>and</em></span> that have the word
2475 <span class="quote">“<span class="quote">elkins</span>”</span> in the <span class="quote">“<span class="quote">From</span>”</span> header field.
2476 </p><p>
2477 Mutt also recognizes the following operators to create more complex
2478 search patterns:
2479 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
2480 ! — logical NOT operator
2481 </p></li><li class="listitem"><p>
2482 | — logical OR operator
2483 </p></li><li class="listitem"><p>
2484 () — logical grouping operator
2485 </p></li></ul></div><p>
2486 Here is an example illustrating a complex search pattern.  This pattern
2487 will select all messages which do not contain <span class="quote">“<span class="quote">mutt</span>”</span> in the
2488 <span class="quote">“<span class="quote">To</span>”</span> or <span class="quote">“<span class="quote">Cc</span>”</span> field and which are from
2489 <span class="quote">“<span class="quote">elkins</span>”</span>.
2490 </p><div class="example"><a id="ex-pattern-bool"></a><p class="title"><b>Example 4.2. Using boolean operators in patterns</b></p><div class="example-contents"><pre class="screen">
2491 !(~t mutt|~c mutt) ~f elkins
2492 </pre></div></div><br class="example-break" /><p>
2493 Here is an example using white space in the regular expression (note the
2494 <span class="quote">“<span class="quote">'</span>”</span> and <span class="quote">“<span class="quote">"</span>”</span> delimiters).  For this to match,
2495 the mail's subject must match the <span class="quote">“<span class="quote">^Junk +From +Me$</span>”</span> and it
2496 must be from either <span class="quote">“<span class="quote">Jim +Somebody</span>”</span> or <span class="quote">“<span class="quote">Ed
2497 +SomeoneElse</span>”</span>:
2498 </p><pre class="screen">
2499 '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
2500 </pre><div class="note" title="Note"><h3 class="title">Note</h3><p>
2501 If a regular expression contains parenthesis, or a vertical bar ("|"),
2502 you <span class="emphasis"><em>must</em></span> enclose the expression in double or single
2503 quotes since those characters are also used to separate different parts
2504 of Mutt's pattern language.  For example: <code class="literal">~f
2505 "me@(mutt\.org|cs\.hmc\.edu)"</code> Without the quotes, the
2506 parenthesis wouldn't end.  This would be separated to two OR'd patterns:
2507 <span class="emphasis"><em>~f me@(mutt\.org</em></span> and
2508 <span class="emphasis"><em>cs\.hmc\.edu)</em></span>. They are never what you want.
2509 </p></div></div><div class="sect2" title="3.4. Searching by Date"><div class="titlepage"><div><div><h3 class="title"><a id="date-patterns"></a>3.4. Searching by Date</h3></div></div></div><p>
2510 Mutt supports two types of dates, <span class="emphasis"><em>absolute</em></span> and
2511 <span class="emphasis"><em>relative</em></span>.
2512 </p><div class="sect3" title="3.4.1. Absolute Dates"><div class="titlepage"><div><div><h4 class="title"><a id="date-absolute"></a>3.4.1. Absolute Dates</h4></div></div></div><p>
2513 Dates <span class="emphasis"><em>must</em></span> be in DD/MM/YY format (month and year
2514 are optional, defaulting to the current month and year).  An example of
2515 a valid range of dates is:
2516 </p><pre class="screen">
2517 Limit to messages matching: ~d 20/1/95-31/10
2518 </pre><p>
2519 If you omit the minimum (first) date, and just specify
2520 <span class="quote">“<span class="quote">-DD/MM/YY</span>”</span>, all messages <span class="emphasis"><em>before</em></span> the
2521 given date will be selected.  If you omit the maximum (second) date, and
2522 specify <span class="quote">“<span class="quote">DD/MM/YY-</span>”</span>, all messages
2523 <span class="emphasis"><em>after</em></span> the given date will be selected.  If you
2524 specify a single date with no dash (<span class="quote">“<span class="quote">-</span>”</span>), only messages
2525 sent on the given date will be selected.
2526 </p><p>
2527 You can add error margins to absolute dates.  An error margin is a sign
2528 (+ or -), followed by a digit, followed by 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 sign
2529 by a <span class="quote">“<span class="quote">*</span>”</span> character, which is equivalent to giving identical
2530 plus and minus error margins.
2531 </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>
2532 Example: To select any messages two weeks around January 15, 2001, you'd
2533 use the following pattern:
2534 </p><pre class="screen">
2535 Limit to messages matching: ~d 15/1/2001*2w
2536 </pre></div><div class="sect3" title="3.4.2. Relative Dates"><div class="titlepage"><div><div><h4 class="title"><a id="dates-relative"></a>3.4.2. Relative Dates</h4></div></div></div><p>
2537 This type of date is relative to the current date, and may be specified
2538 as:
2539 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
2540 &gt;<span class="emphasis"><em>offset</em></span> for messages older than
2541 <span class="emphasis"><em>offset</em></span> units
2542 </p></li><li class="listitem"><p>
2543 &lt;<span class="emphasis"><em>offset</em></span> for messages newer than
2544 <span class="emphasis"><em>offset</em></span> units
2545 </p></li><li class="listitem"><p>
2546 =<span class="emphasis"><em>offset</em></span> for messages exactly
2547 <span class="emphasis"><em>offset</em></span> units old
2548 </p></li></ul></div><p>
2549 <span class="emphasis"><em>offset</em></span> is specified as a positive number with one
2550 of the units from <a class="xref" href="#tab-date-units" title="Table 4.6. Date units">Table 4.6, “Date units”</a>.
2551 </p><p>
2552 Example: to select messages less than 1 month old, you would use
2553 </p><pre class="screen">
2554 Limit to messages matching: ~d &lt;1m
2555 </pre><div class="note" title="Note"><h3 class="title">Note</h3><p>
2556 All dates used when searching are relative to the
2557 <span class="emphasis"><em>local</em></span> time zone, so unless you change the setting
2558 of your <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> to include a
2559 <code class="literal">%[...]</code> format, these are <span class="emphasis"><em>not</em></span> the
2560 dates shown in the main index.
2561 </p></div></div></div></div><div class="sect1" title="4. Using Tags"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tags"></a>4. Using Tags</h2></div></div></div><p>
2562 Sometimes it is desirable to perform an operation on a group of messages
2563 all at once rather than one at a time.  An example might be to save
2564 messages to a mailing list to a separate folder, or to delete all
2565 messages with a given subject.  To tag all messages matching a pattern,
2566 use the <code class="literal">&lt;tag-pattern&gt;</code> function, which is bound
2567 to <span class="quote">“<span class="quote">shift-T</span>”</span> by default.  Or you can select individual
2568 messages by hand using the <code class="literal">&lt;tag-message&gt;</code>
2569 function, which is bound to <span class="quote">“<span class="quote">t</span>”</span> by default.  See <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a> for Mutt's pattern matching syntax.
2570 </p><p>
2571 Once you have tagged the desired messages, you can use the
2572 <span class="quote">“<span class="quote">tag-prefix</span>”</span> operator, which is the <span class="quote">“<span class="quote">;</span>”</span>
2573 (semicolon) key by default.  When the <span class="quote">“<span class="quote">tag-prefix</span>”</span> operator
2574 is used, the <span class="emphasis"><em>next</em></span> operation will be applied to all
2575 tagged messages if that operation can be used in that manner.  If the
2576 <a class="link" href="#auto-tag" title="3.17. auto_tag">$auto_tag</a> variable is set, the next
2577 operation applies to the tagged messages automatically, without
2578 requiring the <span class="quote">“<span class="quote">tag-prefix</span>”</span>.
2579 </p><p>
2580 In <a class="link" href="#macro" title="8. Keyboard Macros"><span class="command"><strong>macro</strong></span>s</a> or <a class="link" href="#push" title="22. Adding Key Sequences to the Keyboard Buffer"><span class="command"><strong>push</strong></span></a> commands, you can use the
2581 <code class="literal">&lt;tag-prefix-cond&gt;</code> operator.  If there are no
2582 tagged messages, Mutt will <span class="quote">“<span class="quote">eat</span>”</span> the rest of the macro to
2583 abort it's execution.  Mutt will stop <span class="quote">“<span class="quote">eating</span>”</span> the macro
2584 when it encounters the <code class="literal">&lt;end-cond&gt;</code> operator;
2585 after this operator the rest of the macro will be executed as normal.
2586 </p></div><div class="sect1" title="5. Using Hooks"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="hooks"></a>5. Using Hooks</h2></div></div></div><p>
2587 A <span class="emphasis"><em>hook</em></span> is a concept found in many other programs
2588 which allows you to execute arbitrary commands before performing some
2589 operation.  For example, you may wish to tailor your configuration based
2590 upon which mailbox you are reading, or to whom you are sending mail.  In
2591 the Mutt world, a <span class="emphasis"><em>hook</em></span> consists of a <a class="link" href="#regexp" title="2. Regular Expressions">regular expression</a> or <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">pattern</a> along with a configuration
2592 option/command.  See:
2593
2594 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
2595 <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a>
2596 </p></li><li class="listitem"><p>
2597 <a class="link" href="#charset-hook" title="6. Defining Aliases for Character Sets"><span class="command"><strong>charset-hook</strong></span></a>
2598 </p></li><li class="listitem"><p>
2599 <a class="link" href="#crypt-hook" title="21. Choosing the Cryptographic Key of the Recipient"><span class="command"><strong>crypt-hook</strong></span></a>
2600 </p></li><li class="listitem"><p>
2601 <a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing"><span class="command"><strong>fcc-hook</strong></span></a>
2602 </p></li><li class="listitem"><p>
2603 <a class="link" href="#fcc-save-hook" title="18. Specify Default Save Filename and Default Fcc: Mailbox at Once"><span class="command"><strong>fcc-save-hook</strong></span></a>
2604 </p></li><li class="listitem"><p>
2605 <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a>
2606 </p></li><li class="listitem"><p>
2607 <a class="link" href="#iconv-hook"><span class="command"><strong>iconv-hook</strong></span></a>
2608 </p></li><li class="listitem"><p>
2609 <a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes"><span class="command"><strong>mbox-hook</strong></span></a>
2610 </p></li><li class="listitem"><p>
2611 <a class="link" href="#message-hook" title="20. Change Settings Before Formatting a Message"><span class="command"><strong>message-hook</strong></span></a>
2612 </p></li><li class="listitem"><p>
2613 <a class="link" href="#reply-hook"><span class="command"><strong>reply-hook</strong></span></a>
2614 </p></li><li class="listitem"><p>
2615 <a class="link" href="#save-hook" title="16. Specify Default Save Mailbox"><span class="command"><strong>save-hook</strong></span></a>
2616 </p></li><li class="listitem"><p>
2617 <a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients"><span class="command"><strong>send-hook</strong></span></a>
2618 </p></li><li class="listitem"><p>
2619 <a class="link" href="#send2-hook"><span class="command"><strong>send2-hook</strong></span></a>
2620 </p></li></ul></div><p>
2621
2622 for specific details on each type of <span class="emphasis"><em>hook</em></span> available.
2623 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2624 If a hook changes configuration settings, these changes remain effective
2625 until the end of the current Mutt session. As this is generally not
2626 desired, a <span class="quote">“<span class="quote">default</span>”</span> hook needs to be added before all
2627 other hooks of that type to restore configuration defaults.
2628 </p></div><div class="example"><a id="ex-default-hook"></a><p class="title"><b>Example 4.3. Specifying a <span class="quote">“<span class="quote">default</span>”</span> hook</b></p><div class="example-contents"><pre class="screen">
2629 send-hook . 'unmy_hdr From:'
2630 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
2631 </pre></div></div><br class="example-break" /><p>
2632 In <a class="xref" href="#ex-default-hook" title="Example 4.3. Specifying a “default” hook">Example 4.3, “Specifying a <span class="quote">“<span class="quote">default</span>”</span> hook”</a>, by default the value of <a class="link" href="#from" title="3.75. from">$from</a> and <a class="link" href="#realname" title="3.210. realname">$realname</a> is not overridden. When sending
2633 messages either To: or Cc: to <code class="literal">&lt;b@b.b&gt;</code>, the
2634 From: header is changed to <code class="literal">&lt;c@c.c&gt;</code>.
2635 </p><div class="sect2" title="5.1. Message Matching in Hooks"><div class="titlepage"><div><div><h3 class="title"><a id="pattern-hook"></a>5.1. Message Matching in Hooks</h3></div></div></div><p>
2636 Hooks that act upon messages (<span class="command"><strong>message-hook</strong></span>,
2637 <span class="command"><strong>reply-hook</strong></span>, <span class="command"><strong>send-hook</strong></span>,
2638 <span class="command"><strong>send2-hook</strong></span>, <span class="command"><strong>save-hook</strong></span>,
2639 <span class="command"><strong>fcc-hook</strong></span>) are evaluated in a slightly different
2640 manner. For the other types of hooks, a <a class="link" href="#regexp" title="2. Regular Expressions">regular
2641 expression</a> is sufficient.  But in dealing with messages a finer
2642 grain of control is needed for matching since for different purposes you
2643 want to match different criteria.
2644 </p><p>
2645 Mutt allows the use of the <a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">search
2646 pattern</a> language for matching messages in hook commands.  This
2647 works in exactly the same way as it would when
2648 <span class="emphasis"><em>limiting</em></span> or <span class="emphasis"><em>searching</em></span> the
2649 mailbox, except that you are restricted to those operators which match
2650 information Mutt extracts from the header of the message (i.e., from,
2651 to, cc, date, subject, etc.).
2652 </p><p>
2653 For example, if you wanted to set your return address based upon sending
2654 mail to a specific address, you could do something like:
2655 </p><pre class="screen">
2656 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User &lt;user@host&gt;'
2657 </pre><p>
2658 which would execute the given command when sending mail to
2659 <span class="emphasis"><em>me@cs.hmc.edu</em></span>.
2660 </p><p>
2661 However, it is not required that you write the pattern to match using
2662 the full searching language.  You can still specify a simple
2663 <span class="emphasis"><em>regular expression</em></span> like the other hooks, in which
2664 case Mutt will translate your pattern into the full language, using the
2665 translation specified by the <a class="link" href="#default-hook" title="3.48. default_hook">$default_hook</a> variable.  The pattern is
2666 translated at the time the hook is declared, so the value of <a class="link" href="#default-hook" title="3.48. default_hook">$default_hook</a> that is in effect at that
2667 time will be used.
2668 </p></div></div><div class="sect1" title="6. External Address Queries"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="query"></a>6. External Address Queries</h2></div></div></div><p>
2669 Mutt supports connecting to external directory databases such as LDAP,
2670 ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt
2671 using a simple interface.  Using the <a class="link" href="#query-command" title="3.204. query_command">$query_command</a> variable, you specify the
2672 wrapper command to use.  For example:
2673 </p><pre class="screen">
2674 set query_command = "mutt_ldap_query.pl %s"
2675 </pre><p>
2676 The wrapper script should accept the query on the command-line.  It
2677 should return a one line message, then each matching response on a
2678 single line, each line containing a tab separated address then name then
2679 some other optional information.  On error, or if there are no matching
2680 addresses, return a non-zero exit code and a one line error message.
2681 </p><p>
2682 An example multiple response output:
2683 </p><pre class="screen">
2684 Searching database ... 20 entries ... 3 matching:
2685 me@cs.hmc.edu           Michael Elkins  mutt dude
2686 blong@fiction.net       Brandon Long    mutt and more
2687 roessler@does-not-exist.org        Thomas Roessler mutt pgp
2688 </pre><p>
2689 There are two mechanisms for accessing the query function of Mutt.  One
2690 is to do a query from the index menu using the
2691 <code class="literal">&lt;query&gt;</code> function (default: Q).  This will
2692 prompt for a query, then bring up the query menu which will list the
2693 matching responses.  From the query menu, you can select addresses to
2694 create aliases, or to mail.  You can tag multiple addresses to mail,
2695 start a new query, or have a new query appended to the current
2696 responses.
2697 </p><p>
2698 The other mechanism for accessing the query function is for address
2699 completion, similar to the alias completion.  In any prompt for address
2700 entry, you can use the <code class="literal">&lt;complete-query&gt;</code>
2701 function (default: ^T) to run a query based on the current address you
2702 have typed.  Like aliases, Mutt will look for what you have typed back
2703 to the last space or comma.  If there is a single response for that
2704 query, Mutt will expand the address in place.  If there are multiple
2705 responses, Mutt will activate the query menu.  At the query menu, you
2706 can select one or more addresses to be added to the prompt.
2707 </p></div><div class="sect1" title="7. Mailbox Formats"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailbox-formats"></a>7. Mailbox Formats</h2></div></div></div><p>
2708 Mutt supports reading and writing of four different local mailbox
2709 formats: mbox, MMDF, MH and Maildir.  The mailbox type is auto detected,
2710 so there is no need to use a flag for different mailbox types.  When
2711 creating new mailboxes, Mutt uses the default specified with the <a class="link" href="#mbox-type" title="3.128. mbox_type">$mbox_type</a> variable. A short description of
2712 the formats follows.
2713 </p><p>
2714 <span class="emphasis"><em>mbox</em></span>.  This is a widely used mailbox format for
2715 UNIX.  All messages are stored in a single file.  Each message has a
2716 line of the form:
2717 </p><pre class="screen">
2718 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
2719 </pre><p>
2720 to denote the start of a new message (this is often referred to as the
2721 <span class="quote">“<span class="quote">From_</span>”</span> line). The mbox format requires mailbox locking, is
2722 prone to mailbox corruption with concurrently writing clients or
2723 misinterpreted From_ lines. Depending on the environment, new mail
2724 detection can be unreliable. Mbox folders are fast to open and easy to
2725 archive.
2726 </p><p>
2727 <span class="emphasis"><em>MMDF</em></span>.  This is a variant of the
2728 <span class="emphasis"><em>mbox</em></span> format.  Each message is surrounded by lines
2729 containing <span class="quote">“<span class="quote">^A^A^A^A</span>”</span> (four times control-A's). The same
2730 problems as for mbox apply (also with finding the right message
2731 separator as four control-A's may appear in message bodies).
2732 </p><p>
2733 <span class="emphasis"><em>MH</em></span>. A radical departure from
2734 <span class="emphasis"><em>mbox</em></span> and <span class="emphasis"><em>MMDF</em></span>, a mailbox
2735 consists of a directory and each message is stored in a separate file.
2736 The filename indicates the message number (however, this is may not
2737 correspond to the message number Mutt displays). Deleted messages are
2738 renamed with a comma (<span class="quote">“<span class="quote">,</span>”</span>) prepended to the filename. Mutt
2739 detects this type of mailbox by looking for either
2740 <code class="literal">.mh_sequences</code> or <code class="literal">.xmhcache</code> files
2741 (needed to distinguish normal directories from MH mailboxes). MH is more
2742 robust with concurrent clients writing the mailbox, but still may suffer
2743 from lost flags; message corruption is less likely to occur than with
2744 mbox/mmdf. It's usually slower to open compared to mbox/mmdf since many
2745 small files have to be read (Mutt provides <a class="xref" href="#header-caching" title="7.1. Header Caching">Section 7.1, “Header Caching”</a> to greatly speed this process up).  Depending
2746 on the environment, MH is not very disk-space efficient.
2747 </p><p>
2748 <span class="emphasis"><em>Maildir</em></span>.  The newest of the mailbox formats, used
2749 by the Qmail MTA (a replacement for sendmail).  Similar to
2750 <span class="emphasis"><em>MH</em></span>, except that it adds three subdirectories of the
2751 mailbox: <span class="emphasis"><em>tmp</em></span>, <span class="emphasis"><em>new</em></span> and
2752 <span class="emphasis"><em>cur</em></span>.  Filenames for the messages are chosen in such
2753 a way they are unique, even when two programs are writing the mailbox
2754 over NFS, which means that no file locking is needed and corruption is
2755 very unlikely. Maildir maybe slower to open without caching in Mutt, it
2756 too is not very disk-space efficient depending on the environment. Since
2757 no additional files are used for metadata (which is embedded in the
2758 message filenames) and Maildir is locking-free, it's easy to sync across
2759 different machines using file-level synchronization tools.
2760 </p></div><div class="sect1" title="8. Mailbox Shortcuts"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="shortcuts"></a>8. Mailbox Shortcuts</h2></div></div></div><p>
2761 There are a number of built in shortcuts which refer to specific
2762 mailboxes.  These shortcuts can be used anywhere you are prompted for a
2763 file or mailbox path or in path-related configuration variables. Note
2764 that these only work at the beginning of a string.
2765 </p><div class="table"><a id="tab-mailbox-shortcuts"></a><p class="title"><b>Table 4.7. Mailbox shortcuts</b></p><div class="table-contents"><table summary="Mailbox shortcuts" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Shortcut</th><th>Refers to...</th></tr></thead><tbody><tr><td><code class="literal">!</code></td><td>your <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a> (incoming) mailbox</td></tr><tr><td><code class="literal">&gt;</code></td><td>your <a class="link" href="#mbox" title="3.127. mbox">$mbox</a> file</td></tr><tr><td><code class="literal">&lt;</code></td><td>your <a class="link" href="#record" title="3.212. record">$record</a> file</td></tr><tr><td><code class="literal">^</code></td><td>the current mailbox</td></tr><tr><td><code class="literal">-</code> or <code class="literal">!!</code></td><td>the file you've last visited</td></tr><tr><td><code class="literal">~</code></td><td>your home directory</td></tr><tr><td><code class="literal">=</code> or <code class="literal">+</code></td><td>your <a class="link" href="#folder" title="3.66. folder">$folder</a> directory</td></tr><tr><td><span class="emphasis"><em>@alias</em></span></td><td>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</td></tr></tbody></table></div></div><br class="table-break" /><p>
2766 For example, to store a copy of outgoing messages in the folder they
2767 were composed in, a <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a> can be used
2768 to set <a class="link" href="#record" title="3.212. record">$record</a>:
2769 </p><pre class="screen">
2770 folder-hook . 'set record=^'</pre></div><div class="sect1" title="9. Handling Mailing Lists"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-lists"></a>9. Handling Mailing Lists</h2></div></div></div><p>
2771 Mutt has a few configuration options that make dealing with large
2772 amounts of mail easier.  The first thing you must do is to let Mutt know
2773 what addresses you consider to be mailing lists (technically this does
2774 not have to be a mailing list, but that is what it is most often used
2775 for), and what lists you are subscribed to.  This is accomplished
2776 through the use of the <a class="link" href="#lists" title="12. Mailing Lists"><span class="command"><strong>lists</strong></span>
2777 and <span class="command"><strong>subscribe</strong></span></a> commands in your
2778 <code class="literal">.muttrc</code>.
2779 </p><p>
2780 Now that Mutt knows what your mailing lists are, it can do several
2781 things, the first of which is the ability to show the name of a list
2782 through which you received a message (i.e., of a subscribed list) in the
2783 <span class="emphasis"><em>index</em></span> menu display.  This is useful to distinguish
2784 between personal and list mail in the same mailbox.  In the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable, the expando
2785 <span class="quote">“<span class="quote">%L</span>”</span> will print the string <span class="quote">“<span class="quote">To &lt;list&gt;</span>”</span>
2786 when <span class="quote">“<span class="quote">list</span>”</span> appears in the <span class="quote">“<span class="quote">To</span>”</span> field, and
2787 <span class="quote">“<span class="quote">Cc &lt;list&gt;</span>”</span> when it appears in the <span class="quote">“<span class="quote">Cc</span>”</span>
2788 field (otherwise it prints the name of the author).
2789 </p><p>
2790 Often times the <span class="quote">“<span class="quote">To</span>”</span> and <span class="quote">“<span class="quote">Cc</span>”</span> fields in
2791 mailing list messages tend to get quite large. Most people do not bother
2792 to remove the author of the message they reply to from the list,
2793 resulting in two or more copies being sent to that person.  The
2794 <code class="literal">&lt;list-reply&gt;</code> function, which by default is
2795 bound to <span class="quote">“<span class="quote">L</span>”</span> in the <span class="emphasis"><em>index</em></span> menu and
2796 <span class="emphasis"><em>pager</em></span>, helps reduce the clutter by only replying to
2797 the known mailing list addresses instead of all recipients (except as
2798 specified by <code class="literal">Mail-Followup-To</code>, see below).
2799 </p><p>
2800 Mutt also supports the <code class="literal">Mail-Followup-To</code> header.  When
2801 you send a message to a list of recipients which includes one or several
2802 subscribed mailing lists, and if the <a class="link" href="#followup-to" title="3.68. followup_to">$followup_to</a> option is set, Mutt will
2803 generate a Mail-Followup-To header which contains all the recipients to
2804 whom you send this message, but not your address. This indicates that
2805 group-replies or list-replies (also known as <span class="quote">“<span class="quote">followups</span>”</span>)
2806 to this message should only be sent to the original recipients of the
2807 message, and not separately to you - you'll receive your copy through
2808 one of the mailing lists you are subscribed to.
2809 </p><p>
2810 Conversely, when group-replying or list-replying to a message which has
2811 a <code class="literal">Mail-Followup-To</code> header, Mutt will respect this
2812 header if the <a class="link" href="#honor-followup-to" title="3.92. honor_followup_to">$honor_followup_to</a> configuration
2813 variable is set.  Using <a class="link" href="#list-reply">list-reply</a>
2814 will in this case also make sure that the reply goes to the mailing
2815 list, even if it's not specified in the list of recipients in the
2816 <code class="literal">Mail-Followup-To</code>.
2817 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2818 When header editing is enabled, you can create a
2819 <code class="literal">Mail-Followup-To</code> header manually.  Mutt will only
2820 auto-generate this header if it doesn't exist when you send the message.
2821 </p></div><p>
2822 The other method some mailing list admins use is to generate a
2823 <span class="quote">“<span class="quote">Reply-To</span>”</span> field which points back to the mailing list
2824 address rather than the author of the message.  This can create problems
2825 when trying to reply directly to the author in private, since most mail
2826 clients will automatically reply to the address given in the
2827 <span class="quote">“<span class="quote">Reply-To</span>”</span> field.  Mutt uses the <a class="link" href="#reply-to" title="3.215. reply_to">$reply_to</a> variable to help decide which
2828 address to use.  If set to <span class="emphasis"><em>ask-yes</em></span> or
2829 <span class="emphasis"><em>ask-no</em></span>, you will be prompted as to whether or not
2830 you would like to use the address given in the <span class="quote">“<span class="quote">Reply-To</span>”</span>
2831 field, or reply directly to the address given in the <span class="quote">“<span class="quote">From</span>”</span>
2832 field.  When set to <span class="emphasis"><em>yes</em></span>, the
2833 <span class="quote">“<span class="quote">Reply-To</span>”</span> field will be used when present.
2834 </p><p>
2835 The <span class="quote">“<span class="quote">X-Label:</span>”</span> header field can be used to further identify
2836 mailing lists or list subject matter (or just to annotate messages
2837 individually).  The <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>
2838 variable's <span class="quote">“<span class="quote">%y</span>”</span> and <span class="quote">“<span class="quote">%Y</span>”</span> expandos can be used
2839 to expand <span class="quote">“<span class="quote">X-Label:</span>”</span> fields in the index, and Mutt's
2840 pattern-matcher can match regular expressions to <span class="quote">“<span class="quote">X-Label:</span>”</span>
2841 fields with the <span class="quote">“<span class="quote">~y</span>”</span> selector.  <span class="quote">“<span class="quote">X-Label:</span>”</span> is
2842 not a standard message header field, but it can easily be inserted by
2843 procmail and other mail filtering agents.
2844 </p><p>
2845 Lastly, Mutt has the ability to <a class="link" href="#sort" title="3.264. sort">sort</a> the
2846 mailbox into <a class="link" href="#threads" title="5.3. Threaded Mode">threads</a>.  A thread is a
2847 group of messages which all relate to the same subject.  This is usually
2848 organized into a tree-like structure where a message and all of its
2849 replies are represented graphically.  If you've ever used a threaded
2850 news client, this is the same concept.  It makes dealing with large
2851 volume mailing lists easier because you can easily delete uninteresting
2852 threads and quickly find topics of value.
2853 </p></div><div class="sect1" title="10. New Mail Detection"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="new-mail"></a>10. New Mail Detection</h2></div></div></div><p>
2854 Mutt supports setups with multiple folders, allowing all of them to be
2855 monitored for new mail (see <a class="xref" href="#mailboxes" title="14. Monitoring Incoming Mail">Section 14, “Monitoring Incoming Mail”</a> for details).
2856 </p><div class="sect2" title="10.1. How New Mail Detection Works"><div class="titlepage"><div><div><h3 class="title"><a id="new-mail-formats"></a>10.1. How New Mail Detection Works</h3></div></div></div><p>
2857 For Mbox and Mmdf folders, new mail is detected by comparing access
2858 and/or modification times of files: Mutt assumes a folder has new mail
2859 if it wasn't accessed after it was last modified. Utilities like
2860 <code class="literal">biff</code> or <code class="literal">frm</code> or any other program
2861 which accesses the mailbox might cause Mutt to never detect new mail for
2862 that mailbox if they do not properly reset the access time. Other
2863 possible causes of Mutt not detecting new mail in these folders are
2864 backup tools (updating access times) or filesystems mounted without
2865 access time update support (for Linux systems, see the
2866 <code class="literal">relatime</code> option).
2867 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
2868 Contrary to older Mutt releases, it now maintains the new mail status of
2869 a folder by properly resetting the access time if the folder contains at
2870 least one message which is neither read, nor deleted, nor marked as old.
2871 </p></div><p>
2872 In cases where new mail detection for Mbox or Mmdf folders appears to be
2873 unreliable, the <a class="link" href="#check-mbox-size" title="3.26. check_mbox_size">$check_mbox_size</a>
2874 option can be used to make Mutt track and consult file sizes for new
2875 mail detection instead which won't work for size-neutral changes.
2876 </p><p>
2877 New mail for Maildir is assumed if there is one message in the
2878 <code class="literal">new/</code> subdirectory which is not marked deleted (see
2879 <a class="link" href="#maildir-trash" title="3.123. maildir_trash">$maildir_trash</a>). For MH folders, a
2880 mailbox is considered having new mail if there's at least one message in
2881 the <span class="quote">“<span class="quote">unseen</span>”</span> sequence as specified by <a class="link" href="#mh-seq-unseen" title="3.140. mh_seq_unseen">$mh_seq_unseen</a>.
2882 </p><p>
2883 Mutt does not poll POP3 folders for new mail, it only periodically
2884 checks the currently opened folder (if it's a POP3 folder).
2885 </p><p>
2886 For IMAP, by default Mutt uses recent message counts provided by the
2887 server to detect new mail. If the <a class="link" href="#imap-idle" title="3.100. imap_idle">$imap_idle</a> option is set, it'll use the IMAP
2888 IDLE extension if advertised by the server.
2889 </p></div><div class="sect2" title="10.2. Polling For New Mail"><div class="titlepage"><div><div><h3 class="title"><a id="new-mail-polling"></a>10.2. Polling For New Mail</h3></div></div></div><p>
2890 When in the index menu and being idle (also see <a class="link" href="#timeout" title="3.292. timeout">$timeout</a>), Mutt periodically checks for new
2891 mail in all folders which have been configured via the
2892 <span class="command"><strong>mailboxes</strong></span> command. The interval depends on the folder
2893 type: for local/IMAP folders it consults <a class="link" href="#mail-check" title="3.118. mail_check">$mail_check</a> and <a class="link" href="#pop-checkinterval" title="3.188. pop_checkinterval">$pop_checkinterval</a> for POP folders.
2894 </p><p>
2895 Outside the index menu the directory browser supports checking for new
2896 mail using the <code class="literal">&lt;check-new&gt;</code> function which is
2897 unbound by default. Pressing TAB will bring up a menu showing the files
2898 specified by the <span class="command"><strong>mailboxes</strong></span> command, and indicate
2899 which contain new messages. Mutt will automatically enter this mode when
2900 invoked from the command line with the <code class="literal">-y</code> option.
2901 </p><p>
2902 For the pager, index and directory browser menus, Mutt contains the
2903 <code class="literal">&lt;buffy-list&gt;</code> function (bound to
2904 <span class="quote">“<span class="quote">.</span>”</span> by default) which will print a list of folders with new
2905 mail in the command line at the bottom of the screen.
2906 </p><p>
2907 For the index, by default Mutt displays the number of mailboxes with new
2908 mail in the status bar, please refer to the <a class="link" href="#status-format" title="3.283. status_format">$status_format</a> variable for details.
2909 </p><p>
2910 When changing folders, Mutt fills the prompt with the first folder from
2911 the mailboxes list containing new mail (if any), pressing
2912 <code class="literal">&lt;Space&gt;</code> will cycle through folders with new
2913 mail.  The (by default unbound) function
2914 <code class="literal">&lt;next-unread-mailbox&gt;</code> in the index can be used
2915 to immediately open the next folder with unread mail (if any).
2916 </p></div></div><div class="sect1" title="11. Editing Threads"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing-threads"></a>11. Editing Threads</h2></div></div></div><p>
2917 Mutt has the ability to dynamically restructure threads that are broken
2918 either by misconfigured software or bad behavior from some
2919 correspondents. This allows to clean your mailboxes from these
2920 annoyances which make it hard to follow a discussion.
2921 </p><div class="sect2" title="11.1. Linking Threads"><div class="titlepage"><div><div><h3 class="title"><a id="link-threads"></a>11.1. Linking Threads</h3></div></div></div><p>
2922 Some mailers tend to <span class="quote">“<span class="quote">forget</span>”</span> to correctly set the
2923 <span class="quote">“<span class="quote">In-Reply-To:</span>”</span> and <span class="quote">“<span class="quote">References:</span>”</span> headers when
2924 replying to a message. This results in broken discussions because Mutt
2925 has not enough information to guess the correct threading.  You can fix
2926 this by tagging the reply, then moving to the parent message and using
2927 the <code class="literal">&lt;link-threads&gt;</code> function (bound to &amp; by
2928 default). The reply will then be connected to this parent message.
2929 </p><p>
2930 You can also connect multiple children at once, tagging them and using
2931 the <code class="literal">&lt;tag-prefix&gt;</code> command (<span class="quote">“<span class="quote">;</span>”</span>) or
2932 the <a class="link" href="#auto-tag" title="3.17. auto_tag">$auto_tag</a> option.
2933 </p></div><div class="sect2" title="11.2. Breaking Threads"><div class="titlepage"><div><div><h3 class="title"><a id="break-threads"></a>11.2. Breaking Threads</h3></div></div></div><p>
2934 On mailing lists, some people are in the bad habit of starting a new
2935 discussion by hitting <span class="quote">“<span class="quote">reply</span>”</span> to any message from the list
2936 and changing the subject to a totally unrelated one.  You can fix such
2937 threads by using the <code class="literal">&lt;break-thread&gt;</code> function
2938 (bound by default to #), which will turn the subthread starting from the
2939 current message into a whole different thread.
2940 </p></div></div><div class="sect1" title="12. Delivery Status Notification (DSN) Support"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="dsn"></a>12. Delivery Status Notification (DSN) Support</h2></div></div></div><p>
2941 RFC1894 defines a set of MIME content types for relaying information
2942 about the status of electronic mail messages.  These can be thought of
2943 as <span class="quote">“<span class="quote">return receipts.</span>”</span>
2944 </p><p>
2945 To support DSN, there are two variables. <a class="link" href="#dsn-notify" title="3.54. dsn_notify">$dsn_notify</a> is used to request receipts for
2946 different results (such as failed message, message delivered, etc.).
2947 <a class="link" href="#dsn-return" title="3.55. dsn_return">$dsn_return</a> requests how much of your
2948 message should be returned with the receipt (headers or full message).
2949 </p><p>
2950 When using <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> for mail delivery,
2951 you need to use either Berkeley sendmail 8.8.x (or greater) a MTA
2952 supporting DSN command line options compatible to Sendmail: The -N and
2953 -R options can be used by the mail client to make requests as to what
2954 type of status messages should be returned. Please consider your MTA
2955 documentation whether DSN is supported.
2956 </p><p>
2957 For SMTP delivery using <a class="link" href="#smtp-url" title="3.263. smtp_url">$smtp_url</a>, it
2958 depends on the capabilities announced by the server whether Mutt will
2959 attempt to request DSN or not.
2960 </p></div><div class="sect1" title="13. Start a WWW Browser on URLs"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="urlview"></a>13. Start a WWW Browser on URLs</h2></div></div></div><p>
2961 If a message contains URLs, it is efficient to get a menu with all the
2962 URLs and start a WWW browser on one of them.  This functionality is
2963 provided by the external urlview program which can be retrieved at
2964 <a class="ulink" href="ftp://ftp.mutt.org/mutt/contrib/" target="_top">ftp://ftp.mutt.org/mutt/contrib/</a>
2965 and the configuration commands:
2966 </p><pre class="screen">
2967 macro index \cb |urlview\n
2968 macro pager \cb |urlview\n
2969 </pre></div><div class="sect1" title="14. Miscellany"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="misc-topics"></a>14. Miscellany</h2></div></div></div><p>
2970 This section documents various features that fit nowhere else.
2971 </p><div class="variablelist"><dl><dt><span class="term">
2972 Address normalization
2973 </span></dt><dd><p>
2974 Mutt normalizes all e-mail addresses to the simplest form possible. If
2975 an address contains a realname, the form <span class="emphasis"><em>Joe User
2976 &lt;joe@example.com&gt;</em></span> is used and the pure e-mail address
2977 without angle brackets otherwise, i.e. just
2978 <span class="emphasis"><em>joe@example.com</em></span>.
2979 </p><p>
2980 This normalization affects all headers Mutt generates including aliases.
2981 </p></dd><dt><span class="term">
2982 Initial folder selection
2983 </span></dt><dd><p>
2984 The folder Mutt opens at startup is determined as follows: the folder
2985 specified in the <code class="literal">$MAIL</code> environment variable if
2986 present. Otherwise, the value of <code class="literal">$MAILDIR</code> is taken
2987 into account. If that isn't present either, Mutt takes the user's
2988 mailbox in the mailspool as determined at compile-time (which may also
2989 reside in the home directory). The <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a> setting overrides this
2990 selection. Highest priority has the mailbox given with the
2991 <code class="literal">-f</code> command line option.
2992 </p></dd></dl></div></div></div><div class="chapter" title="Chapter 5. Mutt's MIME Support"><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-overview">1.1. MIME Overview</a></span></dt><dt><span class="sect2"><a href="#mime-pager">1.2. Viewing MIME Messages in the Pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.3. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.4. 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 Mailcap</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>
2993 Quite a bit of effort has been made to make Mutt the premier text-mode
2994 MIME MUA.  Every effort has been made to provide the functionality that
2995 the discerning MIME user requires, and the conformance to the standards
2996 wherever possible.  When configuring Mutt for MIME, there are two extra
2997 types of configuration files which Mutt uses.  One is the
2998 <code class="literal">mime.types</code> file, which contains the mapping of file
2999 extensions to IANA MIME types.  The other is the
3000 <code class="literal">mailcap</code> file, which specifies the external commands
3001 to use for handling specific MIME types.
3002 </p><div class="sect1" title="1. Using MIME in Mutt"><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><div class="sect2" title="1.1. MIME Overview"><div class="titlepage"><div><div><h3 class="title"><a id="mime-overview"></a>1.1. MIME Overview</h3></div></div></div><p>
3003 MIME is short for <span class="quote">“<span class="quote">Multipurpose Internet Mail Extension</span>”</span>
3004 and describes mechanisms to internationalize and structure mail
3005 messages. Before the introduction of MIME, messages had a single text
3006 part and were limited to us-ascii header and content. With MIME,
3007 messages can have attachments (and even attachments which itself have
3008 attachments and thus form a tree structure), nearly arbitrary characters
3009 can be used for sender names, recipients and subjects.
3010 </p><p>
3011 Besides the handling of non-ascii characters in message headers, to Mutt
3012 the most important aspect of MIME are so-called MIME types. These are
3013 constructed using a <span class="emphasis"><em>major</em></span> and
3014 <span class="emphasis"><em>minor</em></span> type separated by a forward slash.  These
3015 specify details about the content that follows. Based upon these, Mutt
3016 decides how to handle this part. The most popular major type is
3017 <span class="quote">“<span class="quote"><code class="literal">text</code></span>”</span> with minor types for plain text,
3018 HTML and various other formats. Major types also exist for images,
3019 audio, video and of course general application data (e.g. to separate
3020 cryptographically signed data with a signature, send office documents,
3021 and in general arbitrary binary data). There's also the
3022 <code class="literal">multipart</code> major type which represents the root of a
3023 subtree of MIME parts. A list of supported MIME types can be found in
3024 <a class="xref" href="#supported-mime-types" title="Table 5.1. Supported MIME types">Table 5.1, “Supported MIME types”</a>.
3025 </p><p>
3026 MIME also defines a set of encoding schemes for transporting MIME
3027 content over the network: <code class="literal">7bit</code>,
3028 <code class="literal">8bit</code>, <code class="literal">quoted-printable</code>,
3029 <code class="literal">base64</code> and <code class="literal">binary</code>. There're some
3030 rules when to choose what for encoding headers and/or body (if needed),
3031 and Mutt will in general make a good choice.
3032 </p><p>
3033 Mutt does most of MIME encoding/decoding behind the scenes to form
3034 messages conforming to MIME on the sending side. On reception, it can be
3035 flexibly configured as to how what MIME structure is displayed (and if
3036 it's displayed): these decisions are based on the content's MIME type.
3037 There are three areas/menus in dealing with MIME: the pager (while
3038 viewing a message), the attachment menu and the compose menu.
3039 </p></div><div class="sect2" title="1.2. Viewing MIME Messages in the Pager"><div class="titlepage"><div><div><h3 class="title"><a id="mime-pager"></a>1.2. Viewing MIME Messages in the Pager</h3></div></div></div><p>
3040 When you select a message from the index and view it in the pager, Mutt
3041 decodes as much of a message as possible to a text representation.  Mutt
3042 internally supports a number of MIME types, including the
3043 <code class="literal">text</code> major type (with all minor types), the
3044 <code class="literal">message/rfc822</code> (mail messages) type and some
3045 <code class="literal">multipart</code> types. In addition, it recognizes a variety
3046 of PGP MIME types, including PGP/MIME and
3047 <code class="literal">application/pgp</code>.
3048 </p><p>
3049 Mutt will denote attachments with a couple lines describing them.
3050 These lines are of the form:
3051 </p><pre class="screen">
3052 [-- Attachment #1: Description --]
3053 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
3054 </pre><p>
3055 Where the <span class="emphasis"><em>Description</em></span> is the description or
3056 filename given for the attachment, and the <span class="emphasis"><em>Encoding</em></span>
3057 is one of the already mentioned content encodings.
3058 </p><p>
3059 If Mutt cannot deal with a MIME type, it will display a message like:
3060 </p><pre class="screen">
3061 [-- image/gif is unsupported (use 'v' to view this part) --]
3062 </pre></div><div class="sect2" title="1.3. The Attachment Menu"><div class="titlepage"><div><div><h3 class="title"><a id="attach-menu"></a>1.3. The Attachment Menu</h3></div></div></div><p>
3063 The default binding for <code class="literal">&lt;view-attachments&gt;</code> is
3064 <span class="quote">“<span class="quote">v</span>”</span>, which displays the attachment menu for a message.  The
3065 attachment menu displays a list of the attachments in a message.  From
3066 the attachment menu, you can save, print, pipe, delete, and view
3067 attachments.  You can apply these operations to a group of attachments
3068 at once, by tagging the attachments and by using the
3069 <code class="literal">&lt;tag-prefix&gt;</code> operator.  You can also reply to
3070 the current message from this menu, and only the current attachment (or
3071 the attachments tagged) will be quoted in your reply.  You can view
3072 attachments as text, or view them using the mailcap viewer definition
3073 (the mailcap mechanism is explained later in detail).
3074 </p><p>
3075 Finally, you can apply the usual message-related functions (like <a class="link" href="#resend-message"><code class="literal">&lt;resend-message&gt;</code></a>,
3076 and the <code class="literal">&lt;reply&gt;</code> and
3077 <code class="literal">&lt;forward&gt;</code> functions) to attachments of type
3078 <code class="literal">message/rfc822</code>.
3079 </p><p>
3080 See table <a class="xref" href="#tab-attachment-bindings" title="Table 9.7. Default Attachment Menu Bindings">Table 9.7, “Default Attachment Menu Bindings”</a> for all available
3081 functions.
3082 </p></div><div class="sect2" title="1.4. The Compose Menu"><div class="titlepage"><div><div><h3 class="title"><a id="compose-menu"></a>1.4. The Compose Menu</h3></div></div></div><p>
3083 The compose menu is the menu you see before you send a message.  It
3084 allows you to edit the recipient list, the subject, and other aspects of
3085 your message.  It also contains a list of the attachments of your
3086 message, including the main body.  From this menu, you can print, copy,
3087 filter, pipe, edit, compose, review, and rename an attachment or a list
3088 of tagged attachments.  You can also modifying the attachment
3089 information, notably the type, encoding and description.
3090 </p><p>
3091 Attachments appear as follows by default:
3092 </p><pre class="screen">
3093 - 1 [text/plain, 7bit, 1K]           /tmp/mutt-euler-8082-0 &lt;no description&gt;
3094   2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz &lt;no description&gt;
3095 </pre><p>
3096 The <span class="quote">“<span class="quote">-</span>”</span> denotes that Mutt will delete the file after
3097 sending (or postponing, or canceling) the message.  It can be toggled
3098 with the <code class="literal">&lt;toggle-unlink&gt;</code> command (default: u).
3099 The next field is the MIME content-type, and can be changed with the
3100 <code class="literal">&lt;edit-type&gt;</code> command (default: ^T).  The next
3101 field is the encoding for the attachment, which allows a binary message
3102 to be encoded for transmission on 7bit links.  It can be changed with
3103 the <code class="literal">&lt;edit-encoding&gt;</code> command (default: ^E).  The
3104 next field is the size of the attachment, rounded to kilobytes or
3105 megabytes.  The next field is the filename, which can be changed with
3106 the <code class="literal">&lt;rename-file&gt;</code> command (default: R).  The
3107 final field is the description of the attachment, and can be changed
3108 with the <code class="literal">&lt;edit-description&gt;</code> command (default:
3109 d). See <a class="link" href="#attach-format" title="3.13. attach_format">$attach_format</a> for a full
3110 list of available expandos to format this display to your needs.
3111 </p></div></div><div class="sect1" title="2. MIME Type Configuration with mime.types"><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>
3112 To get most out of MIME, it's important that a MIME part's content type
3113 matches the content as closely as possible so that the recipient's
3114 client can automatically select the right viewer for the
3115 content. However, there's no reliable for Mutt to know how to detect
3116 every possible file type. Instead, it uses a simple plain text mapping
3117 file that specifies what file extension corresponds to what MIME
3118 type. This file is called <code class="literal">mime.types</code>.
3119 </p><p>
3120 When you add an attachment to your mail message, Mutt searches your
3121 personal <code class="literal">mime.types</code> file at
3122 <code class="literal">$HOME/.mime.types</code>, and then the system
3123 <code class="literal">mime.types</code> file at
3124 <code class="literal">/usr/local/share/mutt/mime.types</code> or
3125 <code class="literal">/etc/mime.types</code>
3126 </p><p>
3127 Each line starts with the full MIME type, followed by a space and
3128 space-separated list of file extensions. For example you could use:
3129 </p><div class="example"><a id="ex-mime-types"></a><p class="title"><b>Example 5.1. <code class="literal">mime.types</code></b></p><div class="example-contents"><pre class="screen">
3130 application/postscript          ps eps
3131 application/pgp                 pgp
3132 audio/x-aiff                    aif aifc aiff
3133 </pre></div></div><br class="example-break" /><p>
3134 A sample <code class="literal">mime.types</code> file comes with the Mutt
3135 distribution, and should contain most of the MIME types you are likely
3136 to use.
3137 </p><p>
3138 If Mutt can not determine the MIME type by the extension of the file you
3139 attach, it will look at the file.  If the file is free of binary
3140 information, Mutt will assume that the file is plain text, and mark it
3141 as <code class="literal">text/plain</code>.  If the file contains binary
3142 information, then Mutt will mark it as
3143 <code class="literal">application/octet-stream</code>.  You can change the MIME
3144 type that Mutt assigns to an attachment by using the
3145 <code class="literal">&lt;edit-type&gt;</code> command from the compose menu
3146 (default: ^T), see <a class="xref" href="#supported-mime-types" title="Table 5.1. Supported MIME types">Table 5.1, “Supported MIME types”</a> for supported
3147 major types. Mutt recognizes all of these if the appropriate entry is
3148 found in the <code class="literal">mime.types</code> file. Non-recognized mime
3149 types should only be used if the recipient of the message is likely to
3150 be expecting such attachments.
3151 </p><div class="table"><a id="supported-mime-types"></a><p class="title"><b>Table 5.1. Supported MIME types</b></p><div class="table-contents"><table summary="Supported MIME types" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>MIME major type</th><th>Standard</th><th>Description</th></tr></thead><tbody><tr><td><code class="literal">application</code></td><td>yes</td><td>General application data</td></tr><tr><td><code class="literal">audio</code></td><td>yes</td><td>Audio data</td></tr><tr><td><code class="literal">image</code></td><td>yes</td><td>Image data</td></tr><tr><td><code class="literal">message</code></td><td>yes</td><td>Mail messages, message status information</td></tr><tr><td><code class="literal">model</code></td><td>yes</td><td>VRML and other modeling data</td></tr><tr><td><code class="literal">multipart</code></td><td>yes</td><td>Container for other MIME parts</td></tr><tr><td><code class="literal">text</code></td><td>yes</td><td>Text data</td></tr><tr><td><code class="literal">video</code></td><td>yes</td><td>Video data</td></tr><tr><td><code class="literal">chemical</code></td><td>no</td><td>Mostly molecular data</td></tr></tbody></table></div></div><br class="table-break" /><p>
3152 MIME types are not arbitrary, they need to be assigned by <a class="ulink" href="http://www.iana.org/assignments/media-types/" target="_top">IANA</a>.
3153 </p></div><div class="sect1" title="3. MIME Viewer Configuration with Mailcap"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailcap"></a>3. MIME Viewer Configuration with Mailcap</h2></div></div></div><p>
3154 Mutt supports RFC 1524 MIME Configuration, in particular the Unix
3155 specific format specified in Appendix A of RFC 1524.  This file format
3156 is commonly referred to as the <span class="quote">“<span class="quote">mailcap</span>”</span> format.  Many MIME
3157 compliant programs utilize the mailcap format, allowing you to specify
3158 handling for all MIME types in one place for all programs.  Programs
3159 known to use this format include Firefox, lynx and metamail.
3160 </p><p>
3161 In order to handle various MIME types that Mutt doesn't have built-in
3162 support for, it parses a series of external configuration files to find
3163 an external handler. The default search string for these files is a
3164 colon delimited list containing the following files:
3165 </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p><code class="literal">$HOME/.mailcap</code></p></li><li class="listitem"><p><code class="literal">$PKGDATADIR/mailcap</code></p></li><li class="listitem"><p><code class="literal">$SYSCONFDIR/mailcap</code></p></li><li class="listitem"><p><code class="literal">/etc/mailcap</code></p></li><li class="listitem"><p><code class="literal">/usr/etc/mailcap</code></p></li><li class="listitem"><p><code class="literal">/usr/local/etc/mailcap</code></p></li></ol></div><p>
3166 where <code class="literal">$HOME</code> is your home directory. The
3167 <code class="literal">$PKGDATADIR</code> and the <code class="literal">$SYSCONFDIR</code>
3168 directories depend on where Mutt is installed: the former is the default
3169 for shared data, the latter for system configuration files.
3170 </p><p>
3171 The default search path can be obtained by running the following
3172 command:
3173 </p><pre class="screen">
3174 mutt -nF /dev/null -Q mailcap_path
3175 </pre><p>
3176 In particular, the metamail distribution will install a mailcap file,
3177 usually as <code class="literal">/usr/local/etc/mailcap</code>, which contains
3178 some baseline entries.
3179 </p><div class="sect2" title="3.1. The Basics of the Mailcap File"><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>
3180 A mailcap file consists of a series of lines which are comments, blank,
3181 or definitions.
3182 </p><p>
3183 A comment line consists of a # character followed by anything you want.
3184 </p><p>
3185 A blank line is blank.
3186 </p><p>
3187 A definition line consists of a content type, a view command, and any
3188 number of optional fields.  Each field of a definition line is divided
3189 by a semicolon <span class="quote">“<span class="quote">;</span>”</span> character.
3190 </p><p>
3191 The content type is specified in the MIME standard
3192 <span class="quote">“<span class="quote">type/subtype</span>”</span> notation.  For example,
3193 <code class="literal">text/plain</code>, <code class="literal">text/html</code>,
3194 <code class="literal">image/gif</code>, etc.  In addition, the mailcap format
3195 includes two formats for wildcards, one using the special
3196 <span class="quote">“<span class="quote">*</span>”</span> subtype, the other is the implicit wild, where you only
3197 include the major type.  For example, <code class="literal">image/*</code>, or
3198 <code class="literal">video</code> will match all image types and video types,
3199 respectively.
3200 </p><p>
3201 The view command is a Unix command for viewing the type specified. There
3202 are two different types of commands supported. The default is to send
3203 the body of the MIME message to the command on stdin. You can change
3204 this behavior by using <code class="literal">%s</code> as a parameter to your view
3205 command.  This will cause Mutt to save the body of the MIME message to a
3206 temporary file, and then call the view command with the
3207 <code class="literal">%s</code> replaced by the name of the temporary file. In
3208 both cases, Mutt will turn over the terminal to the view program until
3209 the program quits, at which time Mutt will remove the temporary file if
3210 it exists. This means that mailcap does <span class="emphasis"><em>not</em></span> work
3211 out of the box with programs which detach themselves from the terminal
3212 right after starting, like <code class="literal">open</code> on Mac OS X. In order
3213 to nevertheless use these programs with mailcap, you probably need
3214 custom shell scripts.
3215 </p><p>
3216 So, in the simplest form, you can send a <code class="literal">text/plain</code>
3217 message to the external pager more on standard input:
3218 </p><pre class="screen">
3219 text/plain; more
3220 </pre><p>
3221 Or, you could send the message as a file:
3222 </p><pre class="screen">
3223 text/plain; more %s
3224 </pre><p>
3225 Perhaps you would like to use lynx to interactively view a
3226 <code class="literal">text/html</code> message:
3227 </p><pre class="screen">
3228 text/html; lynx %s
3229 </pre><p>
3230 In this case, lynx does not support viewing a file from standard input,
3231 so you must use the <code class="literal">%s</code> syntax.
3232 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
3233 <span class="emphasis"><em>Some older versions of lynx contain a bug where they will
3234 check the mailcap file for a viewer for <code class="literal">text/html</code>.
3235 They will find the line which calls lynx, and run it.  This causes lynx
3236 to continuously spawn itself to view the object.</em></span>
3237 </p></div><p>
3238 On the other hand, maybe you don't want to use lynx interactively, you
3239 just want to have it convert the <code class="literal">text/html</code> to
3240 <code class="literal">text/plain</code>, then you can use:
3241 </p><pre class="screen">
3242 text/html; lynx -dump %s | more
3243 </pre><p>
3244 Perhaps you wish to use lynx to view <code class="literal">text/html</code> files,
3245 and a pager on all other text formats, then you would use the following:
3246 </p><pre class="screen">
3247 text/html; lynx %s
3248 text/*; more
3249 </pre></div><div class="sect2" title="3.2. Secure Use of Mailcap"><div class="titlepage"><div><div><h3 class="title"><a id="secure-mailcap"></a>3.2. Secure Use of Mailcap</h3></div></div></div><p>
3250 The interpretation of shell meta-characters embedded in MIME parameters
3251 can lead to security problems in general.  Mutt tries to quote
3252 parameters in expansion of <code class="literal">%s</code> syntaxes properly, and
3253 avoids risky characters by substituting them, see the <a class="link" href="#mailcap-sanitize" title="3.121. mailcap_sanitize">$mailcap_sanitize</a> variable.
3254 </p><p>
3255 Although Mutt's procedures to invoke programs with mailcap seem to be
3256 safe, there are other applications parsing mailcap, maybe taking less
3257 care of it.  Therefore you should pay attention to the following rules:
3258 </p><p>
3259 <span class="emphasis"><em>Keep the %-expandos away from shell quoting.</em></span> Don't
3260 quote them with single or double quotes.  Mutt does this for you, the
3261 right way, as should any other program which interprets mailcap.  Don't
3262 put them into backtick expansions.  Be highly careful with evil
3263 statements, and avoid them if possible at all.  Trying to fix broken
3264 behavior with quotes introduces new leaks — there is no
3265 alternative to correct quoting in the first place.
3266 </p><p>
3267 If you have to use the %-expandos' values in context where you need
3268 quoting or backtick expansions, put that value into a shell variable and
3269 reference the shell variable where necessary, as in the following
3270 example (using <code class="literal">$charset</code> inside the backtick expansion
3271 is safe, since it is not itself subject to any further expansion):
3272 </p><pre class="screen">
3273 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
3274         &amp;&amp; test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
3275 </pre></div><div class="sect2" title="3.3. Advanced Mailcap Usage"><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" title="3.3.1. Optional Fields"><div class="titlepage"><div><div><h4 class="title"><a id="optional-mailcap-fields"></a>3.3.1. Optional Fields</h4></div></div></div><p>
3276 In addition to the required content-type and view command fields, you
3277 can add semi-colon <span class="quote">“<span class="quote">;</span>”</span> separated fields to set flags and
3278 other options.  Mutt recognizes the following optional fields:
3279 </p><div class="variablelist"><dl><dt><span class="term">copiousoutput</span></dt><dd><p>
3280 This flag tells Mutt that the command passes possibly large amounts of
3281 text on standard output.  This causes Mutt to invoke a pager (either
3282 the internal pager or the external pager defined by the pager variable)
3283 on the output of the view command.  Without this flag, Mutt assumes that
3284 the command is interactive.  One could use this to replace the pipe to
3285 <code class="literal">more</code> in the <code class="literal">lynx -dump</code> example in
3286 the Basic section:
3287 </p><pre class="screen">
3288 text/html; lynx -dump %s ; copiousoutput
3289 </pre><p>
3290 This will cause lynx to format the <code class="literal">text/html</code> output
3291 as <code class="literal">text/plain</code> and Mutt will use your standard pager
3292 to display the results.
3293 </p><p>
3294 Note that when using the built-in pager, <span class="emphasis"><em>only</em></span>
3295 entries with this flag will be considered a handler for a MIME type
3296 — all other entries will be ignored.
3297 </p></dd><dt><span class="term">needsterminal</span></dt><dd><p>
3298 Mutt uses this flag when viewing attachments with <a class="link" href="#auto-view" title="4. MIME Autoview"><span class="command"><strong>auto_view</strong></span></a>, in order to
3299 decide whether it should honor the setting of the <a class="link" href="#wait-key" title="3.305. wait_key">$wait_key</a> variable or not.  When an attachment
3300 is viewed using an interactive program, and the corresponding mailcap
3301 entry has a <span class="emphasis"><em>needsterminal</em></span> flag, Mutt will use <a class="link" href="#wait-key" title="3.305. wait_key">$wait_key</a> and the exit status of the program
3302 to decide if it will ask you to press a key after the external program
3303 has exited.  In all other situations it will not prompt you for a key.
3304 </p></dd><dt><span class="term">compose=&lt;command&gt;</span></dt><dd><p>
3305 This flag specifies the command to use to create a new attachment of a
3306 specific MIME type.  Mutt supports this from the compose menu.
3307 </p></dd><dt><span class="term">composetyped=&lt;command&gt;</span></dt><dd><p>
3308 This flag specifies the command to use to create a new attachment of a
3309 specific MIME type.  This command differs from the compose command in
3310 that Mutt will expect standard MIME headers on the data.  This can be
3311 used to specify parameters, filename, description, etc. for a new
3312 attachment.  Mutt supports this from the compose menu.
3313 </p></dd><dt><span class="term">print=&lt;command&gt;</span></dt><dd><p>
3314 This flag specifies the command to use to print a specific MIME type.
3315 Mutt supports this from the attachment and compose menus.
3316 </p></dd><dt><span class="term">edit=&lt;command&gt;</span></dt><dd><p>
3317 This flag specifies the command to use to edit a specific MIME type.
3318 Mutt supports this from the compose menu, and also uses it to compose
3319 new attachments.  Mutt will default to the defined <a class="link" href="#editor" title="3.58. editor">$editor</a> for text attachments.
3320 </p></dd><dt><span class="term">nametemplate=&lt;template&gt;</span></dt><dd><p>
3321 This field specifies the format for the file denoted by
3322 <code class="literal">%s</code> in the command fields.  Certain programs will
3323 require a certain file extension, for instance, to correctly view a
3324 file.  For instance, lynx will only interpret a file as
3325 <code class="literal">text/html</code> if the file ends in
3326 <code class="literal">.html</code>.  So, you would specify lynx as a
3327 <code class="literal">text/html</code> viewer with a line in the mailcap file
3328 like:
3329 </p><pre class="screen">
3330 text/html; lynx %s; nametemplate=%s.html
3331 </pre></dd><dt><span class="term">test=&lt;command&gt;</span></dt><dd><p>
3332 This field specifies a command to run to test whether this mailcap entry
3333 should be used.  The command is defined with the command expansion rules
3334 defined in the next section.  If the command returns 0, then the test
3335 passed, and Mutt uses this entry.  If the command returns non-zero, then
3336 the test failed, and Mutt continues searching for the right entry.  Note
3337 that the content-type must match before Mutt performs the test.  For
3338 example:
3339 </p><pre class="screen">
3340 text/html; firefox -remote 'openURL(%s)' ; test=RunningX
3341 text/html; lynx %s
3342 </pre><p>
3343 In this example, Mutt will run the program <code class="literal">RunningX</code>
3344 which will return 0 if the X Window manager is running, and non-zero if
3345 it isn't.  If <code class="literal">RunningX</code> returns 0, then Mutt will run
3346 firefox to display the <code class="literal">text/html</code> object.  If RunningX
3347 doesn't return 0, then Mutt will go on to the next entry and use lynx to
3348 display the <code class="literal">text/html</code> object.
3349 </p></dd></dl></div></div><div class="sect3" title="3.3.2. Search Order"><div class="titlepage"><div><div><h4 class="title"><a id="mailcap-search-order"></a>3.3.2. Search Order</h4></div></div></div><p>
3350 When searching for an entry in the mailcap file, Mutt will search for
3351 the most useful entry for its purpose.  For instance, if you are
3352 attempting to print an <code class="literal">image/gif</code>, and you have the
3353 following entries in your mailcap file, Mutt will search for an entry
3354 with the print command:
3355 </p><pre class="screen">
3356 image/*;        xv %s
3357 image/gif;      ; print= anytopnm %s | pnmtops | lpr; \
3358                 nametemplate=%s.gif
3359 </pre><p>
3360 Mutt will skip the <code class="literal">image/*</code> entry and use the
3361 <code class="literal">image/gif</code> entry with the print command.
3362 </p><p>
3363 In addition, you can use this with <a class="link" href="#auto-view" title="4. MIME Autoview"><span class="command"><strong>auto_view</strong></span></a> to denote two
3364 commands for viewing an attachment, one to be viewed automatically, the
3365 other to be viewed interactively from the attachment menu using the
3366 <code class="literal">&lt;view-mailcap&gt;</code> function (bound to
3367 <span class="quote">“<span class="quote">m</span>”</span> by default). In addition, you can then use the test
3368 feature to determine which viewer to use interactively depending on your
3369 environment.
3370 </p><pre class="screen">
3371 text/html;      firefox -remote 'openURL(%s)' ; test=RunningX
3372 text/html;      lynx %s; nametemplate=%s.html
3373 text/html;      lynx -dump %s; nametemplate=%s.html; copiousoutput
3374 </pre><p>
3375 For <a class="link" href="#auto-view" title="4. MIME Autoview"><span class="command"><strong>auto_view</strong></span></a>, Mutt
3376 will choose the third entry because of the
3377 <code class="literal">copiousoutput</code> tag.  For interactive viewing, Mutt
3378 will run the program <code class="literal">RunningX</code> to determine if it
3379 should use the first entry.  If the program returns non-zero, Mutt will
3380 use the second entry for interactive viewing. The last entry is for
3381 inline display in the pager and the
3382 <code class="literal">&lt;view-attach&gt;</code> function in the attachment menu.
3383 </p><p>
3384 Entries with the <code class="literal">copiousoutput</code> tag should always be
3385 specified as the last one per type. For non-interactive use, the last
3386 entry will then actually be the first matching one with the tag set.
3387 For non-interactive use, only <code class="literal">copiousoutput</code>-tagged
3388 entries are considered. For interactive use, Mutt ignores this tag and
3389 treats all entries equally. Therefore, if not specified last, all
3390 following entries without this tag would never be considered for
3391 <code class="literal">&lt;view-attach&gt;</code> because the
3392 <code class="literal">copiousoutput</code> before them matched already.
3393 </p></div><div class="sect3" title="3.3.3. Command Expansion"><div class="titlepage"><div><div><h4 class="title"><a id="mailcap-command-expansion"></a>3.3.3. Command Expansion</h4></div></div></div><p>
3394 The various commands defined in the mailcap files are passed to the
3395 <code class="literal">/bin/sh</code> shell using the <code class="literal">system(3)</code>
3396 function.  Before the command is passed to <code class="literal">/bin/sh
3397 -c</code>, it is parsed to expand various special parameters with
3398 information from Mutt.  The keywords Mutt expands are:
3399 </p><div class="variablelist"><dl><dt><span class="term">%s</span></dt><dd><p>
3400 As seen in the basic mailcap section, this variable is expanded to a
3401 filename specified by the calling program.  This file contains the body
3402 of the message to view/print/edit or where the composing program should
3403 place the results of composition.  In addition, the use of this keyword
3404 causes Mutt to not pass the body of the message to the view/print/edit
3405 program on stdin.
3406 </p></dd><dt><span class="term">%t</span></dt><dd><p>
3407 Mutt will expand <code class="literal">%t</code> to the text representation of the
3408 content type of the message in the same form as the first parameter of
3409 the mailcap definition line, i.e. <code class="literal">text/html</code> or
3410 <code class="literal">image/gif</code>.
3411 </p></dd><dt><span class="term">%{&lt;parameter&gt;}</span></dt><dd><p>
3412 Mutt will expand this to the value of the specified parameter from the
3413 Content-Type: line of the mail message.  For instance, if your mail
3414 message contains:
3415 </p><pre class="screen">
3416 Content-Type: text/plain; charset=iso-8859-1
3417 </pre><p>
3418 then Mutt will expand <code class="literal">%{charset}</code> to
3419 <span class="quote">“<span class="quote">iso-8859-1</span>”</span>.  The default metamail mailcap file uses this
3420 feature to test the charset to spawn an xterm using the right charset to
3421 view the message.
3422 </p></dd><dt><span class="term">\%</span></dt><dd><p>
3423 This will be replaced by a literal <code class="literal">%</code>.
3424 </p></dd></dl></div><p>
3425 Mutt does not currently support the <code class="literal">%F</code> and
3426 <code class="literal">%n</code> keywords specified in RFC 1524.  The main purpose
3427 of these parameters is for multipart messages, which is handled
3428 internally by Mutt.
3429 </p></div></div><div class="sect2" title="3.4. Example Mailcap Files"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-example"></a>3.4. Example Mailcap Files</h3></div></div></div><p>
3430 This mailcap file is fairly simple and standard:
3431 </p><pre class="screen">
3432 <span class="comment"># I'm always running X :)</span>
3433 video/*;        xanim %s &gt; /dev/null
3434 image/*;        xv %s &gt; /dev/null
3435
3436 <span class="comment"># I'm always running firefox (if my computer had more memory, maybe)</span>
3437 text/html;      firefox -remote 'openURL(%s)'
3438 </pre><p>
3439 This mailcap file shows quite a number of examples:
3440 </p><pre class="screen">
3441 <span class="comment"># Use xanim to view all videos   Xanim produces a header on startup,
3442 # send that to /dev/null so I don't see it</span>
3443 video/*;        xanim %s &gt; /dev/null
3444
3445 <span class="comment"># Send html to a running firefox by remote</span>
3446 text/html;      firefox -remote 'openURL(%s)'; test=RunningFirefox
3447
3448 <span class="comment"># If I'm not running firefox but I am running X, start firefox on the
3449 # object</span>
3450 text/html;      firefox %s; test=RunningX
3451
3452 <span class="comment"># Else use lynx to view it as text</span>
3453 text/html;      lynx %s
3454
3455 <span class="comment"># This version would convert the text/html to text/plain</span>
3456 text/html;      lynx -dump %s; copiousoutput
3457
3458 <span class="comment"># I use enscript to print text in two columns to a page</span>
3459 text/*;         more %s; print=enscript -2Gr %s
3460
3461 <span class="comment"># Firefox adds a flag to tell itself to view jpegs internally</span>
3462 image/jpeg;xv %s; x-mozilla-flags=internal
3463
3464 <span class="comment"># Use xv to view images if I'm running X</span>
3465 <span class="comment"># In addition, this uses the \ to extend the line and set my editor</span>
3466 <span class="comment"># for images</span>
3467 image/*;xv %s; test=RunningX; \
3468         edit=xpaint %s
3469
3470 <span class="comment"># Convert images to text using the netpbm tools</span>
3471 image/*;  (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
3472 pbmtoascii -1x2 ) 2&gt;&amp;1 ; copiousoutput
3473
3474 <span class="comment"># Send excel spreadsheets to my NT box</span>
3475 application/ms-excel; open.pl %s
3476 </pre></div></div><div class="sect1" title="4. MIME Autoview"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="auto-view"></a>4. MIME Autoview</h2></div></div></div><p>
3477 Usage:
3478 </p><div class="cmdsynopsis"><p><code class="command">auto_view</code>   
3479 <em class="replaceable"><code>mimetype</code></em>
3480   [
3481 <em class="replaceable"><code>mimetype</code></em>
3482 ...]<br /><code class="command">unauto_view</code>  { 
3483 <em class="replaceable"><code>*</code></em>
3484   |   
3485 <em class="replaceable"><code>mimetype</code></em>
3486 ... }</p></div><p>
3487 In addition to explicitly telling Mutt to view an attachment with the
3488 MIME viewer defined in the mailcap file from the attachments menu, Mutt
3489 has support for automatically viewing MIME attachments while in the
3490 pager.
3491 </p><p>
3492 For this to work, you must define a viewer in the mailcap file which
3493 uses the <code class="literal">copiousoutput</code> option to denote that it is
3494 non-interactive.  Usually, you also use the entry to convert the
3495 attachment to a text representation which you can view in the pager.
3496 </p><p>
3497 You then use the <span class="command"><strong>auto_view</strong></span> configuration command to
3498 list the content-types that you wish to view automatically.  For
3499 instance, if you set it to:
3500 </p><pre class="screen">
3501 auto_view text/html application/x-gunzip \
3502   application/postscript image/gif application/x-tar-gz
3503 </pre><p>
3504 ...Mutt would try to find corresponding entries for rendering
3505 attachments of these types as text. A corresponding mailcap could look
3506 like:
3507 </p><pre class="screen">
3508 text/html;      lynx -dump %s; copiousoutput; nametemplate=%s.html
3509 image/*;        anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | \
3510                 pgmtopbm | pbmtoascii ; copiousoutput
3511 application/x-gunzip;   gzcat; copiousoutput
3512 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
3513 application/postscript; ps2ascii %s; copiousoutput
3514 </pre><p>
3515 <span class="command"><strong>unauto_view</strong></span> can be used to remove previous entries
3516 from the <span class="command"><strong>auto_view</strong></span> list.  This can be used with <a class="link" href="#message-hook" title="20. Change Settings Before Formatting a Message"><span class="command"><strong>message-hook</strong></span></a> to
3517 autoview messages based on size, etc.
3518 <span class="quote">“<span class="quote"><span class="command"><strong>unauto_view</strong></span> *</span>”</span> will remove all previous
3519 entries.
3520 </p></div><div class="sect1" title="5. MIME Multipart/Alternative"><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>
3521 The <code class="literal">multipart/alternative</code> container type only has
3522 child MIME parts which represent the same content in an alternative
3523 way. This is often used to send HTML messages which contain an
3524 alternative plain text representation.
3525 </p><p>
3526 Mutt has some heuristics for determining which attachment of a
3527 <code class="literal">multipart/alternative</code> type to display:
3528 </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>
3529 First, Mutt will check the <span class="command"><strong>alternative_order</strong></span> list to
3530 determine if one of the available types is preferred.  It consists of a
3531 number of MIME types in order, including support for implicit and
3532 explicit wildcards. For example:
3533 </p><pre class="screen">
3534 alternative_order text/enriched text/plain text \
3535   application/postscript image/*
3536 </pre></li><li class="listitem"><p>
3537 Next, Mutt will check if any of the types have a defined <a class="link" href="#auto-view" title="4. MIME Autoview"><span class="command"><strong>auto_view</strong></span></a>, and use that.
3538 </p></li><li class="listitem"><p>
3539 Failing that, Mutt will look for any text type.
3540 </p></li><li class="listitem"><p>
3541 As a last attempt, Mutt will look for any type it knows how to handle.
3542 </p></li></ol></div><p>
3543 To remove a MIME type from the <span class="command"><strong>alternative_order</strong></span>
3544 list, use the <span class="command"><strong>unalternative_order</strong></span> command.
3545 </p></div><div class="sect1" title="6. Attachment Searching and Counting"><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>
3546 If you ever lose track of attachments in your mailboxes, Mutt's
3547 attachment-counting and -searching support might be for you.  You can
3548 make your message index display the number of qualifying attachments in
3549 each message, or search for messages by attachment count.  You also can
3550 configure what kinds of attachments qualify for this feature with the
3551 <span class="command"><strong>attachments</strong></span> and <span class="command"><strong>unattachments</strong></span>
3552 commands.
3553 </p><p>
3554 In order to provide this information, Mutt needs to fully MIME-parse all
3555 messages affected first. This can slow down operation especially for
3556 remote mail folders such as IMAP because all messages have to be
3557 downloaded first regardless whether the user really wants to view them
3558 or not though using <a class="xref" href="#body-caching" title="7.2. Body Caching">Section 7.2, “Body Caching”</a> usually means to
3559 download the message just once.
3560 </p><p>
3561 The syntax is:
3562 </p><div class="cmdsynopsis"><p><code class="command">attachments</code>   
3563 <em class="replaceable"><code>{ + | - }disposition</code></em>
3564    
3565 <em class="replaceable"><code>mime-type</code></em>
3566  <br /><code class="command">unattachments</code>   
3567 <em class="replaceable"><code>{ + | - }disposition</code></em>
3568    
3569 <em class="replaceable"><code>mime-type</code></em>
3570  <br /><code class="command">attachments</code>   
3571 <em class="replaceable"><code>?</code></em>
3572  </p></div><p>
3573 <span class="emphasis"><em>disposition</em></span> is the attachment's Content-Disposition
3574 type — either <code class="literal">inline</code> or
3575 <code class="literal">attachment</code>.  You can abbreviate this to
3576 <code class="literal">I</code> or <code class="literal">A</code>.
3577 </p><p>
3578 Disposition is prefixed by either a <span class="quote">“<span class="quote">+</span>”</span> symbol or a
3579 <span class="quote">“<span class="quote">-</span>”</span> symbol.  If it's a <span class="quote">“<span class="quote">+</span>”</span>, you're saying that
3580 you want to allow this disposition and MIME type to qualify.  If it's a
3581 <span class="quote">“<span class="quote">-</span>”</span>, you're saying that this disposition and MIME type is
3582 an exception to previous <span class="quote">“<span class="quote">+</span>”</span> rules.  There are examples
3583 below of how this is useful.
3584 </p><p>
3585 <span class="emphasis"><em>mime-type</em></span> is the MIME type of the attachment you
3586 want the command to affect.  A MIME type is always of the format
3587 <code class="literal">major/minor</code>, where <code class="literal">major</code> describes
3588 the broad category of document you're looking at, and
3589 <code class="literal">minor</code> describes the specific type within that
3590 category.  The major part of mime-type must be literal text (or the
3591 special token <span class="quote">“<span class="quote"><code class="literal">*</code></span>”</span>), but the minor part
3592 may be a regular expression.  (Therefore,
3593 <span class="quote">“<span class="quote"><code class="literal">*/.*</code></span>”</span> matches any MIME type.)
3594 </p><p>
3595 The MIME types you give to the <span class="command"><strong>attachments</strong></span> directive
3596 are a kind of pattern.  When you use the <span class="command"><strong>attachments</strong></span>
3597 directive, the patterns you specify are added to a list.  When you use
3598 <span class="command"><strong>unattachments</strong></span>, the pattern is removed from the list.
3599 The patterns are not expanded and matched to specific MIME types at this
3600 time — they're just text in a list.  They're only matched when
3601 actually evaluating a message.
3602 </p><p>
3603 Some examples might help to illustrate.  The examples that are not
3604 commented out define the default configuration of the lists.
3605 </p><div class="example"><a id="ex-attach-count"></a><p class="title"><b>Example 5.2. Attachment counting</b></p><div class="example-contents"><pre class="screen">
3606 <span class="comment">
3607 # Removing a pattern from a list removes that pattern literally. It
3608 # does not remove any type matching the pattern.
3609 #
3610 #  attachments   +A */.*
3611 #  attachments   +A image/jpeg
3612 #  unattachments +A */.*
3613 #
3614 # This leaves "attached" image/jpeg files on the allowed attachments
3615 # list. It does not remove all items, as you might expect, because the
3616 # second */.* is not a matching expression at this time.
3617 #
3618 # Remember: "unattachments" only undoes what "attachments" has done!
3619 # It does not trigger any matching on actual messages.
3620
3621 # Qualify any MIME part with an "attachment" disposition, EXCEPT for
3622 # text/x-vcard and application/pgp parts. (PGP parts are already known
3623 # to mutt, and can be searched for with ~g, ~G, and ~k.)
3624 #
3625 # I've added x-pkcs7 to this, since it functions (for S/MIME)
3626 # analogously to PGP signature attachments. S/MIME isn't supported
3627 # in a stock mutt build, but we can still treat it specially here.
3628 #
3629 </span>
3630 attachments   +A */.*
3631 attachments   -A text/x-vcard application/pgp.*
3632 attachments   -A application/x-pkcs7-.*
3633
3634 <span class="comment">
3635 # Discount all MIME parts with an "inline" disposition, unless they're
3636 # text/plain. (Why inline a text/plain part unless it's external to the
3637 # message flow?)
3638 </span>
3639 attachments   +I text/plain
3640
3641 <span class="comment">
3642 # These two lines make Mutt qualify MIME containers.  (So, for example,
3643 # a message/rfc822 forward will count as an attachment.)  The first
3644 # line is unnecessary if you already have "attach-allow */.*", of
3645 # course.  These are off by default!  The MIME elements contained
3646 # within a message/* or multipart/* are still examined, even if the
3647 # containers themselves don't qualify.
3648
3649 #attachments  +A message/.* multipart/.*
3650 #attachments  +I message/.* multipart/.*
3651 </span>
3652
3653 <span class="comment">## You probably don't really care to know about deleted attachments.</span>
3654 attachments   -A message/external-body
3655 attachments   -I message/external-body
3656 </pre></div></div><br class="example-break" /><p>
3657 Entering the command <span class="quote">“<span class="quote"><span class="command"><strong>attachments</strong></span> ?</span>”</span> as
3658 a command will list your current settings in Muttrc format, so that it
3659 can be pasted elsewhere.
3660 </p></div><div class="sect1" title="7. MIME Lookup"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-lookup"></a>7. MIME Lookup</h2></div></div></div><p>
3661 Usage:
3662 </p><div class="cmdsynopsis"><p><code class="command">mime-lookup</code>   
3663 <em class="replaceable"><code>mimetype</code></em>
3664   [
3665 <em class="replaceable"><code>mimetype</code></em>
3666 ...]<br /><code class="command">unmime-lookup</code>  { 
3667 <em class="replaceable"><code>*</code></em>
3668   |   
3669 <em class="replaceable"><code>mimetype</code></em>
3670 ... }</p></div><p>
3671 Mutt's <span class="command"><strong>mime_lookup</strong></span> list specifies a list of MIME
3672 types that should <span class="emphasis"><em>not</em></span> be treated according to their
3673 mailcap entry.  This option is designed to deal with binary types such
3674 as <code class="literal">application/octet-stream</code>.  When an attachment's
3675 MIME type is listed in <span class="command"><strong>mime_lookup</strong></span>, then the
3676 extension of the filename will be compared to the list of extensions in
3677 the <code class="literal">mime.types</code> file.  The MIME type associated with
3678 this extension will then be used to process the attachment according to
3679 the rules in the mailcap file and according to any other configuration
3680 options (such as <span class="command"><strong>auto_view</strong></span>) specified.  Common usage
3681 would be:
3682 </p><pre class="screen">
3683 mime_lookup application/octet-stream application/X-Lotus-Manuscript
3684 </pre><p>
3685 In addition, the <code class="literal">unmime_lookup</code> command may be used to
3686 disable this feature for any particular MIME type if it had been set,
3687 for example, in a global <code class="literal">.muttrc</code>.
3688 </p></div></div><div class="chapter" title="Chapter 6. Optional Features"><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 IMAP 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="#cache-dirs">7.3. Cache Directories</a></span></dt><dt><span class="sect2"><a href="#maint-cache">7.4. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact Address Generation</a></span></dt><dt><span class="sect1"><a href="#sending-mixmaster">9. Sending Anonymous Messages via Mixmaster</a></span></dt></dl></div><div class="sect1" title="1. General Notes"><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" title="1.1. Enabling/Disabling Features"><div class="titlepage"><div><div><h3 class="title"><a id="compile-time-features"></a>1.1. Enabling/Disabling Features</h3></div></div></div><p>
3689 Mutt supports several of optional features which can be enabled or
3690 disabled at compile-time by giving the <span class="emphasis"><em>configure</em></span>
3691 script certain arguments. These are listed in the <span class="quote">“<span class="quote">Optional
3692 features</span>”</span> section of the <span class="emphasis"><em>configure --help</em></span>
3693 output.
3694 </p><p>
3695 Which features are enabled or disabled can later be determined from the
3696 output of <code class="literal">mutt -v</code>. If a compile option starts with
3697 <span class="quote">“<span class="quote">+</span>”</span> it is enabled and disabled if prefixed with
3698 <span class="quote">“<span class="quote">-</span>”</span>. For example, if Mutt was compiled using GnuTLS for
3699 encrypted communication instead of OpenSSL, <code class="literal">mutt -v</code>
3700 would contain:
3701 </p><pre class="screen">
3702 -USE_SSL_OPENSSL +USE_SSL_GNUTLS</pre></div><div class="sect2" title="1.2. URL Syntax"><div class="titlepage"><div><div><h3 class="title"><a id="url-syntax"></a>1.2. URL Syntax</h3></div></div></div><p>
3703 Mutt optionally supports the IMAP, POP3 and SMTP protocols which require
3704 to access servers using URLs. The canonical syntax for specifying URLs
3705 in Mutt is (an item enclosed in <code class="literal">[]</code> means it is
3706 optional and may be omitted):
3707 </p><pre class="screen">
3708 proto[s]://[username[:password]@]server[:port][/path]
3709 </pre><p>
3710 <span class="emphasis"><em>proto</em></span> is the communication protocol:
3711 <code class="literal">imap</code> for IMAP, <code class="literal">pop</code> for POP3 and
3712 <code class="literal">smtp</code> for SMTP. If <span class="quote">“<span class="quote">s</span>”</span> for <span class="quote">“<span class="quote">secure
3713 communication</span>”</span> is appended, Mutt will attempt to establish an
3714 encrypted communication using SSL or TLS.
3715 </p><p>
3716 Since all protocols supported by Mutt support/require authentication,
3717 login credentials may be specified in the URL. This has the advantage
3718 that multiple IMAP, POP3 or SMTP servers may be specified (which isn't
3719 possible using, for example, <a class="link" href="#imap-user" title="3.109. imap_user">$imap_user</a>). The username may contain the
3720 <span class="quote">“<span class="quote">@</span>”</span> symbol being used by many mail systems as part of the
3721 login name. The special characters <span class="quote">“<span class="quote">/</span>”</span>
3722 (<code class="literal">%2F</code>), <span class="quote">“<span class="quote">:</span>”</span> (<code class="literal">%3A</code>) and
3723 <span class="quote">“<span class="quote">%</span>”</span> (<code class="literal">%25</code>) have to be URL-encoded in
3724 usernames using the <code class="literal">%</code>-notation.
3725 </p><p>
3726 A password can be given, too but is not recommended if the URL is
3727 specified in a configuration file on disk.
3728 </p><p>
3729 If no port number is given, Mutt will use the system's default for the
3730 given protocol (usually consulting <code class="literal">/etc/services</code>).
3731 </p><p>
3732 The optional path is only relevant for IMAP and ignored elsewhere.
3733 </p><div class="example"><a id="ex-url"></a><p class="title"><b>Example 6.1. URLs</b></p><div class="example-contents"><pre class="screen">
3734 pops://host/
3735 imaps://user@host/INBOX/Sent
3736 smtp://user@host:587/
3737 </pre></div></div><br class="example-break" /></div></div><div class="sect1" title="2. SSL/TLS Support"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ssl"></a>2. SSL/TLS Support</h2></div></div></div><p>
3738 If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
3739 compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( by
3740 running the <span class="emphasis"><em>configure</em></span> script with the
3741 <span class="emphasis"><em>--enable-ssl=...</em></span> option for OpenSSL or
3742 <span class="emphasis"><em>--enable-gnutls=...</em></span> for GnuTLS). Mutt can then
3743 attempt to encrypt communication with remote servers if these protocols
3744 are suffixed with <span class="quote">“<span class="quote">s</span>”</span> for <span class="quote">“<span class="quote">secure
3745 communication</span>”</span>.
3746 </p></div><div class="sect1" title="3. POP3 Support"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="pop"></a>3. POP3 Support</h2></div></div></div><p>
3747 If Mutt is compiled with POP3 support (by running the
3748 <span class="emphasis"><em>configure</em></span> script with the
3749 <span class="emphasis"><em>--enable-pop</em></span> flag), it has the ability to work with
3750 mailboxes located on a remote POP3 server and fetch mail for local
3751 browsing.
3752 </p><p>
3753 Remote POP3 servers can be accessed using URLs with the
3754 <code class="literal">pop</code> protocol for unencrypted and
3755 <code class="literal">pops</code> for encrypted communication, see <a class="xref" href="#url-syntax" title="1.2. URL Syntax">Section 1.2, “URL Syntax”</a> for details.
3756 </p><p>
3757 Polling for new mail is more expensive over POP3 than locally. For this
3758 reason the frequency at which Mutt will check for mail remotely can be
3759 controlled by the <a class="link" href="#pop-checkinterval" title="3.188. pop_checkinterval">$pop_checkinterval</a> variable, which
3760 defaults to every 60 seconds.
3761 </p><p>
3762 POP is read-only which doesn't allow for some features like editing
3763 messages or changing flags. However, using <a class="xref" href="#header-caching" title="7.1. Header Caching">Section 7.1, “Header Caching”</a> and <a class="xref" href="#body-caching" title="7.2. Body Caching">Section 7.2, “Body Caching”</a> Mutt
3764 simulates the new/old/read flags as well as flagged and replied.  Mutt
3765 applies some logic on top of remote messages but cannot change them so
3766 that modifications of flags are lost when messages are downloaded from
3767 the POP server (either by Mutt or other tools).
3768 </p><a id="fetch-mail"></a><p>
3769 Another way to access your POP3 mail is the
3770 <code class="literal">&lt;fetch-mail&gt;</code> function (default: G).  It allows
3771 to connect to <a class="link" href="#pop-host" title="3.190. pop_host">$pop_host</a>, fetch all your
3772 new mail and place it in the local <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a>.  After this point, Mutt runs
3773 exactly as if the mail had always been local.
3774 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
3775 If you only need to fetch all messages to a local mailbox you should
3776 consider using a specialized program, such as
3777 <code class="literal">fetchmail(1)</code>, <code class="literal">getmail(1)</code> or
3778 similar.
3779 </p></div></div><div class="sect1" title="4. IMAP Support"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="imap"></a>4. IMAP Support</h2></div></div></div><p>
3780 If Mutt was compiled with IMAP support (by running the
3781 <span class="emphasis"><em>configure</em></span> script with the
3782 <span class="emphasis"><em>--enable-imap</em></span> flag), it has the ability to work
3783 with folders located on a remote IMAP server.
3784 </p><p>
3785 You can access the remote inbox by selecting the folder by its URL (see
3786 <a class="xref" href="#url-syntax" title="1.2. URL Syntax">Section 1.2, “URL Syntax”</a> for details) using the
3787 <code class="literal">imap</code> or <code class="literal">imaps</code> protocol.
3788 Alternatively, a pine-compatible notation is also supported, i.e.
3789 <code class="literal">{[username@]imapserver[:port][/ssl]}path/to/folder</code>
3790 </p><p>
3791 Note that not all servers use <span class="quote">“<span class="quote">/</span>”</span> as the hierarchy
3792 separator.  Mutt should correctly notice which separator is being used
3793 by the server and convert paths accordingly.
3794 </p><p>
3795 When browsing folders on an IMAP server, you can toggle whether to look
3796 at only the folders you are subscribed to, or all folders with the
3797 <span class="emphasis"><em>toggle-subscribed</em></span> command.  See also the <a class="link" href="#imap-list-subscribed" title="3.102. imap_list_subscribed">$imap_list_subscribed</a> variable.
3798 </p><p>
3799 Polling for new mail on an IMAP server can cause noticeable delays. So,
3800 you'll want to carefully tune the <a class="link" href="#mail-check" title="3.118. mail_check">$mail_check</a> and <a class="link" href="#timeout" title="3.292. timeout">$timeout</a> variables. Reasonable values are:
3801 </p><pre class="screen">
3802 set mail_check=90
3803 set timeout=15
3804 </pre><p>
3805 with relatively good results even over slow modem lines.
3806 </p><div class="note" title="Note"><h3 class="title">Note</h3><p>
3807 Note that if you are using mbox as the mail store on UW servers prior to
3808 v12.250, the server has been reported to disconnect a client if another
3809 client selects the same folder.
3810 </p></div><div class="sect2" title="4.1. The IMAP Folder Browser"><div class="titlepage"><div><div><h3 class="title"><a id="imap-browser"></a>4.1. The IMAP Folder Browser</h3></div></div></div><p>
3811 As of version 1.2, Mutt supports browsing mailboxes on an IMAP
3812 server. This is mostly the same as the local file browser, with the
3813 following differences:
3814 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
3815 In lieu of file permissions, Mutt displays the string
3816 <span class="quote">“<span class="quote">IMAP</span>”</span>, possibly followed by the symbol <span class="quote">“<span class="quote">+</span>”</span>,
3817 indicating that the entry contains both messages and subfolders. On
3818 Cyrus-like servers folders will often contain both messages and
3819 subfolders.
3820 </p></li><li class="listitem"><p>
3821 For the case where an entry can contain both messages and subfolders,
3822 the selection key (bound to <code class="literal">enter</code> by default) will
3823 choose to descend into the subfolder view. If you wish to view the
3824 messages in that folder, you must use <code class="literal">view-file</code>
3825 instead (bound to <code class="literal">space</code> by default).
3826 </p></li><li class="listitem"><p>
3827 You can create, delete and rename mailboxes with the
3828 <code class="literal">&lt;create-mailbox&gt;</code>,
3829 <code class="literal">&lt;delete-mailbox&gt;</code>, and
3830 <code class="literal">&lt;rename-mailbox&gt;</code> commands (default bindings:
3831 <code class="literal">C</code>, <code class="literal">d</code> and <code class="literal">r</code>,
3832 respectively). You may also <code class="literal">&lt;subscribe&gt;</code> and
3833 <code class="literal">&lt;unsubscribe&gt;</code> to mailboxes (normally these are
3834 bound to <code class="literal">s</code> and <code class="literal">u</code>, respectively).
3835 </p></li></ul></div></div><div class="sect2" title="4.2. Authentication"><div class="titlepage"><div><div><h3 class="title"><a id="imap-authentication"></a>4.2. Authentication</h3></div></div></div><p>
3836 Mutt supports four authentication methods with IMAP servers: SASL,
3837 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
3838 NTLM authentication for you poor exchange users out there, but it has
3839 yet to be integrated into the main tree). There is also support for the
3840 pseudo-protocol ANONYMOUS, which allows you to log in to a public IMAP
3841 server without having an account. To use ANONYMOUS, simply make your
3842 username blank or <span class="quote">“<span class="quote">anonymous</span>”</span>.
3843 </p><p>
3844 SASL is a special super-authenticator, which selects among several
3845 protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the
3846 most secure method available on your host and the server. Using some of
3847 these methods (including DIGEST-MD5 and possibly GSSAPI), your entire
3848 session will be encrypted and invisible to those teeming network
3849 snoops. It is the best option if you have it. To use it, you must have
3850 the Cyrus SASL library installed on your system and compile Mutt with
3851 the <span class="emphasis"><em>--with-sasl</em></span> flag.
3852 </p><p>
3853 Mutt will try whichever methods are compiled in and available on the
3854 server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5,
3855 LOGIN.
3856 </p><p>
3857 There are a few variables which control authentication:
3858 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
3859 <a class="link" href="#imap-user" title="3.109. imap_user">$imap_user</a> - controls the username
3860 under which you request authentication on the IMAP server, for all
3861 authenticators. This is overridden by an explicit username in the
3862 mailbox path (i.e. by using a mailbox name of the form
3863 <code class="literal">{user@host}</code>).
3864 </p></li><li class="listitem"><p>
3865 <a class="link" href="#imap-pass" title="3.104. imap_pass">$imap_pass</a> - a password which you may
3866 preset, used by all authentication methods where a password is needed.
3867 </p></li><li class="listitem"><p>
3868 <a class="link" href="#imap-authenticators" title="3.96. imap_authenticators">$imap_authenticators</a> - a
3869 colon-delimited list of IMAP authentication methods to try, in the order
3870 you wish to try them. If specified, this overrides Mutt's default
3871 (attempt everything, in the order listed above).
3872 </p></li></ul></div></div></div><div class="sect1" title="5. SMTP Support"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="smtp"></a>5. SMTP Support</h2></div></div></div><p>
3873 Besides supporting traditional mail delivery through a
3874 sendmail-compatible program, Mutt supports delivery through SMTP if it
3875 was configured and built with <code class="literal">--enable-smtp</code>.
3876 </p><p>
3877 If the configuration variable <a class="link" href="#smtp-url" title="3.263. smtp_url">$smtp_url</a>
3878 is set, Mutt will contact the given SMTP server to deliver messages; if
3879 it is unset, Mutt will use the program specified by <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a>.
3880 </p><p>
3881 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>.
3882 </p><p>
3883 The built-in SMTP support supports encryption (the
3884 <code class="literal">smtps</code> protocol using SSL or TLS) as well as SMTP
3885 authentication using SASL. The authentication mechanisms for SASL are
3886 specified in <a class="link" href="#smtp-authenticators" title="3.261. smtp_authenticators">$smtp_authenticators</a> defaulting to
3887 an empty list which makes Mutt try all available methods from
3888 most-secure to least-secure.
3889 </p></div><div class="sect1" title="6. Managing Multiple Accounts"><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>
3890 Usage:
3891 </p><div class="cmdsynopsis"><p><code class="command">account-hook</code>   
3892 <em class="replaceable"><code>pattern</code></em>
3893    
3894 <em class="replaceable"><code>command</code></em>
3895  </p></div><p>
3896 If you happen to have accounts on multiple IMAP, POP and/or SMTP
3897 servers, you may find managing all the authentication settings
3898 inconvenient and error-prone. The <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a> command
3899 may help. This hook works like <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a> but is
3900 invoked whenever Mutt needs to access a remote mailbox (including inside
3901 the folder browser), not just when you open the mailbox. This includes
3902 (for example) polling for new mail, storing Fcc messages and saving
3903 messages to a folder. As a consequence, <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a> should
3904 only be used to set connection-related settings such as passwords or
3905 tunnel commands but not settings such as sender address or name (because
3906 in general it should be considered unpredictable which <a class="link" href="#account-hook" title="6. Managing Multiple Accounts"><span class="command"><strong>account-hook</strong></span></a> was last
3907 used).
3908 </p><p>
3909 Some examples:
3910 </p><pre class="screen">
3911 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
3912 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
3913 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
3914 account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
3915 </pre><p>
3916 To manage multiple accounts with, for example, different values of <a class="link" href="#record" title="3.212. record">$record</a> or sender addresses, <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a> has to be be
3917 used together with the <a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail"><span class="command"><strong>mailboxes</strong></span></a> command.
3918 </p><div class="example"><a id="ex-multiaccount"></a><p class="title"><b>Example 6.2. Managing multiple accounts</b></p><div class="example-contents"><pre class="screen">
3919 mailboxes imap://user@host1/INBOX
3920 folder-hook imap://user@host1/ 'set folder=imap://host1/ ; set record=+INBOX/Sent'
3921
3922 mailboxes imap://user@host2/INBOX
3923 folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sent'
3924 </pre></div></div><br class="example-break" /><p>
3925 In example <a class="xref" href="#ex-multiaccount" title="Example 6.2. Managing multiple accounts">Example 6.2, “Managing multiple accounts”</a> the folders are defined
3926 using <a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail"><span class="command"><strong>mailboxes</strong></span></a> so
3927 Mutt polls them for new mail. Each <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span></a> triggers
3928 when one mailbox below each IMAP account is opened and sets <a class="link" href="#folder" title="3.66. folder">$folder</a> to the account's root folder. Next, it
3929 sets <a class="link" href="#record" title="3.212. record">$record</a> to the
3930 <span class="emphasis"><em>INBOX/Sent</em></span> folder below the newly set <a class="link" href="#folder" title="3.66. folder">$folder</a>. Please notice that the value the
3931 <span class="quote">“<span class="quote">+</span>”</span> <a class="link" href="#shortcuts" title="8. Mailbox Shortcuts">mailbox shortcut</a>
3932 refers to depends on the <span class="emphasis"><em>current</em></span> value of <a class="link" href="#folder" title="3.66. folder">$folder</a> and therefore has to be set separately
3933 per account. Setting other values like <a class="link" href="#from" title="3.75. from">$from</a>
3934 or <a class="link" href="#signature" title="3.236. signature">$signature</a> is analogous to setting
3935 <a class="link" href="#record" title="3.212. record">$record</a>.
3936 </p></div><div class="sect1" title="7. Local Caching"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="caching"></a>7. Local Caching</h2></div></div></div><p>
3937 Mutt contains two types of local caching: <span class="emphasis"><em>(1)</em></span> the
3938 so-called <span class="quote">“<span class="quote">header caching</span>”</span> and <span class="emphasis"><em>(2)</em></span> the
3939 so-called <span class="quote">“<span class="quote">body caching</span>”</span> which are both described in this
3940 section.
3941 </p><p>
3942 Header caching is optional as it depends on external libraries, body
3943 caching is always enabled if Mutt is compiled with POP and/or IMAP
3944 support as these use it (body caching requires no external library).
3945 </p><div class="sect2" title="7.1. Header Caching"><div class="titlepage"><div><div><h3 class="title"><a id="header-caching"></a>7.1. Header Caching</h3></div></div></div><p>
3946 Mutt provides optional support for caching message headers for the
3947 following types of folders: IMAP, POP, Maildir and MH. Header caching
3948 greatly speeds up opening large folders because for remote folders,
3949 headers usually only need to be downloaded once. For Maildir and MH,
3950 reading the headers from a single file is much faster than looking at
3951 possibly thousands of single files (since Maildir and MH use one file
3952 per message.)
3953 </p><p>
3954 Header caching can be enabled via the configure script and the
3955 <span class="emphasis"><em>--enable-hcache</em></span> option. It's not turned on by
3956 default because external database libraries are required: one of
3957 tokyocabinet, qdbm, gdbm or bdb must be present.
3958 </p><p>
3959 If enabled, <a class="link" href="#header-cache" title="3.79. header_cache">$header_cache</a> can be
3960 used to either point to a file or a directory. If set to point to a
3961 file, one database file for all folders will be used (which may result
3962 in lower performance), but one file per folder if it points to a
3963 directory.
3964 </p></div><div class="sect2" title="7.2. Body Caching"><div class="titlepage"><div><div><h3 class="title"><a id="body-caching"></a>7.2. Body Caching</h3></div></div></div><p>
3965 Both cache methods can be combined using the same directory for storage
3966 (and for IMAP/POP even provide meaningful file names) which simplifies
3967 manual maintenance tasks.
3968 </p><p>
3969 In addition to caching message headers only, Mutt can also cache whole
3970 message bodies. This results in faster display of messages for POP and
3971 IMAP folders because messages usually have to be downloaded only once.
3972 </p><p>
3973 For configuration, the variable <a class="link" href="#message-cachedir" title="3.133. message_cachedir">$message_cachedir</a> must point to a directory. There, Mutt will
3974 create a hierarchy of subdirectories named like the account and mailbox
3975 path the cache is for.
3976 </p></div><div class="sect2" title="7.3. Cache Directories"><div class="titlepage"><div><div><h3 class="title"><a id="cache-dirs"></a>7.3. Cache Directories</h3></div></div></div><p>
3977 For using both, header and body caching, <a class="link" href="#header-cache" title="3.79. header_cache">$header_cache</a> and <a class="link" href="#message-cachedir" title="3.133. message_cachedir">$message_cachedir</a> can be safely set
3978 to the same value.
3979 </p><p>
3980 In a header or body cache directory, Mutt creates a directory hierarchy
3981 named like: <code class="literal">proto:user@hostname</code> where
3982 <code class="literal">proto</code> is either <span class="quote">“<span class="quote">pop</span>”</span> or
3983 <span class="quote">“<span class="quote">imap.</span>”</span> Within there, for each folder, Mutt stores messages
3984 in single files and header caches in files with the
3985 <span class="quote">“<span class="quote">.hcache</span>”</span> extension.  All files can be removed as needed if
3986 the consumed disk space becomes an issue as Mutt will silently fetch
3987 missing items again. Pathnames are always stored in UTF-8 encoding.
3988 </p><p>
3989 For Maildir and MH, the header cache files are named after the MD5
3990 checksum of the path.
3991 </p></div><div class="sect2" title="7.4. Maintenance"><div class="titlepage"><div><div><h3 class="title"><a id="maint-cache"></a>7.4. Maintenance</h3></div></div></div><p>
3992 Mutt does not (yet) support maintenance features for header cache
3993 database files so that files have to be removed in case they grow too
3994 big. It depends on the database library used for header caching whether
3995 disk space freed by removing messages is re-used.
3996 </p><p>
3997 For body caches, Mutt can keep the local cache in sync with the remote
3998 mailbox if the <a class="link" href="#message-cache-clean" title="3.132. message_cache_clean">$message_cache_clean</a> variable is
3999 set. Cleaning means to remove messages from the cache which are no
4000 longer present in the mailbox which only happens when other mail clients
4001 or instances of Mutt using a different body cache location delete
4002 messages (Mutt itself removes deleted messages from the cache when
4003 syncing a mailbox). As cleaning can take a noticeable amount of time, it
4004 should not be set in general but only occasionally.
4005 </p></div></div><div class="sect1" title="8. Exact Address Generation"><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>
4006 Mutt supports the <span class="quote">“<span class="quote">Name &lt;user@host&gt;</span>”</span> address syntax
4007 for reading and writing messages, the older <span class="quote">“<span class="quote">user@host
4008 (Name)</span>”</span> syntax is only supported when reading messages. The
4009 <span class="emphasis"><em>--enable-exact-address</em></span> switch can be given to
4010 configure to build it with write-support for the latter
4011 syntax. <code class="literal">EXACT_ADDRESS</code> in the output of <code class="literal">mutt
4012 -v</code> indicates whether it's supported.
4013 </p></div><div class="sect1" title="9. Sending Anonymous Messages via Mixmaster"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sending-mixmaster"></a>9. Sending Anonymous Messages via Mixmaster</h2></div></div></div><p>
4014 You may also have compiled Mutt to co-operate with Mixmaster, an
4015 anonymous remailer.  Mixmaster permits you to send your messages
4016 anonymously using a chain of remailers. Mixmaster support in Mutt is for
4017 mixmaster version 2.04 or later.
4018 </p><p>
4019 To use it, you'll have to obey certain restrictions.  Most important,
4020 you cannot use the <code class="literal">Cc</code> and <code class="literal">Bcc</code>
4021 headers.  To tell Mutt to use mixmaster, you have to select a remailer
4022 chain, using the mix function on the compose menu.
4023 </p><p>
4024 The chain selection screen is divided into two parts.  In the (larger)
4025 upper part, you get a list of remailers you may use.  In the lower part,
4026 you see the currently selected chain of remailers.
4027 </p><p>
4028 You can navigate in the chain using the
4029 <code class="literal">&lt;chain-prev&gt;</code> and
4030 <code class="literal">&lt;chain-next&gt;</code> functions, which are by default
4031 bound to the left and right arrows and to the <code class="literal">h</code> and
4032 <code class="literal">l</code> keys (think vi keyboard bindings).  To insert a
4033 remailer at the current chain position, use the
4034 <code class="literal">&lt;insert&gt;</code> function.  To append a remailer behind
4035 the current chain position, use <code class="literal">&lt;select-entry&gt;</code>
4036 or <code class="literal">&lt;append&gt;</code>.  You can also delete entries from
4037 the chain, using the corresponding function.  Finally, to abandon your
4038 changes, leave the menu, or <code class="literal">&lt;accept&gt;</code> them
4039 pressing (by default) the <code class="literal">Return</code> key.
4040 </p><p>
4041 Note that different remailers do have different capabilities, indicated
4042 in the %c entry of the remailer menu lines (see <a class="link" href="#mix-entry-format" title="3.144. mix_entry_format">$mix_entry_format</a>).  Most important is
4043 the <span class="quote">“<span class="quote">middleman</span>”</span> capability, indicated by a capital
4044 <span class="quote">“<span class="quote">M</span>”</span>: This means that the remailer in question cannot be
4045 used as the final element of a chain, but will only forward messages to
4046 other mixmaster remailers.  For details on the other capabilities,
4047 please have a look at the mixmaster documentation.
4048 </p></div></div><div class="chapter" title="Chapter 7. Security Considerations"><div class="titlepage"><div><div><h2 class="title"><a id="security"></a>Chapter 7. Security Considerations</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#security-passwords">1. Passwords</a></span></dt><dt><span class="sect1"><a href="#security-tempfiles">2. Temporary Files</a></span></dt><dt><span class="sect1"><a href="#security-leaks">3. Information Leaks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#security-leaks-mid">3.1. Message-Id: headers</a></span></dt><dt><span class="sect2"><a href="#security-leaks-mailto">3.2. <code class="literal">mailto:</code>-style Links</a></span></dt></dl></dd><dt><span class="sect1"><a href="#security-external">4. External Applications</a></span></dt></dl></div><p>
4049 First of all, Mutt contains no security holes included by intention but
4050 may contain unknown security holes. As a consequence, please run Mutt
4051 only with as few permissions as possible. Especially, do not run Mutt as
4052 the super user.
4053 </p><p>
4054 When configuring Mutt, there're some points to note about secure setups
4055 so please read this chapter carefully.
4056 </p><div class="sect1" title="1. Passwords"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-passwords"></a>1. Passwords</h2></div></div></div><p>
4057 Although Mutt can be told the various passwords for accounts, please
4058 never store passwords in configuration files. Besides the fact that the
4059 system's operator can always read them, you could forget to mask it out
4060 when reporting a bug or asking for help via a mailing list. Even worse,
4061 your mail including your password could be archived by internet search
4062 engines, mail-to-news gateways etc. It may already be too late before
4063 you notice your mistake.
4064 </p></div><div class="sect1" title="2. Temporary Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-tempfiles"></a>2. Temporary Files</h2></div></div></div><p>
4065 Mutt uses many temporary files for viewing messages, verifying digital
4066 signatures, etc. As long as being used, these files are visible by other
4067 users and maybe even readable in case of misconfiguration.  Also, a
4068 different location for these files may be desired which can be changed
4069 via the <a class="link" href="#tmpdir" title="3.293. tmpdir">$tmpdir</a> variable.
4070 </p></div><div class="sect1" title="3. Information Leaks"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-leaks"></a>3. Information Leaks</h2></div></div></div><div class="sect2" title="3.1. Message-Id: headers"><div class="titlepage"><div><div><h3 class="title"><a id="security-leaks-mid"></a>3.1. Message-Id: headers</h3></div></div></div><p>
4071 Message-Id: headers contain a local part that is to be created in a
4072 unique fashion. In order to do so, Mutt will <span class="quote">“<span class="quote">leak</span>”</span> some
4073 information to the outside world when sending messages: the generation
4074 of this header includes a step counter which is increased (and rotated)
4075 with every message sent. In a longer running mutt session, others can
4076 make assumptions about your mailing habits depending on the number of
4077 messages sent. If this is not desired, the header can be manually
4078 provided using <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a> (though
4079 not recommended).
4080 </p></div><div class="sect2" title="3.2. mailto:-style Links"><div class="titlepage"><div><div><h3 class="title"><a id="security-leaks-mailto"></a>3.2. <code class="literal">mailto:</code>-style Links</h3></div></div></div><p>
4081 As Mutt be can be set up to be the mail client to handle
4082 <code class="literal">mailto:</code> style links in websites, there're security
4083 considerations, too. Arbitrary header fields can be embedded in these
4084 links which could override existing header fields or attach arbitrary
4085 files using <a class="link" href="#attach-header" title="6.2.2. Attach: Pseudo Header">the Attach:
4086 pseudoheader</a>. This may be problematic if the <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit-headers</a> variable is
4087 <span class="emphasis"><em>unset</em></span>, i.e. the user doesn't want to see header
4088 fields while editing the message and doesn't pay enough attention to the
4089 compose menu's listing of attachments.
4090 </p><p>
4091 For example, following a link like
4092 </p><pre class="screen">
4093 mailto:joe@host?Attach=~/.gnupg/secring.gpg</pre><p>
4094 will send out the user's private gnupg keyring to
4095 <code class="literal">joe@host</code> if the user doesn't follow the information
4096 on screen carefully enough.
4097 </p></div></div><div class="sect1" title="4. External Applications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="security-external"></a>4. External Applications</h2></div></div></div><p>
4098 Mutt in many places has to rely on external applications or for
4099 convenience supports mechanisms involving external applications.
4100 </p><p>
4101 One of these is the <code class="literal">mailcap</code> mechanism as defined by
4102 RfC1524. Details about a secure use of the mailcap mechanisms is given
4103 in <a class="xref" href="#secure-mailcap" title="3.2. Secure Use of Mailcap">Section 3.2, “Secure Use of Mailcap”</a>.
4104 </p><p>
4105 Besides the mailcap mechanism, Mutt uses a number of other external
4106 utilities for operation, for example to provide crypto support, in
4107 backtick expansion in configuration files or format string filters.  The
4108 same security considerations apply for these as for tools involved via
4109 mailcap.
4110 </p></div></div><div class="chapter" title="Chapter 8. Performance Tuning"><div class="titlepage"><div><div><h2 class="title"><a id="tuning"></a>Chapter 8. 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" title="1. Reading and Writing Mailboxes"><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>
4111 Mutt's performance when reading mailboxes can be improved in two ways:
4112 </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>
4113 For remote folders (IMAP and POP) as well as folders using one-file-per
4114 message storage (Maildir and MH), Mutt's performance can be greatly
4115 improved using <a class="link" href="#header-caching" title="7.1. Header Caching">header caching</a>.
4116 using a single database per folder.
4117 </p></li><li class="listitem"><p>
4118 Mutt provides the <a class="link" href="#read-inc" title="3.208. read_inc">$read_inc</a> and <a class="link" href="#write-inc" title="3.312. write_inc">$write_inc</a> variables to specify at which rate
4119 to update progress counters. If these values are too low, Mutt may spend
4120 more time on updating the progress counter than it spends on actually
4121 reading/writing folders.
4122 </p><p>
4123 For example, when opening a maildir folder with a few thousand messages,
4124 the default value for <a class="link" href="#read-inc" title="3.208. read_inc">$read_inc</a> may be
4125 too low. It can be tuned on on a folder-basis using <a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox"><span class="command"><strong>folder-hook</strong></span>s</a>:
4126 </p><pre class="screen">
4127 <span class="comment"># use very high $read_inc to speed up reading hcache'd maildirs</span>
4128 folder-hook . 'set read_inc=1000'
4129 <span class="comment"># use lower value for reading slower remote IMAP folders</span>
4130 folder-hook ^imap 'set read_inc=100'
4131 <span class="comment"># use even lower value for reading even slower remote POP folders</span>
4132 folder-hook ^pop 'set read_inc=1'</pre></li></ol></div><p>
4133 These settings work on a per-message basis. However, as messages may
4134 greatly differ in size and certain operations are much faster than
4135 others, even per-folder settings of the increment variables may not be
4136 desirable as they produce either too few or too much progress updates.
4137 Thus, Mutt allows to limit the number of progress updates per second
4138 it'll actually send to the terminal using the <a class="link" href="#time-inc" title="3.291. time_inc">$time_inc</a> variable.
4139 </p></div><div class="sect1" title="2. Reading Messages from Remote Folders"><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>
4140 Reading messages from remote folders such as IMAP an POP can be slow
4141 especially for large mailboxes since Mutt only caches a very limited
4142 number of recently viewed messages (usually 10) per session (so that it
4143 will be gone for the next session.)
4144 </p><p>
4145 To improve performance and permanently cache whole messages, please
4146 refer to Mutt's so-called <a class="link" href="#body-caching" title="7.2. Body Caching">body
4147 caching</a> for details.
4148 </p></div><div class="sect1" title="3. Searching and Limiting"><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>
4149 When searching mailboxes either via a search or a limit action, for some
4150 patterns Mutt distinguishes between regular expression and string
4151 searches. For regular expressions, patterns are prefixed with
4152 <span class="quote">“<span class="quote">~</span>”</span> and with <span class="quote">“<span class="quote">=</span>”</span> for string searches.
4153 </p><p>
4154 Even though a regular expression search is fast, it's several times
4155 slower than a pure string search which is noticeable especially on large
4156 folders. As a consequence, a string search should be used instead of a
4157 regular expression search if the user already knows enough about the
4158 search pattern.
4159 </p><p>
4160 For example, when limiting a large folder to all messages sent to or by
4161 an author, it's much faster to search for the initial part of an e-mail
4162 address via <code class="literal">=Luser@</code> instead of
4163 <code class="literal">~Luser@</code>. This is especially true for searching
4164 message bodies since a larger amount of input has to be searched.
4165 </p><p>
4166 As for regular expressions, a lower case string search pattern makes
4167 Mutt perform a case-insensitive search except for IMAP (because for IMAP
4168 Mutt performs server-side searches which don't support
4169 case-insensitivity).
4170 </p></div></div><div class="chapter" title="Chapter 9. Reference"><div class="titlepage"><div><div><h2 class="title"><a id="reference"></a>Chapter 9. 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="#auto-tag">3.17. auto_tag</a></span></dt><dt><span class="sect2"><a href="#autoedit">3.18. autoedit</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="#certificate-file">3.24. certificate_file</a></span></dt><dt><span class="sect2"><a href="#charset">3.25. charset</a></span></dt><dt><span class="sect2"><a href="#check-mbox-size">3.26. check_mbox_size</a></span></dt><dt><span class="sect2"><a href="#check-new">3.27. check_new</a></span></dt><dt><span class="sect2"><a href="#collapse-unread">3.28. collapse_unread</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-autoencrypt">3.36. crypt_autoencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-autopgp">3.37. crypt_autopgp</a></span></dt><dt><span class="sect2"><a href="#crypt-autosign">3.38. crypt_autosign</a></span></dt><dt><span class="sect2"><a href="#crypt-autosmime">3.39. crypt_autosmime</a></span></dt><dt><span class="sect2"><a href="#crypt-replyencrypt">3.40. crypt_replyencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-replysign">3.41. crypt_replysign</a></span></dt><dt><span class="sect2"><a href="#crypt-replysignencrypted">3.42. crypt_replysignencrypted</a></span></dt><dt><span class="sect2"><a href="#crypt-timestamp">3.43. crypt_timestamp</a></span></dt><dt><span class="sect2"><a href="#crypt-use-gpgme">3.44. crypt_use_gpgme</a></span></dt><dt><span class="sect2"><a href="#crypt-use-pka">3.45. crypt_use_pka</a></span></dt><dt><span class="sect2"><a href="#crypt-verify-sig">3.46. crypt_verify_sig</a></span></dt><dt><span class="sect2"><a href="#date-format">3.47. date_format</a></span></dt><dt><span class="sect2"><a href="#default-hook">3.48. default_hook</a></span></dt><dt><span class="sect2"><a href="#delete">3.49. delete</a></span></dt><dt><span class="sect2"><a href="#delete-untag">3.50. delete_untag</a></span></dt><dt><span class="sect2"><a href="#digest-collapse">3.51. digest_collapse</a></span></dt><dt><span class="sect2"><a href="#display-filter">3.52. display_filter</a></span></dt><dt><span class="sect2"><a href="#dotlock-program">3.53. dotlock_program</a></span></dt><dt><span class="sect2"><a href="#dsn-notify">3.54. dsn_notify</a></span></dt><dt><span class="sect2"><a href="#dsn-return">3.55. dsn_return</a></span></dt><dt><span class="sect2"><a href="#duplicate-threads">3.56. duplicate_threads</a></span></dt><dt><span class="sect2"><a href="#edit-headers">3.57. edit_headers</a></span></dt><dt><span class="sect2"><a href="#editor">3.58. editor</a></span></dt><dt><span class="sect2"><a href="#encode-from">3.59. encode_from</a></span></dt><dt><span class="sect2"><a href="#entropy-file">3.60. entropy_file</a></span></dt><dt><span class="sect2"><a href="#envelope-from-address">3.61. envelope_from_address</a></span></dt><dt><span class="sect2"><a href="#escape">3.62. escape</a></span></dt><dt><span class="sect2"><a href="#fast-reply">3.63. fast_reply</a></span></dt><dt><span class="sect2"><a href="#fcc-attach">3.64. fcc_attach</a></span></dt><dt><span class="sect2"><a href="#fcc-clear">3.65. fcc_clear</a></span></dt><dt><span class="sect2"><a href="#folder">3.66. folder</a></span></dt><dt><span class="sect2"><a href="#folder-format">3.67. folder_format</a></span></dt><dt><span class="sect2"><a href="#followup-to">3.68. followup_to</a></span></dt><dt><span class="sect2"><a href="#force-name">3.69. force_name</a></span></dt><dt><span class="sect2"><a href="#forward-decode">3.70. forward_decode</a></span></dt><dt><span class="sect2"><a href="#forward-decrypt">3.71. forward_decrypt</a></span></dt><dt><span class="sect2"><a href="#forward-edit">3.72. forward_edit</a></span></dt><dt><span class="sect2"><a href="#forward-format">3.73. forward_format</a></span></dt><dt><span class="sect2"><a href="#forward-quote">3.74. forward_quote</a></span></dt><dt><span class="sect2"><a href="#from">3.75. from</a></span></dt><dt><span class="sect2"><a href="#gecos-mask">3.76. gecos_mask</a></span></dt><dt><span class="sect2"><a href="#hdrs">3.77. hdrs</a></span></dt><dt><span class="sect2"><a href="#header">3.78. header</a></span></dt><dt><span class="sect2"><a href="#header-cache">3.79. header_cache</a></span></dt><dt><span class="sect2"><a href="#header-cache-compress">3.80. header_cache_compress</a></span></dt><dt><span class="sect2"><a href="#header-cache-pagesize">3.81. header_cache_pagesize</a></span></dt><dt><span class="sect2"><a href="#help">3.82. help</a></span></dt><dt><span class="sect2"><a href="#hidden-host">3.83. hidden_host</a></span></dt><dt><span class="sect2"><a href="#hide-limited">3.84. hide_limited</a></span></dt><dt><span class="sect2"><a href="#hide-missing">3.85. hide_missing</a></span></dt><dt><span class="sect2"><a href="#hide-thread-subject">3.86. hide_thread_subject</a></span></dt><dt><span class="sect2"><a href="#hide-top-limited">3.87. hide_top_limited</a></span></dt><dt><span class="sect2"><a href="#hide-top-missing">3.88. hide_top_missing</a></span></dt><dt><span class="sect2"><a href="#history">3.89. history</a></span></dt><dt><span class="sect2"><a href="#history-file">3.90. history_file</a></span></dt><dt><span class="sect2"><a href="#honor-disposition">3.91. honor_disposition</a></span></dt><dt><span class="sect2"><a href="#honor-followup-to">3.92. honor_followup_to</a></span></dt><dt><span class="sect2"><a href="#hostname">3.93. hostname</a></span></dt><dt><span class="sect2"><a href="#ignore-linear-white-space">3.94. ignore_linear_white_space</a></span></dt><dt><span class="sect2"><a href="#ignore-list-reply-to">3.95. ignore_list_reply_to</a></span></dt><dt><span class="sect2"><a href="#imap-authenticators">3.96. imap_authenticators</a></span></dt><dt><span class="sect2"><a href="#imap-check-subscribed">3.97. imap_check_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-delim-chars">3.98. imap_delim_chars</a></span></dt><dt><span class="sect2"><a href="#imap-headers">3.99. imap_headers</a></span></dt><dt><span class="sect2"><a href="#imap-idle">3.100. imap_idle</a></span></dt><dt><span class="sect2"><a href="#imap-keepalive">3.101. imap_keepalive</a></span></dt><dt><span class="sect2"><a href="#imap-list-subscribed">3.102. imap_list_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-login">3.103. imap_login</a></span></dt><dt><span class="sect2"><a href="#imap-pass">3.104. imap_pass</a></span></dt><dt><span class="sect2"><a href="#imap-passive">3.105. imap_passive</a></span></dt><dt><span class="sect2"><a href="#imap-peek">3.106. imap_peek</a></span></dt><dt><span class="sect2"><a href="#imap-pipeline-depth">3.107. imap_pipeline_depth</a></span></dt><dt><span class="sect2"><a href="#imap-servernoise">3.108. imap_servernoise</a></span></dt><dt><span class="sect2"><a href="#imap-user">3.109. imap_user</a></span></dt><dt><span class="sect2"><a href="#implicit-autoview">3.110. implicit_autoview</a></span></dt><dt><span class="sect2"><a href="#include">3.111. include</a></span></dt><dt><span class="sect2"><a href="#include-onlyfirst">3.112. include_onlyfirst</a></span></dt><dt><span class="sect2"><a href="#indent-string">3.113. indent_string</a></span></dt><dt><span class="sect2"><a href="#index-format">3.114. index_format</a></span></dt><dt><span class="sect2"><a href="#ispell">3.115. ispell</a></span></dt><dt><span class="sect2"><a href="#keep-flagged">3.116. keep_flagged</a></span></dt><dt><span class="sect2"><a href="#locale">3.117. locale</a></span></dt><dt><span class="sect2"><a href="#mail-check">3.118. mail_check</a></span></dt><dt><span class="sect2"><a href="#mail-check-recent">3.119. mail_check_recent</a></span></dt><dt><span class="sect2"><a href="#mailcap-path">3.120. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.121. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.122. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.123. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.124. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.125. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.126. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.127. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.128. mbox_type</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.129. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.130. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.131. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.132. message_cache_clean</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-format">3.134. message_format</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.135. meta_key</a></span></dt><dt><span class="sect2"><a href="#metoo">3.136. metoo</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.137. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.138. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.139. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.140. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.141. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.142. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.143. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.144. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.145. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.146. move</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.147. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.148. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.149. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.150. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.151. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.152. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.153. pager_stop</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.154. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.155. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.156. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.157. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.158. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.159. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.160. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.161. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.162. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.163. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.164. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.165. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.166. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.167. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.168. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.169. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.170. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.171. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.172. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.173. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.174. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.175. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.176. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.177. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.178. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.179. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.180. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.181. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.182. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.183. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.184. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.185. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.186. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.187. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.188. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.189. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.190. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.191. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.192. pop_pass</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.193. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.194. pop_user</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.195. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.196. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.197. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.198. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.199. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.200. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.201. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.202. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.203. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.204. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.205. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.206. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.207. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.208. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.209. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.210. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.211. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.212. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.213. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.214. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.215. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.216. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.217. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.218. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.219. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.220. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.221. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.222. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.223. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.224. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.225. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.226. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.227. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.228. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#search-context">3.229. search_context</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.230. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.231. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.232. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.233. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.234. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.235. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.236. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.237. simple_search</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.238. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.239. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.240. smileys</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.241. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.242. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.243. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.244. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.245. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.246. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.247. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.248. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.249. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.250. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.251. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.252. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.253. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.254. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.255. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.256. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.257. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.258. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.259. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.260. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.261. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.262. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.263. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.264. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.265. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.266. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.267. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.268. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.269. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.270. spoolfile</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.271. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.272. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.273. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.274. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.275. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.276. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.277. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.278. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.279. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-dates">3.280. ssl_verify_dates</a></span></dt><dt><span class="sect2"><a href="#ssl-verify-host">3.281. ssl_verify_host</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.282. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.283. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.284. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.285. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.286. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.287. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.288. thorough_search</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.289. thread_received</a></span></dt><dt><span class="sect2"><a href="#tilde">3.290. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.291. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.292. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.293. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.294. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.295. tunnel</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.296. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.297. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.298. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.299. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.300. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.301. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.302. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.303. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.304. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.305. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.306. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.307. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-headers">3.308. wrap_headers</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.309. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.310. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.311. write_bcc</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.312. write_inc</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="#attachment-map">4.6. Attachment 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="#mixmaster-map">4.12. Mixmaster 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" title="1. Command-Line Options"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commandline"></a>1. Command-Line Options</h2></div></div></div><p>
4171 Running <code class="literal">mutt</code> with no arguments will make Mutt attempt
4172 to read your spool mailbox.  However, it is possible to read other
4173 mailboxes and to send messages from the command line as well.
4174 </p><div class="table"><a id="tab-commandline-options"></a><p class="title"><b>Table 9.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 <span class="command"><strong>mailboxes</strong></span> 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>
4175 To read messages in a mailbox
4176 </p><div class="cmdsynopsis"><p><code class="command">mutt</code>  [<code class="option">-nz</code>] [<code class="option">-F</code>
4177 <em class="replaceable"><code>muttrc</code></em>
4178 ] [<code class="option">-m</code>
4179 <em class="replaceable"><code>type</code></em>
4180 ] [<code class="option">-f</code>
4181 <em class="replaceable"><code>mailbox</code></em>
4182 ]</p></div><p>
4183 To compose a new message
4184 </p><div class="cmdsynopsis"><p><code class="command">mutt</code>  [<code class="option">-n</code>] [<code class="option">-F</code>
4185 <em class="replaceable"><code>muttrc</code></em>
4186 ] [<code class="option">-c</code>
4187 <em class="replaceable"><code>address</code></em>
4188 ] [<code class="option">-i</code>
4189 <em class="replaceable"><code>filename</code></em>
4190 ] [<code class="option">-s</code>
4191 <em class="replaceable"><code>subject</code></em>
4192 ] [
4193 <code class="option">-a</code>
4194 <em class="replaceable"><code>file</code></em>
4195  [...]
4196 --
4197 ]   
4198 <em class="replaceable"><code>address</code></em>
4199   |   
4200 <em class="replaceable"><code>mailto_url</code></em>
4201  ... </p></div><p>
4202 Mutt also supports a <span class="quote">“<span class="quote">batch</span>”</span> mode to send prepared
4203 messages.  Simply redirect input from the file you wish to send.  For
4204 example,
4205 </p><pre class="screen">
4206 mutt -s "data set for run #2" professor@bigschool.edu &lt; ~/run2.dat</pre><p>
4207 will send a message to
4208 <code class="literal">&lt;professor@bigschool.edu&gt;</code> with a subject of
4209 <span class="quote">“<span class="quote">data set for run #2</span>”</span>.  In the body of the message will be
4210 the contents of the file <span class="quote">“<span class="quote">~/run2.dat</span>”</span>.
4211 </p><p>
4212 All files passed with <code class="literal">-a</code> <span class="emphasis"><em>file</em></span>
4213 will be attached as a MIME part to the message. To attach a single or
4214 several files, use <span class="quote">“<span class="quote">--</span>”</span> to separate files and recipient
4215 addresses:
4216 </p><pre class="screen">
4217 mutt -a image.png -- some@one.org</pre><p>
4218 or
4219 </p><pre class="screen">
4220 mutt -a *.png -- some@one.org</pre><div class="note" title="Note"><h3 class="title">Note</h3><p>
4221 The <code class="literal">-a</code> option must be last in the option list.
4222 </p></div><p>
4223 In addition to accepting a list of email addresses, Mutt also accepts a URL with
4224 the <code class="literal">mailto:</code> schema as specified in RFC2368.  This is useful
4225 when configuring a web browser to launch Mutt when clicking on mailto links.
4226 </p><pre class="screen">
4227 mutt mailto:some@one.org?subject=test&amp;cc=other@one.org</pre></div><div class="sect1" title="2. Configuration Commands"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commands"></a>2. Configuration Commands</h2></div></div></div><p>
4228 The following are the commands understood by Mutt:
4229 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts">account-hook</a></code>   
4230 <em class="replaceable"><code>pattern</code></em>
4231 <em class="replaceable"><code>command</code></em>
4232  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alias" title="4. Defining/Using Aliases">alias</a></code>  [
4233 <code class="option">-group</code>
4234 <em class="replaceable"><code>name</code></em>
4235 ...]  
4236 <em class="replaceable"><code>key</code></em>
4237    
4238 <em class="replaceable"><code>address</code></em>
4239   [
4240 <em class="replaceable"><code>address</code></em>
4241 ...]<br /><code class="command"><a class="link" href="#alias" title="4. Defining/Using Aliases">unalias</a></code>  [
4242 <code class="option">-group</code>
4243 <em class="replaceable"><code>name</code></em>
4244 ...] { 
4245 <em class="replaceable"><code>*</code></em>
4246   |   
4247 <em class="replaceable"><code>key</code></em>
4248 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></code>  [
4249 <code class="option">-group</code>
4250 <em class="replaceable"><code>name</code></em>
4251 ...]  
4252 <em class="replaceable"><code>regexp</code></em>
4253   [
4254 <em class="replaceable"><code>regexp</code></em>
4255 ...]<br /><code class="command"><a class="link" href="#alternates" title="11. Alternative Addresses">unalternates</a></code>  [
4256 <code class="option">-group</code>
4257 <em class="replaceable"><code>name</code></em>
4258 ...] { 
4259 <em class="replaceable"><code>*</code></em>
4260   |   
4261 <em class="replaceable"><code>regexp</code></em>
4262 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#alternative-order" title="5. MIME Multipart/Alternative">alternative-order</a></code>   
4263 <em class="replaceable"><code>mimetype</code></em>
4264   [
4265 <em class="replaceable"><code>mimetype</code></em>
4266 ...]<br /><code class="command"><a class="link" href="#alternative-order" title="5. MIME Multipart/Alternative">unalternative-order</a></code>  { 
4267 <em class="replaceable"><code>*</code></em>
4268   |   
4269 <em class="replaceable"><code>mimetype</code></em>
4270 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></code>   
4271 <em class="replaceable"><code>{ + | - }disposition</code></em>
4272    
4273 <em class="replaceable"><code>mime-type</code></em>
4274  <br /><code class="command"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">unattachments</a></code>   
4275 <em class="replaceable"><code>{ + | - }disposition</code></em>
4276    
4277 <em class="replaceable"><code>mime-type</code></em>
4278  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a></code>   
4279 <em class="replaceable"><code>mimetype</code></em>
4280   [
4281 <em class="replaceable"><code>mimetype</code></em>
4282 ...]<br /><code class="command"><a class="link" href="#auto-view" title="4. MIME Autoview">unauto_view</a></code>  { 
4283 <em class="replaceable"><code>*</code></em>
4284   |   
4285 <em class="replaceable"><code>mimetype</code></em>
4286 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#bind" title="5. Changing the Default Key Bindings">bind</a></code>   
4287 <em class="replaceable"><code>map</code></em>
4288    
4289 <em class="replaceable"><code>key</code></em>
4290    
4291 <em class="replaceable"><code>function</code></em>
4292  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#charset-hook" title="6. Defining Aliases for Character Sets">charset-hook</a></code>   
4293 <em class="replaceable"><code>alias</code></em>
4294    
4295 <em class="replaceable"><code>charset</code></em>
4296  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#iconv-hook">iconv-hook</a></code>   
4297 <em class="replaceable"><code>charset</code></em>
4298    
4299 <em class="replaceable"><code>local-charset</code></em>
4300  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a></code>   
4301 <em class="replaceable"><code>object</code></em>
4302    
4303 <em class="replaceable"><code>foreground</code></em>
4304    
4305 <em class="replaceable"><code>background</code></em>
4306  <br /><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a></code>  { 
4307 <code class="option">header</code>
4308   |   
4309 <code class="option">body</code>
4310  }  
4311 <em class="replaceable"><code>foreground</code></em>
4312    
4313 <em class="replaceable"><code>background</code></em>
4314    
4315 <em class="replaceable"><code>regexp</code></em>
4316  <br /><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">color</a></code>   
4317 <code class="option">index</code>
4318    
4319 <em class="replaceable"><code>foreground</code></em>
4320    
4321 <em class="replaceable"><code>background</code></em>
4322    
4323 <em class="replaceable"><code>pattern</code></em>
4324  <br /><code class="command"><a class="link" href="#color" title="9. Using Color and Mono Video Attributes">uncolor</a></code>  { 
4325 <code class="option">index</code>
4326   |   
4327 <code class="option">header</code>
4328   |   
4329 <code class="option">body</code>
4330  } { 
4331 <em class="replaceable"><code>*</code></em>
4332   |   
4333 <em class="replaceable"><code>pattern</code></em>
4334 ... }</p></div></li><li class="listitem"><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>   
4335 <em class="replaceable"><code>pattern</code></em>
4336    
4337 <em class="replaceable"><code>keyid</code></em>
4338  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#exec" title="23. Executing Functions">exec</a></code>   
4339 <em class="replaceable"><code>function</code></em>
4340   [
4341 <em class="replaceable"><code>function</code></em>
4342 ...]</p></div></li><li class="listitem"><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>   
4343 <em class="replaceable"><code>[!]pattern</code></em>
4344    
4345 <em class="replaceable"><code>mailbox</code></em>
4346  </p></div></li><li class="listitem"><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>   
4347 <em class="replaceable"><code>[!]pattern</code></em>
4348    
4349 <em class="replaceable"><code>mailbox</code></em>
4350  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#folder-hook" title="7. Setting Variables Based Upon Mailbox">folder-hook</a></code>   
4351 <em class="replaceable"><code>[!]regexp</code></em>
4352    
4353 <em class="replaceable"><code>command</code></em>
4354  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#addrgroup" title="3. Address Groups">group</a></code>  [
4355 <code class="option">-group</code>
4356 <em class="replaceable"><code>name</code></em>
4357 ...] { 
4358 <code class="option">-rx</code>
4359 <em class="replaceable"><code>expr</code></em>
4360 ...  |   
4361 <code class="option">-addr</code>
4362 <em class="replaceable"><code>expr</code></em>
4363 ... }<br /><code class="command"><a class="link" href="#addrgroup" title="3. Address Groups">ungroup</a></code>  [
4364 <code class="option">-group</code>
4365 <em class="replaceable"><code>name</code></em>
4366 ...] { 
4367 <em class="replaceable"><code>*</code></em>
4368   |   
4369 <code class="option">-rx</code>
4370 <em class="replaceable"><code>expr</code></em>
4371 ...  |   
4372 <code class="option">-addr</code>
4373 <em class="replaceable"><code>expr</code></em>
4374 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#hdr-order" title="10.3. Ordering Displayed Headers">hdr_order</a></code>   
4375 <em class="replaceable"><code>header</code></em>
4376   [
4377 <em class="replaceable"><code>header</code></em>
4378 ...]<br /><code class="command"><a class="link" href="#hdr-order" title="10.3. Ordering Displayed Headers">unhdr_order</a></code>  { 
4379 <em class="replaceable"><code>*</code></em>
4380   |   
4381 <em class="replaceable"><code>header</code></em>
4382 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#ignore" title="10.2. Selecting Headers">ignore</a></code>   
4383 <em class="replaceable"><code>pattern</code></em>
4384   [
4385 <em class="replaceable"><code>pattern</code></em>
4386 ...]<br /><code class="command"><a class="link" href="#ignore" title="10.2. Selecting Headers">unignore</a></code>  { 
4387 <em class="replaceable"><code>*</code></em>
4388   |   
4389 <em class="replaceable"><code>pattern</code></em>
4390 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#lists" title="12. Mailing Lists">lists</a></code>  [
4391 <code class="option">-group</code>
4392 <em class="replaceable"><code>name</code></em>
4393 ]  
4394 <em class="replaceable"><code>regexp</code></em>
4395   [
4396 <em class="replaceable"><code>regexp</code></em>
4397 ...]<br /><code class="command"><a class="link" href="#lists" title="12. Mailing Lists">unlists</a></code>  [
4398 <code class="option">-group</code>
4399 <em class="replaceable"><code>name</code></em>
4400 ...] { 
4401 <em class="replaceable"><code>*</code></em>
4402   |   
4403 <em class="replaceable"><code>regexp</code></em>
4404 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#macro" title="8. Keyboard Macros">macro</a></code>   
4405 <em class="replaceable"><code>menu</code></em>
4406    
4407 <em class="replaceable"><code>key</code></em>
4408    
4409 <em class="replaceable"><code>sequence</code></em>
4410   [
4411 <em class="replaceable"><code>description</code></em>
4412 ]</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></code>   
4413 <em class="replaceable"><code>mailbox</code></em>
4414   [
4415 <em class="replaceable"><code>mailbox</code></em>
4416 ...]<br /><code class="command"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">unmailboxes</a></code>  { 
4417 <em class="replaceable"><code>*</code></em>
4418   |   
4419 <em class="replaceable"><code>mailbox</code></em>
4420 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes">mbox-hook</a></code>   
4421 <em class="replaceable"><code>[!]pattern</code></em>
4422    
4423 <em class="replaceable"><code>mailbox</code></em>
4424  </p></div></li><li class="listitem"><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>   
4425 <em class="replaceable"><code>[!]pattern</code></em>
4426    
4427 <em class="replaceable"><code>command</code></em>
4428  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mime-lookup" title="7. MIME Lookup">mime-lookup</a></code>   
4429 <em class="replaceable"><code>mimetype</code></em>
4430   [
4431 <em class="replaceable"><code>mimetype</code></em>
4432 ...]<br /><code class="command"><a class="link" href="#mime-lookup" title="7. MIME Lookup">unmime-lookup</a></code>  { 
4433 <em class="replaceable"><code>*</code></em>
4434   |   
4435 <em class="replaceable"><code>mimetype</code></em>
4436 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#mono">mono</a></code>   
4437 <em class="replaceable"><code>object</code></em>
4438    
4439 <em class="replaceable"><code>attribute</code></em>
4440  <br /><code class="command"><a class="link" href="#mono">mono</a></code>  { 
4441 <code class="option">header</code>
4442   |   
4443 <code class="option">body</code>
4444  }  
4445 <em class="replaceable"><code>attribute</code></em>
4446    
4447 <em class="replaceable"><code>regexp</code></em>
4448  <br /><code class="command"><a class="link" href="#mono">mono</a></code>   
4449 <code class="option">index</code>
4450    
4451 <em class="replaceable"><code>attribute</code></em>
4452    
4453 <em class="replaceable"><code>pattern</code></em>
4454  <br /><code class="command"><a class="link" href="#mono">unmono</a></code>  { 
4455 <code class="option">index</code>
4456   |   
4457 <code class="option">header</code>
4458   |   
4459 <code class="option">body</code>
4460  } { 
4461 <em class="replaceable"><code>*</code></em>
4462   |   
4463 <em class="replaceable"><code>pattern</code></em>
4464 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></code>   
4465 <em class="replaceable"><code>string</code></em>
4466  <br /><code class="command"><a class="link" href="#my-hdr" title="15. User-Defined Headers">unmy_hdr</a></code>  { 
4467 <em class="replaceable"><code>*</code></em>
4468   |   
4469 <em class="replaceable"><code>field</code></em>
4470 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#push" title="22. Adding Key Sequences to the Keyboard Buffer">push</a></code>   
4471 <em class="replaceable"><code>string</code></em>
4472  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">save-hook</a></code>   
4473 <em class="replaceable"><code>[!]pattern</code></em>
4474    
4475 <em class="replaceable"><code>mailbox</code></em>
4476  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#score" title="3.225. score">score</a></code>   
4477 <em class="replaceable"><code>pattern</code></em>
4478    
4479 <em class="replaceable"><code>value</code></em>
4480  <br /><code class="command"><a class="link" href="#score" title="3.225. score">unscore</a></code>  { 
4481 <em class="replaceable"><code>*</code></em>
4482   |   
4483 <em class="replaceable"><code>pattern</code></em>
4484 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#reply-hook">reply-hook</a></code>   
4485 <em class="replaceable"><code>[!]pattern</code></em>
4486    
4487 <em class="replaceable"><code>command</code></em>
4488  </p></div></li><li class="listitem"><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>   
4489 <em class="replaceable"><code>[!]pattern</code></em>
4490    
4491 <em class="replaceable"><code>command</code></em>
4492  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#send2-hook">send2-hook</a></code>   
4493 <em class="replaceable"><code>[!]pattern</code></em>
4494    
4495 <em class="replaceable"><code>command</code></em>
4496  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">set</a></code>  { 
4497 [ <code class="option">no</code>  |   <code class="option">inv</code> ]
4498 <em class="replaceable"><code>variable</code></em>
4499   |   
4500 <em class="replaceable"><code>variable=value</code></em>
4501  } [...]<br /><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">toggle</a></code>   
4502 <em class="replaceable"><code>variable</code></em>
4503   [
4504 <em class="replaceable"><code>variable</code></em>
4505 ...]<br /><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">unset</a></code>   
4506 <em class="replaceable"><code>variable</code></em>
4507   [
4508 <em class="replaceable"><code>variable</code></em>
4509 ...]<br /><code class="command"><a class="link" href="#set" title="26. Setting and Querying Variables">reset</a></code>   
4510 <em class="replaceable"><code>variable</code></em>
4511   [
4512 <em class="replaceable"><code>variable</code></em>
4513 ...]</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#source" title="27. Reading Initialization Commands From Another File">source</a></code>   
4514 <em class="replaceable"><code>filename</code></em>
4515  </p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#spam" title="25. Spam Detection">spam</a></code>   
4516 <em class="replaceable"><code>pattern</code></em>
4517    
4518 <em class="replaceable"><code>format</code></em>
4519  <br /><code class="command"><a class="link" href="#spam" title="25. Spam Detection">nospam</a></code>  { 
4520 <em class="replaceable"><code>*</code></em>
4521   |   
4522 <em class="replaceable"><code>pattern</code></em>
4523  }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#subscribe">subscribe</a></code>  [
4524 <code class="option">-group</code>
4525 <em class="replaceable"><code>name</code></em>
4526 ...]  
4527 <em class="replaceable"><code>regexp</code></em>
4528   [
4529 <em class="replaceable"><code>regexp</code></em>
4530 ...]<br /><code class="command"><a class="link" href="#subscribe">unsubscribe</a></code>  [
4531 <code class="option">-group</code>
4532 <em class="replaceable"><code>name</code></em>
4533 ...] { 
4534 <em class="replaceable"><code>*</code></em>
4535   |   
4536 <em class="replaceable"><code>regexp</code></em>
4537 ... }</p></div></li><li class="listitem"><div class="cmdsynopsis"><p><code class="command"><a class="link" href="#unhook" title="28. Removing Hooks">unhook</a></code>  { 
4538 <em class="replaceable"><code>*</code></em>
4539   |   
4540 <em class="replaceable"><code>hook-type</code></em>
4541  }</p></div></li></ul></div></div><div class="sect1" title="3. Configuration Variables"><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" title="3.1. abort_nosubject"><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 />
4542 Default: ask-yes</p></div><p>
4543 If set to <span class="emphasis"><em>yes</em></span>, when composing messages and no subject is given
4544 at the subject prompt, composition will be aborted.  If set to
4545 <span class="emphasis"><em>no</em></span>, composing messages with no subject given at the subject
4546 prompt will never be aborted.
4547 </p></div><div class="sect2" title="3.2. abort_unmodified"><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 />
4548 Default: yes</p></div><p>
4549 If set to <span class="emphasis"><em>yes</em></span>, composition will automatically abort after
4550 editing the message body if no changes are made to the file (this
4551 check only happens after the <span class="emphasis"><em>first</em></span> edit of the file).  When set
4552 to <span class="emphasis"><em>no</em></span>, composition will never be aborted.
4553 </p></div><div class="sect2" title="3.3. alias_file"><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 />
4554 Default: <span class="quote">“<span class="quote"><code class="literal">~/.muttrc</code></span>”</span></p></div><p>
4555 The default file in which to save aliases created by the
4556 <code class="literal"><a class="link" href="#create-alias">&lt;create-alias&gt;</a></code> function. Entries added to this file are
4557 encoded in the character set specified by <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a> if it
4558 is <span class="emphasis"><em>set</em></span> or the current character set otherwise.
4559 </p><p>
4560 <span class="bold"><strong>Note:</strong></span> Mutt will not automatically source this file; you must
4561 explicitly use the <span class="quote">“<span class="quote"><a class="link" href="#source" title="27. Reading Initialization Commands From Another File">source</a></span>”</span> command for it to be executed in case
4562 this option points to a dedicated alias file.
4563 </p><p>
4564 The default for this option is the currently used muttrc file, or
4565 <span class="quote">“<span class="quote">~/.muttrc</span>”</span> if no user muttrc was found.
4566 </p></div><div class="sect2" title="3.4. alias_format"><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 />
4567 Default: <span class="quote">“<span class="quote"><code class="literal">%4n %2f %t %-10a   %r</code></span>”</span></p></div><p>
4568 Specifies the format of the data displayed for the <span class="quote">“<span class="quote"><a class="link" href="#alias" title="4. Defining/Using Aliases">alias</a></span>”</span> menu.  The
4569 following <code class="literal">printf(3)</code>-style sequences are available:
4570
4571 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>alias name
4572 </td></tr><tr><td>%f </td><td>flags - currently, a <span class="quote">“<span class="quote">d</span>”</span> for an alias marked for deletion
4573 </td></tr><tr><td>%n </td><td>index number
4574 </td></tr><tr><td>%r </td><td>address which alias expands to
4575 </td></tr><tr><td>%t </td><td>character which indicates if the alias is tagged for inclusion
4576 </td></tr></tbody></table></div></div><div class="sect2" title="3.5. allow_8bit"><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 />
4577 Default: yes</p></div><p>
4578 Controls whether 8-bit data is converted to 7-bit using either Quoted-
4579 Printable or Base64 encoding when sending mail.
4580 </p></div><div class="sect2" title="3.6. allow_ansi"><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 />
4581 Default: no</p></div><p>
4582 Controls whether ANSI color codes in messages (and color tags in
4583 rich text messages) are to be interpreted.
4584 Messages containing these codes are rare, but if this option is <span class="emphasis"><em>set</em></span>,
4585 their text will be colored accordingly. Note that this may override
4586 your color choices, and even present a security problem, since a
4587 message could include a line like
4588
4589 </p><pre class="screen">
4590 [-- PGP output follows ...
4591 </pre><p>
4592 and give it the same color as your attachment color (see also
4593 <a class="link" href="#crypt-timestamp" title="3.43. crypt_timestamp">$crypt_timestamp</a>).
4594 </p></div><div class="sect2" title="3.7. arrow_cursor"><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 />
4595 Default: no</p></div><p>
4596 When <span class="emphasis"><em>set</em></span>, an arrow (<span class="quote">“<span class="quote">-&gt;</span>”</span>) will be used to indicate the current entry
4597 in menus instead of highlighting the whole line.  On slow network or modem
4598 links this will make response faster because there is less that has to
4599 be redrawn on the screen when moving to the next or previous entries
4600 in the menu.
4601 </p></div><div class="sect2" title="3.8. ascii_chars"><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 />
4602 Default: no</p></div><p>
4603 If <span class="emphasis"><em>set</em></span>, Mutt will use plain ASCII characters when displaying thread
4604 and attachment trees, instead of the default <span class="emphasis"><em>ACS</em></span> characters.
4605 </p></div><div class="sect2" title="3.9. askbcc"><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 />
4606 Default: no</p></div><p>
4607 If <span class="emphasis"><em>set</em></span>, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
4608 before editing an outgoing message.
4609 </p></div><div class="sect2" title="3.10. askcc"><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 />
4610 Default: no</p></div><p>
4611 If <span class="emphasis"><em>set</em></span>, Mutt will prompt you for carbon-copy (Cc) recipients before
4612 editing the body of an outgoing message.
4613 </p></div><div class="sect2" title="3.11. assumed_charset"><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 />
4614 Default: (empty)</p></div><p>
4615 This variable is a colon-separated list of character encoding
4616 schemes for messages without character encoding indication.
4617 Header field values and message body content without character encoding
4618 indication would be assumed that they are written in one of this list.
4619 By default, all the header fields and message body without any charset
4620 indication are assumed to be in <span class="quote">“<span class="quote">us-ascii</span>”</span>.
4621 </p><p>
4622 For example, Japanese users might prefer this:
4623
4624 </p><pre class="screen">
4625 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
4626 </pre><p>
4627 However, only the first content is valid for the message body.
4628 </p></div><div class="sect2" title="3.12. attach_charset"><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 />
4629 Default: (empty)</p></div><p>
4630 This variable is a colon-separated list of character encoding
4631 schemes for text file attachments. Mutt uses this setting to guess
4632 which encoding files being attached are encoded in to convert them to
4633 a proper character set given in <a class="link" href="#send-charset" title="3.230. send_charset">$send_charset</a>.
4634 </p><p>
4635 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.
4636 For example, the following configuration would work for Japanese
4637 text handling:
4638
4639 </p><pre class="screen">
4640 set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
4641 </pre><p>
4642 Note: for Japanese users, <span class="quote">“<span class="quote">iso-2022-*</span>”</span> must be put at the head
4643 of the value as shown above if included.
4644 </p></div><div class="sect2" title="3.13. attach_format"><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 />
4645 Default: <span class="quote">“<span class="quote"><code class="literal">%u%D%I %t%4n %T%.40d%&gt; [%.7m/%.10M, %.6e%?C?, %C?, %s] </code></span>”</span></p></div><p>
4646 This variable describes the format of the <span class="quote">“<span class="quote">attachment</span>”</span> menu.  The
4647 following <code class="literal">printf(3)</code>-style sequences are understood:
4648
4649 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%C  </td><td>charset
4650 </td></tr><tr><td>%c  </td><td>requires charset conversion (<span class="quote">“<span class="quote">n</span>”</span> or <span class="quote">“<span class="quote">c</span>”</span>)
4651 </td></tr><tr><td>%D  </td><td>deleted flag
4652 </td></tr><tr><td>%d  </td><td>description
4653 </td></tr><tr><td>%e  </td><td>MIME content-transfer-encoding
4654 </td></tr><tr><td>%f  </td><td>filename
4655 </td></tr><tr><td>%I  </td><td>disposition (<span class="quote">“<span class="quote">I</span>”</span> for inline, <span class="quote">“<span class="quote">A</span>”</span> for attachment)
4656 </td></tr><tr><td>%m  </td><td>major MIME type
4657 </td></tr><tr><td>%M  </td><td>MIME subtype
4658 </td></tr><tr><td>%n  </td><td>attachment number
4659 </td></tr><tr><td>%Q  </td><td><span class="quote">“<span class="quote">Q</span>”</span>, if MIME part qualifies for attachment counting
4660 </td></tr><tr><td>%s  </td><td>size
4661 </td></tr><tr><td>%t  </td><td>tagged flag
4662 </td></tr><tr><td>%T  </td><td>graphic tree characters
4663 </td></tr><tr><td>%u  </td><td>unlink (=to delete) flag
4664 </td></tr><tr><td>%X  </td><td>number of qualifying MIME parts in this part and its children
4665 (please see the <span class="quote">“<span class="quote"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></span>”</span> section for possible speed effects)
4666 </td></tr><tr><td>%&gt;X </td><td>right justify the rest of the string and pad with character <span class="quote">“<span class="quote">X</span>”</span>
4667 </td></tr><tr><td>%|X </td><td>pad to the end of the line with character <span class="quote">“<span class="quote">X</span>”</span>
4668 </td></tr><tr><td>%*X </td><td>soft-fill with character <span class="quote">“<span class="quote">X</span>”</span> as pad
4669 </td></tr></tbody></table></div><p>
4670 For an explanation of <span class="quote">“<span class="quote">soft-fill</span>”</span>, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
4671 </p></div><div class="sect2" title="3.14. attach_sep"><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 />
4672 Default: <span class="quote">“<span class="quote"><code class="literal">\n</code></span>”</span></p></div><p>
4673 The separator to add between attachments when operating (saving,
4674 printing, piping, etc) on a list of tagged attachments.
4675 </p></div><div class="sect2" title="3.15. attach_split"><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 />
4676 Default: yes</p></div><p>
4677 If this variable is <span class="emphasis"><em>unset</em></span>, when operating (saving, printing, piping,
4678 etc) on a list of tagged attachments, Mutt will concatenate the
4679 attachments and will operate on them as a single attachment. The
4680 <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>,
4681 Mutt will operate on the attachments one by one.
4682 </p></div><div class="sect2" title="3.16. attribution"><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 />
4683 Default: <span class="quote">“<span class="quote"><code class="literal">On %d, %n wrote:</code></span>”</span></p></div><p>
4684 This is the string that will precede a message which has been included
4685 in a reply.  For a full listing of defined <code class="literal">printf(3)</code>-like sequences see
4686 the section on <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.
4687 </p></div><div class="sect2" title="3.17. auto_tag"><div class="titlepage"><div><div><h3 class="title"><a id="auto-tag"></a>3.17. auto_tag</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4688 Default: no</p></div><p>
4689 When <span class="emphasis"><em>set</em></span>, functions in the <span class="emphasis"><em>index</em></span> menu which affect a message
4690 will be applied to all tagged messages (if there are any).  When
4691 unset, you must first use the <code class="literal">&lt;tag-prefix&gt;</code> function (bound to <span class="quote">“<span class="quote">;</span>”</span>
4692 by default) to make the next function apply to all tagged messages.
4693 </p></div><div class="sect2" title="3.18. autoedit"><div class="titlepage"><div><div><h3 class="title"><a id="autoedit"></a>3.18. autoedit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4694 Default: no</p></div><p>
4695 When <span class="emphasis"><em>set</em></span> along with <a class="link" href="#edit-headers" title="3.57. edit_headers">$edit_headers</a>, Mutt will skip the initial
4696 send-menu (prompting for subject and recipients) and allow you to
4697 immediately begin editing the body of your
4698 message.  The send-menu may still be accessed once you have finished
4699 editing the body of your message.
4700 </p><p>
4701 <span class="bold"><strong>Note:</strong></span> when this option is <span class="emphasis"><em>set</em></span>, you cannot use send-hooks that depend
4702 on the recipients when composing a new (non-reply) message, as the initial
4703 list of recipients is empty.
4704 </p><p>
4705 Also see <a class="link" href="#fast-reply" title="3.63. fast_reply">$fast_reply</a>.
4706 </p></div><div class="sect2" title="3.19. beep"><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 />
4707 Default: yes</p></div><p>
4708 When this variable is <span class="emphasis"><em>set</em></span>, mutt will beep when an error occurs.
4709 </p></div><div class="sect2" title="3.20. beep_new"><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 />
4710 Default: no</p></div><p>
4711 When this variable is <span class="emphasis"><em>set</em></span>, mutt will beep whenever it prints a message
4712 notifying you of new mail.  This is independent of the setting of the
4713 <a class="link" href="#beep" title="3.19. beep">$beep</a> variable.
4714 </p></div><div class="sect2" title="3.21. bounce"><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 />
4715 Default: ask-yes</p></div><p>
4716 Controls whether you will be asked to confirm bouncing messages.
4717 If set to <span class="emphasis"><em>yes</em></span> you don't get asked if you want to bounce a
4718 message. Setting this variable to <span class="emphasis"><em>no</em></span> is not generally useful,
4719 and thus not recommended, because you are unable to bounce messages.
4720 </p></div><div class="sect2" title="3.22. bounce_delivered"><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 />
4721 Default: yes</p></div><p>
4722 When this variable is <span class="emphasis"><em>set</em></span>, mutt will include Delivered-To headers when
4723 bouncing messages.  Postfix users may wish to <span class="emphasis"><em>unset</em></span> this variable.
4724 </p></div><div class="sect2" title="3.23. braille_friendly"><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 />
4725 Default: no</p></div><p>
4726 When this variable is <span class="emphasis"><em>set</em></span>, mutt will place the cursor at the beginning
4727 of the current line in menus, even when the <a class="link" href="#arrow-cursor" title="3.7. arrow_cursor">$arrow_cursor</a> variable
4728 is <span class="emphasis"><em>unset</em></span>, making it easier for blind persons using Braille displays to
4729 follow these menus.  The option is <span class="emphasis"><em>unset</em></span> by default because many
4730 visual terminals don't permit making the cursor invisible.
4731 </p></div><div class="sect2" title="3.24. certificate_file"><div class="titlepage"><div><div><h3 class="title"><a id="certificate-file"></a>3.24. certificate_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4732 Default: <span class="quote">“<span class="quote"><code class="literal">~/.mutt_certificates</code></span>”</span></p></div><p>
4733 This variable specifies the file where the certificates you trust
4734 are saved. When an unknown certificate is encountered, you are asked
4735 if you accept it or not. If you accept it, the certificate can also
4736 be saved in this file and further connections are automatically
4737 accepted.
4738 </p><p>
4739 You can also manually add CA certificates in this file. Any server
4740 certificate that is signed with one of these CA certificates is
4741 also automatically accepted.
4742 </p><p>
4743 Example:
4744
4745 </p><pre class="screen">
4746 set certificate_file=~/.mutt/certificates
4747 </pre></div><div class="sect2" title="3.25. charset"><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 />
4748 Default: (empty)</p></div><p>
4749 Character set your terminal uses to display and enter textual data.
4750 It is also the fallback for <a class="link" href="#send-charset" title="3.230. send_charset">$send_charset</a>.
4751 </p><p>
4752 Upon startup Mutt tries to derive this value from environment variables
4753 such as <code class="literal">$LC_CTYPE</code> or <code class="literal">$LANG</code>.
4754 </p><p>
4755 <span class="bold"><strong>Note:</strong></span> It should only be set in case Mutt isn't able to determine the
4756 character set used correctly.
4757 </p></div><div class="sect2" title="3.26. check_mbox_size"><div class="titlepage"><div><div><h3 class="title"><a id="check-mbox-size"></a>3.26. check_mbox_size</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4758 Default: no</p></div><p>
4759 When this variable is <span class="emphasis"><em>set</em></span>, mutt will use file size attribute instead of
4760 access time when checking for new mail in mbox and mmdf folders.
4761 </p><p>
4762 This variable is <span class="emphasis"><em>unset</em></span> by default and should only be enabled when
4763 new mail detection for these folder types is unreliable or doesn't work.
4764 </p><p>
4765 Note that enabling this variable should happen before any <span class="quote">“<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></span>”</span>
4766 directives occur in configuration files regarding mbox or mmdf folders
4767 because mutt needs to determine the initial new mail status of such a
4768 mailbox by performing a fast mailbox scan when it is defined.
4769 Afterwards the new mail status is tracked by file size changes.
4770 </p></div><div class="sect2" title="3.27. check_new"><div class="titlepage"><div><div><h3 class="title"><a id="check-new"></a>3.27. check_new</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4771 Default: yes</p></div><p>
4772 <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
4773 mailboxes.
4774 </p><p>
4775 When <span class="emphasis"><em>set</em></span>, Mutt will check for new mail delivered while the
4776 mailbox is open.  Especially with MH mailboxes, this operation can
4777 take quite some time since it involves scanning the directory and
4778 checking each file to see if it has already been looked at.  If
4779 this variable is <span class="emphasis"><em>unset</em></span>, no check for new mail is performed
4780 while the mailbox is open.
4781 </p></div><div class="sect2" title="3.28. collapse_unread"><div class="titlepage"><div><div><h3 class="title"><a id="collapse-unread"></a>3.28. collapse_unread</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4782 Default: yes</p></div><p>
4783 When <span class="emphasis"><em>unset</em></span>, Mutt will not collapse a thread if it contains any
4784 unread messages.
4785 </p></div><div class="sect2" title="3.29. compose_format"><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 />
4786 Default: <span class="quote">“<span class="quote"><code class="literal">-- Mutt: Compose  [Approx. msg size: %l   Atts: %a]%&gt;-</code></span>”</span></p></div><p>
4787 Controls the format of the status line displayed in the <span class="quote">“<span class="quote">compose</span>”</span>
4788 menu.  This string is similar to <a class="link" href="#status-format" title="3.283. status_format">$status_format</a>, but has its own
4789 set of <code class="literal">printf(3)</code>-like sequences:
4790
4791 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>total number of attachments
4792 </td></tr><tr><td>%h </td><td>local hostname
4793 </td></tr><tr><td>%l </td><td>approximate size (in bytes) of the current message
4794 </td></tr><tr><td>%v </td><td>Mutt version string
4795 </td></tr></tbody></table></div><p>
4796 See the text describing the <a class="link" href="#status-format" title="3.283. status_format">$status_format</a> option for more
4797 information on how to set <a class="link" href="#compose-format" title="3.29. compose_format">$compose_format</a>.
4798 </p></div><div class="sect2" title="3.30. config_charset"><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 />
4799 Default: (empty)</p></div><p>
4800 When defined, Mutt will recode commands in rc files from this
4801 encoding to the current character set as specified by <a class="link" href="#charset" title="3.25. charset">$charset</a>
4802 and aliases written to <a class="link" href="#alias-file" title="3.3. alias_file">$alias_file</a> from the current character set.
4803 </p><p>
4804 Please note that if setting <a class="link" href="#charset" title="3.25. charset">$charset</a> it must be done before
4805 setting <a class="link" href="#config-charset" title="3.30. config_charset">$config_charset</a>.
4806 </p><p>
4807 Recoding should be avoided as it may render unconvertable
4808 characters as question marks which can lead to undesired
4809 side effects (for example in regular expressions).
4810 </p></div><div class="sect2" title="3.31. confirmappend"><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 />
4811 Default: yes</p></div><p>
4812 When <span class="emphasis"><em>set</em></span>, Mutt will prompt for confirmation when appending messages to
4813 an existing mailbox.
4814 </p></div><div class="sect2" title="3.32. confirmcreate"><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 />
4815 Default: yes</p></div><p>
4816 When <span class="emphasis"><em>set</em></span>, Mutt will prompt for confirmation when saving messages to a
4817 mailbox which does not yet exist before creating it.
4818 </p></div><div class="sect2" title="3.33. connect_timeout"><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 />
4819 Default: 30</p></div><p>
4820 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
4821 many seconds if the connection is not able to be established.  A negative
4822 value causes Mutt to wait indefinitely for the connection attempt to succeed.
4823 </p></div><div class="sect2" title="3.34. content_type"><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 />
4824 Default: <span class="quote">“<span class="quote"><code class="literal">text/plain</code></span>”</span></p></div><p>
4825 Sets the default Content-Type for the body of newly composed messages.
4826 </p></div><div class="sect2" title="3.35. copy"><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 />
4827 Default: yes</p></div><p>
4828 This variable controls whether or not copies of your outgoing messages
4829 will be saved for later references.  Also see <a class="link" href="#record" title="3.212. record">$record</a>,
4830 <a class="link" href="#save-name" title="3.224. save_name">$save_name</a>, <a class="link" href="#force-name" title="3.69. force_name">$force_name</a> and <span class="quote">“<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>”</span>.
4831 </p></div><div class="sect2" title="3.36. crypt_autoencrypt"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autoencrypt"></a>3.36. crypt_autoencrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4832 Default: no</p></div><p>
4833 Setting this variable will cause Mutt to always attempt to PGP
4834 encrypt outgoing messages.  This is probably only useful in
4835 connection to the <span class="quote">“<span class="quote"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></span>”</span> command.  It can be overridden
4836 by use of the pgp menu, when encryption is not required or
4837 signing is requested as well.  If <a class="link" href="#smime-is-default" title="3.253. smime_is_default">$smime_is_default</a> is <span class="emphasis"><em>set</em></span>,
4838 then OpenSSL is used instead to create S/MIME messages and
4839 settings can be overridden by use of the smime menu instead.
4840 (Crypto only)
4841 </p></div><div class="sect2" title="3.37. crypt_autopgp"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autopgp"></a>3.37. crypt_autopgp</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4842 Default: yes</p></div><p>
4843 This variable controls whether or not mutt may automatically enable
4844 PGP encryption/signing for messages.  See also <a class="link" href="#crypt-autoencrypt" title="3.36. crypt_autoencrypt">$crypt_autoencrypt</a>,
4845 <a class="link" href="#crypt-replyencrypt" title="3.40. crypt_replyencrypt">$crypt_replyencrypt</a>,
4846 <a class="link" href="#crypt-autosign" title="3.38. crypt_autosign">$crypt_autosign</a>, <a class="link" href="#crypt-replysign" title="3.41. crypt_replysign">$crypt_replysign</a> and <a class="link" href="#smime-is-default" title="3.253. smime_is_default">$smime_is_default</a>.
4847 </p></div><div class="sect2" title="3.38. crypt_autosign"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autosign"></a>3.38. crypt_autosign</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4848 Default: no</p></div><p>
4849 Setting this variable will cause Mutt to always attempt to
4850 cryptographically sign outgoing messages.  This can be overridden
4851 by use of the pgp menu, when signing is not required or
4852 encryption is requested as well. If <a class="link" href="#smime-is-default" title="3.253. smime_is_default">$smime_is_default</a> is <span class="emphasis"><em>set</em></span>,
4853 then OpenSSL is used instead to create S/MIME messages and settings can
4854 be overridden by use of the smime menu instead of the pgp menu.
4855 (Crypto only)
4856 </p></div><div class="sect2" title="3.39. crypt_autosmime"><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 />
4857 Default: yes</p></div><p>
4858 This variable controls whether or not mutt may automatically enable
4859 S/MIME encryption/signing for messages. See also <a class="link" href="#crypt-autoencrypt" title="3.36. crypt_autoencrypt">$crypt_autoencrypt</a>,
4860 <a class="link" href="#crypt-replyencrypt" title="3.40. crypt_replyencrypt">$crypt_replyencrypt</a>,
4861 <a class="link" href="#crypt-autosign" title="3.38. crypt_autosign">$crypt_autosign</a>, <a class="link" href="#crypt-replysign" title="3.41. crypt_replysign">$crypt_replysign</a> and <a class="link" href="#smime-is-default" title="3.253. smime_is_default">$smime_is_default</a>.
4862 </p></div><div class="sect2" title="3.40. crypt_replyencrypt"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replyencrypt"></a>3.40. crypt_replyencrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4863 Default: yes</p></div><p>
4864 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL encrypt replies to messages which are
4865 encrypted.
4866 (Crypto only)
4867 </p></div><div class="sect2" title="3.41. crypt_replysign"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replysign"></a>3.41. crypt_replysign</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4868 Default: no</p></div><p>
4869 If <span class="emphasis"><em>set</em></span>, automatically PGP or OpenSSL sign replies to messages which are
4870 signed.
4871 </p><p>
4872 <span class="bold"><strong>Note:</strong></span> this does not work on messages that are encrypted
4873 <span class="emphasis"><em>and</em></span> signed!
4874 (Crypto only)
4875 </p></div><div class="sect2" title="3.42. crypt_replysignencrypted"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replysignencrypted"></a>3.42. crypt_replysignencrypted</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>, automatically PGP or OpenSSL sign replies to messages
4878 which are encrypted. This makes sense in combination with
4879 <a class="link" href="#crypt-replyencrypt" title="3.40. crypt_replyencrypt">$crypt_replyencrypt</a>, because it allows you to sign all
4880 messages which are automatically encrypted.  This works around
4881 the problem noted in <a class="link" href="#crypt-replysign" title="3.41. crypt_replysign">$crypt_replysign</a>, that mutt is not able
4882 to find out whether an encrypted message is also signed.
4883 (Crypto only)
4884 </p></div><div class="sect2" title="3.43. crypt_timestamp"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-timestamp"></a>3.43. crypt_timestamp</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4885 Default: yes</p></div><p>
4886 If <span class="emphasis"><em>set</em></span>, mutt will include a time stamp in the lines surrounding
4887 PGP or S/MIME output, so spoofing such lines is more difficult.
4888 If you are using colors to mark these lines, and rely on these,
4889 you may <span class="emphasis"><em>unset</em></span> this setting.
4890 (Crypto only)
4891 </p></div><div class="sect2" title="3.44. crypt_use_gpgme"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-gpgme"></a>3.44. crypt_use_gpgme</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4892 Default: no</p></div><p>
4893 This variable controls the use of the GPGME-enabled crypto backends.
4894 If it is <span class="emphasis"><em>set</em></span> and Mutt was built with gpgme support, the gpgme code for
4895 S/MIME and PGP will be used instead of the classic code.  Note that
4896 you need to set this option in .muttrc; it won't have any effect when
4897 used interactively.
4898 </p></div><div class="sect2" title="3.45. crypt_use_pka"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-pka"></a>3.45. crypt_use_pka</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4899 Default: no</p></div><p>
4900 Controls whether mutt uses PKA
4901 (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature
4902 verification (only supported by the GPGME backend).
4903 </p></div><div class="sect2" title="3.46. crypt_verify_sig"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-verify-sig"></a>3.46. crypt_verify_sig</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4904 Default: yes</p></div><p>
4905 If <span class="emphasis"><em><span class="quote">“<span class="quote">yes</span>”</span></em></span>, always attempt to verify PGP or S/MIME signatures.
4906 If <span class="emphasis"><em><span class="quote">“<span class="quote">ask-*</span>”</span></em></span>, ask whether or not to verify the signature.
4907 If <span class="emphasis"><em><span class="quote">“<span class="quote">no</span>”</span></em></span>, never attempt to verify cryptographic signatures.
4908 (Crypto only)
4909 </p></div><div class="sect2" title="3.47. date_format"><div class="titlepage"><div><div><h3 class="title"><a id="date-format"></a>3.47. date_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4910 Default: <span class="quote">“<span class="quote"><code class="literal">!%a, %b %d, %Y at %I:%M:%S%p %Z</code></span>”</span></p></div><p>
4911 This variable controls the format of the date printed by the <span class="quote">“<span class="quote">%d</span>”</span>
4912 sequence in <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.  This is passed to the <code class="literal">strftime(3)</code>
4913 function to process the date, see the man page for the proper syntax.
4914 </p><p>
4915 Unless the first character in the string is a bang (<span class="quote">“<span class="quote">!</span>”</span>), the month
4916 and week day names are expanded according to the locale specified in
4917 the variable <a class="link" href="#locale" title="3.117. locale">$locale</a>. If the first character in the string is a
4918 bang, the bang is discarded, and the month and week day names in the
4919 rest of the string are expanded in the <span class="emphasis"><em>C</em></span> locale (that is in US
4920 English).
4921 </p></div><div class="sect2" title="3.48. default_hook"><div class="titlepage"><div><div><h3 class="title"><a id="default-hook"></a>3.48. default_hook</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4922 Default: <span class="quote">“<span class="quote"><code class="literal">~f %s !~P | (~P ~C %s)</code></span>”</span></p></div><p>
4923 This variable controls how <span class="quote">“<span class="quote"><a class="link" href="#message-hook" title="20. Change Settings Before Formatting a Message">message-hook</a></span>”</span>, <span class="quote">“<span class="quote"><a class="link" href="#reply-hook">reply-hook</a></span>”</span>, <span class="quote">“<span class="quote"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></span>”</span>,
4924 <span class="quote">“<span class="quote"><a class="link" href="#send2-hook">send2-hook</a></span>”</span>, <span class="quote">“<span class="quote"><a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">save-hook</a></span>”</span>, and <span class="quote">“<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>”</span> will
4925 be interpreted if they are specified with only a simple regexp,
4926 instead of a matching pattern.  The hooks are expanded when they are
4927 declared, so a hook will be interpreted according to the value of this
4928 variable at the time the hook is declared.
4929 </p><p>
4930 The default value matches
4931 if the message is either from a user matching the regular expression
4932 given, or if it is from you (if the from address matches
4933 <span class="quote">“<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”</span>) and is to or cc'ed to a user matching the given
4934 regular expression.
4935 </p></div><div class="sect2" title="3.49. delete"><div class="titlepage"><div><div><h3 class="title"><a id="delete"></a>3.49. delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4936 Default: ask-yes</p></div><p>
4937 Controls whether or not messages are really deleted when closing or
4938 synchronizing a mailbox.  If set to <span class="emphasis"><em>yes</em></span>, messages marked for
4939 deleting will automatically be purged without prompting.  If set to
4940 <span class="emphasis"><em>no</em></span>, messages marked for deletion will be kept in the mailbox.
4941 </p></div><div class="sect2" title="3.50. delete_untag"><div class="titlepage"><div><div><h3 class="title"><a id="delete-untag"></a>3.50. delete_untag</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4942 Default: yes</p></div><p>
4943 If this option is <span class="emphasis"><em>set</em></span>, mutt will untag messages when marking them
4944 for deletion.  This applies when you either explicitly delete a message,
4945 or when you save it to another folder.
4946 </p></div><div class="sect2" title="3.51. digest_collapse"><div class="titlepage"><div><div><h3 class="title"><a id="digest-collapse"></a>3.51. digest_collapse</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4947 Default: yes</p></div><p>
4948 If this option is <span class="emphasis"><em>set</em></span>, mutt's received-attachments menu will not show the subparts of
4949 individual messages in a multipart/digest.  To see these subparts, press <span class="quote">“<span class="quote">v</span>”</span> on that menu.
4950 </p></div><div class="sect2" title="3.52. display_filter"><div class="titlepage"><div><div><h3 class="title"><a id="display-filter"></a>3.52. display_filter</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4951 Default: (empty)</p></div><p>
4952 When set, specifies a command used to filter messages.  When a message
4953 is viewed it is passed as standard input to <a class="link" href="#display-filter" title="3.52. display_filter">$display_filter</a>, and the
4954 filtered message is read from the standard output.
4955 </p></div><div class="sect2" title="3.53. dotlock_program"><div class="titlepage"><div><div><h3 class="title"><a id="dotlock-program"></a>3.53. dotlock_program</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4956 Default: <span class="quote">“<span class="quote"><code class="literal">/usr/local/bin/mutt_dotlock</code></span>”</span></p></div><p>
4957 Contains the path of the <code class="literal">mutt_dotlock(8)</code> binary to be used by
4958 mutt.
4959 </p></div><div class="sect2" title="3.54. dsn_notify"><div class="titlepage"><div><div><h3 class="title"><a id="dsn-notify"></a>3.54. dsn_notify</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4960 Default: (empty)</p></div><p>
4961 This variable sets the request for when notification is returned.  The
4962 string consists of a comma separated list (no spaces!) of one or more
4963 of the following: <span class="emphasis"><em>never</em></span>, to never request notification,
4964 <span class="emphasis"><em>failure</em></span>, to request notification on transmission failure,
4965 <span class="emphasis"><em>delay</em></span>, to be notified of message delays, <span class="emphasis"><em>success</em></span>, to be
4966 notified of successful transmission.
4967 </p><p>
4968 Example:
4969
4970 </p><pre class="screen">
4971 set dsn_notify="failure,delay"
4972 </pre><p>
4973 <span class="bold"><strong>Note:</strong></span> when using <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> for delivery, you should not enable
4974 this unless you are either using Sendmail 8.8.x or greater or a MTA
4975 providing a <code class="literal">sendmail(1)</code>-compatible interface supporting the <code class="literal">-N</code> option
4976 for DSN. For SMTP delivery, DSN support is auto-detected so that it
4977 depends on the server whether DSN will be used or not.
4978 </p></div><div class="sect2" title="3.55. dsn_return"><div class="titlepage"><div><div><h3 class="title"><a id="dsn-return"></a>3.55. dsn_return</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4979 Default: (empty)</p></div><p>
4980 This variable controls how much of your message is returned in DSN
4981 messages.  It may be set to either <span class="emphasis"><em>hdrs</em></span> to return just the
4982 message header, or <span class="emphasis"><em>full</em></span> to return the full message.
4983 </p><p>
4984 Example:
4985
4986 </p><pre class="screen">
4987 set dsn_return=hdrs
4988 </pre><p>
4989 <span class="bold"><strong>Note:</strong></span> when using <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> for delivery, you should not enable
4990 this unless you are either using Sendmail 8.8.x or greater or a MTA
4991 providing a <code class="literal">sendmail(1)</code>-compatible interface supporting the <code class="literal">-R</code> option
4992 for DSN. For SMTP delivery, DSN support is auto-detected so that it
4993 depends on the server whether DSN will be used or not.
4994 </p></div><div class="sect2" title="3.56. duplicate_threads"><div class="titlepage"><div><div><h3 class="title"><a id="duplicate-threads"></a>3.56. duplicate_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4995 Default: yes</p></div><p>
4996 This variable controls whether mutt, when <a class="link" href="#sort" title="3.264. sort">$sort</a> is set to <span class="emphasis"><em>threads</em></span>, threads
4997 messages with the same Message-Id together.  If it is <span class="emphasis"><em>set</em></span>, it will indicate
4998 that it thinks they are duplicates of each other with an equals sign
4999 in the thread tree.
5000 </p></div><div class="sect2" title="3.57. edit_headers"><div class="titlepage"><div><div><h3 class="title"><a id="edit-headers"></a>3.57. edit_headers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5001 Default: no</p></div><p>
5002 This option allows you to edit the header of your outgoing messages
5003 along with the body of your message.
5004 </p><p>
5005 <span class="bold"><strong>Note</strong></span> that changes made to the References: and Date: headers are
5006 ignored for interoperability reasons.
5007 </p></div><div class="sect2" title="3.58. editor"><div class="titlepage"><div><div><h3 class="title"><a id="editor"></a>3.58. editor</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5008 Default: (empty)</p></div><p>
5009 This variable specifies which editor is used by mutt.
5010 It defaults to the value of the <code class="literal">$VISUAL</code>, or <code class="literal">$EDITOR</code>, environment
5011 variable, or to the string <span class="quote">“<span class="quote">vi</span>”</span> if neither of those are set.
5012 </p></div><div class="sect2" title="3.59. encode_from"><div class="titlepage"><div><div><h3 class="title"><a id="encode-from"></a>3.59. encode_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5013 Default: no</p></div><p>
5014 When <span class="emphasis"><em>set</em></span>, mutt will quoted-printable encode messages when
5015 they contain the string <span class="quote">“<span class="quote">From </span>”</span> (note the trailing space) in the beginning of a line.
5016 This is useful to avoid the tampering certain mail delivery and transport
5017 agents tend to do with messages (in order to prevent tools from
5018 misinterpreting the line as a mbox message separator).
5019 </p></div><div class="sect2" title="3.60. entropy_file"><div class="titlepage"><div><div><h3 class="title"><a id="entropy-file"></a>3.60. entropy_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5020 Default: (empty)</p></div><p>
5021 The file which includes random data that is used to initialize SSL
5022 library functions.
5023 </p></div><div class="sect2" title="3.61. envelope_from_address"><div class="titlepage"><div><div><h3 class="title"><a id="envelope-from-address"></a>3.61. envelope_from_address</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
5024 Default: (empty)</p></div><p>
5025 Manually sets the <span class="emphasis"><em>envelope</em></span> sender for outgoing messages.
5026 This value is ignored if <a class="link" href="#use-envelope-from" title="3.299. use_envelope_from">$use_envelope_from</a> is <span class="emphasis"><em>unset</em></span>.
5027 </p></div><div class="sect2" title="3.62. escape"><div class="titlepage"><div><div><h3 class="title"><a id="escape"></a>3.62. escape</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5028 Default: <span class="quote">“<span class="quote"><code class="literal">~</code></span>”</span></p></div><p>
5029 Escape character to use for functions in the built-in editor.
5030 </p></div><div class="sect2" title="3.63. fast_reply"><div class="titlepage"><div><div><h3 class="title"><a id="fast-reply"></a>3.63. fast_reply</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5031 Default: no</p></div><p>
5032 When <span class="emphasis"><em>set</em></span>, the initial prompt for recipients and subject are skipped
5033 when replying to messages, and the initial prompt for subject is
5034 skipped when forwarding messages.
5035 </p><p>
5036 <span class="bold"><strong>Note:</strong></span> this variable has no effect when the <a class="link" href="#autoedit" title="3.18. autoedit">$autoedit</a>
5037 variable is <span class="emphasis"><em>set</em></span>.
5038 </p></div><div class="sect2" title="3.64. fcc_attach"><div class="titlepage"><div><div><h3 class="title"><a id="fcc-attach"></a>3.64. fcc_attach</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5039 Default: yes</p></div><p>
5040 This variable controls whether or not attachments on outgoing messages
5041 are saved along with the main body of your message.
5042 </p></div><div class="sect2" title="3.65. fcc_clear"><div class="titlepage"><div><div><h3 class="title"><a id="fcc-clear"></a>3.65. fcc_clear</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5043 Default: no</p></div><p>
5044 When this variable is <span class="emphasis"><em>set</em></span>, FCCs will be stored unencrypted and
5045 unsigned, even when the actual message is encrypted and/or
5046 signed.
5047 (PGP only)
5048 </p></div><div class="sect2" title="3.66. folder"><div class="titlepage"><div><div><h3 class="title"><a id="folder"></a>3.66. folder</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5049 Default: <span class="quote">“<span class="quote"><code class="literal">~/Mail</code></span>”</span></p></div><p>
5050 Specifies the default location of your mailboxes.  A <span class="quote">“<span class="quote">+</span>”</span> or <span class="quote">“<span class="quote">=</span>”</span> at the
5051 beginning of a pathname will be expanded to the value of this
5052 variable.  Note that if you change this variable (from the default)
5053 value you need to make sure that the assignment occurs <span class="emphasis"><em>before</em></span>
5054 you use <span class="quote">“<span class="quote">+</span>”</span> or <span class="quote">“<span class="quote">=</span>”</span> for any other variables since expansion takes place
5055 when handling the <span class="quote">“<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></span>”</span> command.
5056 </p></div><div class="sect2" title="3.67. folder_format"><div class="titlepage"><div><div><h3 class="title"><a id="folder-format"></a>3.67. folder_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5057 Default: <span class="quote">“<span class="quote"><code class="literal">%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f</code></span>”</span></p></div><p>
5058 This variable allows you to customize the file browser display to your
5059 personal taste.  This string is similar to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, but has
5060 its own set of <code class="literal">printf(3)</code>-like sequences:
5061
5062 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%C  </td><td>current file number
5063 </td></tr><tr><td>%d  </td><td>date/time folder was last modified
5064 </td></tr><tr><td>%D  </td><td>date/time folder was last modified using <a class="link" href="#date-format" title="3.47. date_format">$date_format</a>.
5065 </td></tr><tr><td>%f  </td><td>filename (<span class="quote">“<span class="quote">/</span>”</span> is appended to directory names,
5066 <span class="quote">“<span class="quote">@</span>”</span> to symbolic links and <span class="quote">“<span class="quote">*</span>”</span> to executable
5067 files)
5068 </td></tr><tr><td>%F  </td><td>file permissions
5069 </td></tr><tr><td>%g  </td><td>group name (or numeric gid, if missing)
5070 </td></tr><tr><td>%l  </td><td>number of hard links
5071 </td></tr><tr><td>%N  </td><td>N if folder has new mail, blank otherwise
5072 </td></tr><tr><td>%s  </td><td>size in bytes
5073 </td></tr><tr><td>%t  </td><td><span class="quote">“<span class="quote">*</span>”</span> if the file is tagged, blank otherwise
5074 </td></tr><tr><td>%u  </td><td>owner name (or numeric uid, if missing)
5075 </td></tr><tr><td>%&gt;X </td><td>right justify the rest of the string and pad with character <span class="quote">“<span class="quote">X</span>”</span>
5076 </td></tr><tr><td>%|X </td><td>pad to the end of the line with character <span class="quote">“<span class="quote">X</span>”</span>
5077 </td></tr><tr><td>%*X </td><td>soft-fill with character <span class="quote">“<span class="quote">X</span>”</span> as pad
5078 </td></tr></tbody></table></div><p>
5079 For an explanation of <span class="quote">“<span class="quote">soft-fill</span>”</span>, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
5080 </p></div><div class="sect2" title="3.68. followup_to"><div class="titlepage"><div><div><h3 class="title"><a id="followup-to"></a>3.68. followup_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5081 Default: yes</p></div><p>
5082 Controls whether or not the <span class="quote">“<span class="quote">Mail-Followup-To:</span>”</span> header field is
5083 generated when sending mail.  When <span class="emphasis"><em>set</em></span>, Mutt will generate this
5084 field when you are replying to a known mailing list, specified with
5085 the <span class="quote">“<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>”</span> or <span class="quote">“<span class="quote"><a class="link" href="#lists" title="12. Mailing Lists">lists</a></span>”</span> commands.
5086 </p><p>
5087 This field has two purposes.  First, preventing you from
5088 receiving duplicate copies of replies to messages which you send
5089 to mailing lists, and second, ensuring that you do get a reply
5090 separately for any messages sent to known lists to which you are
5091 not subscribed.
5092 </p><p>
5093 The header will contain only the list's address
5094 for subscribed lists, and both the list address and your own
5095 email address for unsubscribed lists.  Without this header, a
5096 group reply to your message sent to a subscribed list will be
5097 sent to both the list and your address, resulting in two copies
5098 of the same email for you.
5099 </p></div><div class="sect2" title="3.69. force_name"><div class="titlepage"><div><div><h3 class="title"><a id="force-name"></a>3.69. force_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5100 Default: no</p></div><p>
5101 This variable is similar to <a class="link" href="#save-name" title="3.224. save_name">$save_name</a>, except that Mutt will
5102 store a copy of your outgoing message by the username of the address
5103 you are sending to even if that mailbox does not exist.
5104 </p><p>
5105 Also see the <a class="link" href="#record" title="3.212. record">$record</a> variable.
5106 </p></div><div class="sect2" title="3.70. forward_decode"><div class="titlepage"><div><div><h3 class="title"><a id="forward-decode"></a>3.70. forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5107 Default: yes</p></div><p>
5108 Controls the decoding of complex MIME messages into <code class="literal">text/plain</code> when
5109 forwarding a message.  The message header is also RFC2047 decoded.
5110 This variable is only used, if <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> is <span class="emphasis"><em>unset</em></span>,
5111 otherwise <a class="link" href="#mime-forward-decode" title="3.142. mime_forward_decode">$mime_forward_decode</a> is used instead.
5112 </p></div><div class="sect2" title="3.71. forward_decrypt"><div class="titlepage"><div><div><h3 class="title"><a id="forward-decrypt"></a>3.71. forward_decrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5113 Default: yes</p></div><p>
5114 Controls the handling of encrypted messages when forwarding a message.
5115 When <span class="emphasis"><em>set</em></span>, the outer layer of encryption is stripped off.  This
5116 variable is only used if <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> is <span class="emphasis"><em>set</em></span> and
5117 <a class="link" href="#mime-forward-decode" title="3.142. mime_forward_decode">$mime_forward_decode</a> is <span class="emphasis"><em>unset</em></span>.
5118 (PGP only)
5119 </p></div><div class="sect2" title="3.72. forward_edit"><div class="titlepage"><div><div><h3 class="title"><a id="forward-edit"></a>3.72. forward_edit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5120 Default: yes</p></div><p>
5121 This quadoption controls whether or not the user is automatically
5122 placed in the editor when forwarding messages.  For those who always want
5123 to forward with no modification, use a setting of <span class="quote">“<span class="quote">no</span>”</span>.
5124 </p></div><div class="sect2" title="3.73. forward_format"><div class="titlepage"><div><div><h3 class="title"><a id="forward-format"></a>3.73. forward_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5125 Default: <span class="quote">“<span class="quote"><code class="literal">[%a: %s]</code></span>”</span></p></div><p>
5126 This variable controls the default subject when forwarding a message.
5127 It uses the same format sequences as the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> variable.
5128 </p></div><div class="sect2" title="3.74. forward_quote"><div class="titlepage"><div><div><h3 class="title"><a id="forward-quote"></a>3.74. forward_quote</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5129 Default: no</p></div><p>
5130 When <span class="emphasis"><em>set</em></span>, forwarded messages included in the main body of the
5131 message (when <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> is <span class="emphasis"><em>unset</em></span>) will be quoted using
5132 <a class="link" href="#indent-string" title="3.113. indent_string">$indent_string</a>.
5133 </p></div><div class="sect2" title="3.75. from"><div class="titlepage"><div><div><h3 class="title"><a id="from"></a>3.75. from</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
5134 Default: (empty)</p></div><p>
5135 When <span class="emphasis"><em>set</em></span>, this variable contains a default from address.  It
5136 can be overridden using <span class="quote">“<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”</span> (including from a <span class="quote">“<span class="quote"><a class="link" href="#send-hook" title="19. Change Settings Based Upon Message Recipients">send-hook</a></span>”</span>) and
5137 <a class="link" href="#reverse-name" title="3.218. reverse_name">$reverse_name</a>.  This variable is ignored if <a class="link" href="#use-from" title="3.300. use_from">$use_from</a> is <span class="emphasis"><em>unset</em></span>.
5138 </p><p>
5139 This setting defaults to the contents of the environment variable <code class="literal">$EMAIL</code>.
5140 </p></div><div class="sect2" title="3.76. gecos_mask"><div class="titlepage"><div><div><h3 class="title"><a id="gecos-mask"></a>3.76. gecos_mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5141 Default: <span class="quote">“<span class="quote"><code class="literal">^[^,]*</code></span>”</span></p></div><p>
5142 A regular expression used by mutt to parse the GECOS field of a password
5143 entry when expanding the alias.  The default value
5144 will return the string up to the first <span class="quote">“<span class="quote">,</span>”</span> encountered.
5145 If the GECOS field contains a string like <span class="quote">“<span class="quote">lastname, firstname</span>”</span> then you
5146 should set it to <span class="quote">“<span class="quote"><code class="literal">.*</code></span>”</span>.
5147 </p><p>
5148 This can be useful if you see the following behavior: you address an e-mail
5149 to user ID <span class="quote">“<span class="quote">stevef</span>”</span> whose full name is <span class="quote">“<span class="quote">Steve Franklin</span>”</span>.  If mutt expands
5150 <span class="quote">“<span class="quote">stevef</span>”</span> to <span class="quote">“<span class="quote">"Franklin" stevef@foo.bar</span>”</span> then you should set the <a class="link" href="#gecos-mask" title="3.76. gecos_mask">$gecos_mask</a> to
5151 a regular expression that will match the whole name so mutt will expand
5152 <span class="quote">“<span class="quote">Franklin</span>”</span> to <span class="quote">“<span class="quote">Franklin, Steve</span>”</span>.
5153 </p></div><div class="sect2" title="3.77. hdrs"><div class="titlepage"><div><div><h3 class="title"><a id="hdrs"></a>3.77. hdrs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5154 Default: yes</p></div><p>
5155 When <span class="emphasis"><em>unset</em></span>, the header fields normally added by the <span class="quote">“<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”</span>
5156 command are not created.  This variable <span class="emphasis"><em>must</em></span> be unset before
5157 composing a new message or replying in order to take effect.  If <span class="emphasis"><em>set</em></span>,
5158 the user defined header fields are added to every new message.
5159 </p></div><div class="sect2" title="3.78. header"><div class="titlepage"><div><div><h3 class="title"><a id="header"></a>3.78. header</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5160 Default: no</p></div><p>
5161 When <span class="emphasis"><em>set</em></span>, this variable causes Mutt to include the header
5162 of the message you are replying to into the edit buffer.
5163 The <a class="link" href="#weed" title="3.306. weed">$weed</a> setting applies.
5164 </p></div><div class="sect2" title="3.79. header_cache"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache"></a>3.79. header_cache</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5165 Default: (empty)</p></div><p>
5166 This variable points to the header cache database.
5167 If pointing to a directory Mutt will contain a header cache
5168 database file per folder, if pointing to a file that file will
5169 be a single global header cache. By default it is <span class="emphasis"><em>unset</em></span> so no header
5170 caching will be used.
5171 </p><p>
5172 Header caching can greatly improve speed when opening POP, IMAP
5173 MH or Maildir folders, see <span class="quote">“<span class="quote"><a class="link" href="#caching" title="7. Local Caching">caching</a></span>”</span> for details.
5174 </p></div><div class="sect2" title="3.80. header_cache_compress"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-compress"></a>3.80. header_cache_compress</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5175 Default: yes</p></div><p>
5176 When mutt is compiled with qdbm or tokyocabinet as header cache backend,
5177 this option determines whether the database will be compressed.
5178 Compression results in database files roughly being one fifth
5179 of the usual diskspace, but the decompression can result in a
5180 slower opening of cached folder(s) which in general is still
5181 much faster than opening non header cached folders.
5182 </p></div><div class="sect2" title="3.81. header_cache_pagesize"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-pagesize"></a>3.81. header_cache_pagesize</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5183 Default: <span class="quote">“<span class="quote"><code class="literal">16384</code></span>”</span></p></div><p>
5184 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
5185 this option changes the database page size.  Too large or too small
5186 values can waste space, memory, or CPU time. The default should be more
5187 or less optimal for most use cases.
5188 </p></div><div class="sect2" title="3.82. help"><div class="titlepage"><div><div><h3 class="title"><a id="help"></a>3.82. help</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5189 Default: yes</p></div><p>
5190 When <span class="emphasis"><em>set</em></span>, help lines describing the bindings for the major functions
5191 provided by each menu are displayed on the first line of the screen.
5192 </p><p>
5193 <span class="bold"><strong>Note:</strong></span> The binding will not be displayed correctly if the
5194 function is bound to a sequence rather than a single keystroke.  Also,
5195 the help line may not be updated if a binding is changed while Mutt is
5196 running.  Since this variable is primarily aimed at new users, neither
5197 of these should present a major problem.
5198 </p></div><div class="sect2" title="3.83. hidden_host"><div class="titlepage"><div><div><h3 class="title"><a id="hidden-host"></a>3.83. hidden_host</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5199 Default: no</p></div><p>
5200 When <span class="emphasis"><em>set</em></span>, mutt will skip the host name part of <a class="link" href="#hostname" title="3.93. hostname">$hostname</a> variable
5201 when adding the domain part to addresses.  This variable does not
5202 affect the generation of Message-IDs, and it will not lead to the
5203 cut-off of first-level domains.
5204 </p></div><div class="sect2" title="3.84. hide_limited"><div class="titlepage"><div><div><h3 class="title"><a id="hide-limited"></a>3.84. hide_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5205 Default: no</p></div><p>
5206 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of messages that are hidden
5207 by limiting, in the thread tree.
5208 </p></div><div class="sect2" title="3.85. hide_missing"><div class="titlepage"><div><div><h3 class="title"><a id="hide-missing"></a>3.85. hide_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5209 Default: yes</p></div><p>
5210 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of missing messages in the
5211 thread tree.
5212 </p></div><div class="sect2" title="3.86. hide_thread_subject"><div class="titlepage"><div><div><h3 class="title"><a id="hide-thread-subject"></a>3.86. hide_thread_subject</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5213 Default: yes</p></div><p>
5214 When <span class="emphasis"><em>set</em></span>, mutt will not show the subject of messages in the thread
5215 tree that have the same subject as their parent or closest previously
5216 displayed sibling.
5217 </p></div><div class="sect2" title="3.87. hide_top_limited"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-limited"></a>3.87. hide_top_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5218 Default: no</p></div><p>
5219 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of messages that are hidden
5220 by limiting, at the top of threads in the thread tree.  Note that when
5221 <a class="link" href="#hide-limited" title="3.84. hide_limited">$hide_limited</a> is <span class="emphasis"><em>set</em></span>, this option will have no effect.
5222 </p></div><div class="sect2" title="3.88. hide_top_missing"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-missing"></a>3.88. hide_top_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5223 Default: yes</p></div><p>
5224 When <span class="emphasis"><em>set</em></span>, mutt will not show the presence of missing messages at the
5225 top of threads in the thread tree.  Note that when <a class="link" href="#hide-missing" title="3.85. hide_missing">$hide_missing</a> is
5226 <span class="emphasis"><em>set</em></span>, this option will have no effect.
5227 </p></div><div class="sect2" title="3.89. history"><div class="titlepage"><div><div><h3 class="title"><a id="history"></a>3.89. history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5228 Default: 10</p></div><p>
5229 This variable controls the size (in number of strings remembered) of
5230 the string history buffer per category. The buffer is cleared each time the
5231 variable is set.
5232 </p></div><div class="sect2" title="3.90. history_file"><div class="titlepage"><div><div><h3 class="title"><a id="history-file"></a>3.90. history_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5233 Default: <span class="quote">“<span class="quote"><code class="literal">~/.mutthistory</code></span>”</span></p></div><p>
5234 The file in which Mutt will save its history.
5235 </p></div><div class="sect2" title="3.91. honor_disposition"><div class="titlepage"><div><div><h3 class="title"><a id="honor-disposition"></a>3.91. honor_disposition</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5236 Default: no</p></div><p>
5237 When <span class="emphasis"><em>set</em></span>, Mutt will not display attachments with a
5238 disposition of <span class="quote">“<span class="quote">attachment</span>”</span> inline even if it could
5239 render the part to plain text. These MIME parts can only
5240 be viewed from the attachment menu.
5241 </p><p>
5242 If <span class="emphasis"><em>unset</em></span>, Mutt will render all MIME parts it can
5243 properly transform to plain text.
5244 </p></div><div class="sect2" title="3.92. honor_followup_to"><div class="titlepage"><div><div><h3 class="title"><a id="honor-followup-to"></a>3.92. honor_followup_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5245 Default: yes</p></div><p>
5246 This variable controls whether or not a Mail-Followup-To header is
5247 honored when group-replying to a message.
5248 </p></div><div class="sect2" title="3.93. hostname"><div class="titlepage"><div><div><h3 class="title"><a id="hostname"></a>3.93. hostname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5249 Default: (empty)</p></div><p>
5250 Specifies the fully-qualified hostname of the system mutt is running on
5251 containing the host's name and the DNS domain it belongs to. It is used
5252 as the domain part (after <span class="quote">“<span class="quote">@</span>”</span>) for local email addresses as well as
5253 Message-Id headers.
5254 </p><p>
5255 Its value is determined at startup as follows: If the node's name
5256 as returned by the <code class="literal">uname(3)</code> function contains the hostname and the
5257 domain, these are used to construct <a class="link" href="#hostname" title="3.93. hostname">$hostname</a>. If there is no
5258 domain part returned, Mutt will look for a <span class="quote">“<span class="quote">domain</span>”</span> or <span class="quote">“<span class="quote">search</span>”</span>
5259 line in <code class="literal">/etc/resolv.conf</code> to determine the domain. Optionally, Mutt
5260 can be compiled with a fixed domain name in which case a detected
5261 one is not used.
5262 </p><p>
5263 Also see <a class="link" href="#use-domain" title="3.298. use_domain">$use_domain</a> and <a class="link" href="#hidden-host" title="3.83. hidden_host">$hidden_host</a>.
5264 </p></div><div class="sect2" title="3.94. ignore_linear_white_space"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-linear-white-space"></a>3.94. ignore_linear_white_space</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5265 Default: no</p></div><p>
5266 This option replaces linear-white-space between encoded-word
5267 and text to a single space to prevent the display of MIME-encoded
5268 <span class="quote">“<span class="quote">Subject:</span>”</span> field from being divided into multiple lines.
5269 </p></div><div class="sect2" title="3.95. ignore_list_reply_to"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-list-reply-to"></a>3.95. ignore_list_reply_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5270 Default: no</p></div><p>
5271 Affects the behavior of the <code class="literal">&lt;reply&gt;</code> function when replying to
5272 messages from mailing lists (as defined by the <span class="quote">“<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>”</span> or
5273 <span class="quote">“<span class="quote"><a class="link" href="#lists" title="12. Mailing Lists">lists</a></span>”</span> commands).  When <span class="emphasis"><em>set</em></span>, if the <span class="quote">“<span class="quote">Reply-To:</span>”</span> field is
5274 set to the same value as the <span class="quote">“<span class="quote">To:</span>”</span> field, Mutt assumes that the
5275 <span class="quote">“<span class="quote">Reply-To:</span>”</span> field was set by the mailing list to automate responses
5276 to the list, and will ignore this field.  To direct a response to the
5277 mailing list when this option is <span class="emphasis"><em>set</em></span>, use the <code class="literal"><a class="link" href="#list-reply">&lt;list-reply&gt;</a></code>
5278 function; <code class="literal">&lt;group-reply&gt;</code> will reply to both the sender and the
5279 list.
5280 </p></div><div class="sect2" title="3.96. imap_authenticators"><div class="titlepage"><div><div><h3 class="title"><a id="imap-authenticators"></a>3.96. imap_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5281 Default: (empty)</p></div><p>
5282 This is a colon-delimited list of authentication methods mutt may
5283 attempt to use to log in to an IMAP server, in the order mutt should
5284 try them.  Authentication methods are either <span class="quote">“<span class="quote">login</span>”</span> or the right
5285 side of an IMAP <span class="quote">“<span class="quote">AUTH=xxx</span>”</span> capability string, e.g. <span class="quote">“<span class="quote">digest-md5</span>”</span>, <span class="quote">“<span class="quote">gssapi</span>”</span>
5286 or <span class="quote">“<span class="quote">cram-md5</span>”</span>. This option is case-insensitive. If it's
5287 <span class="emphasis"><em>unset</em></span> (the default) mutt will try all available methods,
5288 in order from most-secure to least-secure.
5289 </p><p>
5290 Example:
5291
5292 </p><pre class="screen">
5293 set imap_authenticators="gssapi:cram-md5:login"
5294 </pre><p>
5295 <span class="bold"><strong>Note:</strong></span> Mutt will only fall back to other authentication methods if
5296 the previous methods are unavailable. If a method is available but
5297 authentication fails, mutt will not connect to the IMAP server.
5298 </p></div><div class="sect2" title="3.97. imap_check_subscribed"><div class="titlepage"><div><div><h3 class="title"><a id="imap-check-subscribed"></a>3.97. imap_check_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5299 Default: no</p></div><p>
5300 When <span class="emphasis"><em>set</em></span>, mutt will fetch the set of subscribed folders from
5301 your server on connection, and add them to the set of mailboxes
5302 it polls for new mail just as if you had issued individual <span class="quote">“<span class="quote"><a class="link" href="#mailboxes" title="14. Monitoring Incoming Mail">mailboxes</a></span>”</span>
5303 commands.
5304 </p></div><div class="sect2" title="3.98. imap_delim_chars"><div class="titlepage"><div><div><h3 class="title"><a id="imap-delim-chars"></a>3.98. imap_delim_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5305 Default: <span class="quote">“<span class="quote"><code class="literal">/.</code></span>”</span></p></div><p>
5306 This contains the list of characters which you would like to treat
5307 as folder separators for displaying IMAP paths. In particular it
5308 helps in using the <span class="quote">“<span class="quote">=</span>”</span> shortcut for your <span class="emphasis"><em>folder</em></span> variable.
5309 </p></div><div class="sect2" title="3.99. imap_headers"><div class="titlepage"><div><div><h3 class="title"><a id="imap-headers"></a>3.99. imap_headers</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5310 Default: (empty)</p></div><p>
5311 Mutt requests these header fields in addition to the default headers
5312 (<span class="quote">“<span class="quote">Date:</span>”</span>, <span class="quote">“<span class="quote">From:</span>”</span>, <span class="quote">“<span class="quote">Subject:</span>”</span>, <span class="quote">“<span class="quote">To:</span>”</span>, <span class="quote">“<span class="quote">Cc:</span>”</span>, <span class="quote">“<span class="quote">Message-Id:</span>”</span>,
5313 <span class="quote">“<span class="quote">References:</span>”</span>, <span class="quote">“<span class="quote">Content-Type:</span>”</span>, <span class="quote">“<span class="quote">Content-Description:</span>”</span>, <span class="quote">“<span class="quote">In-Reply-To:</span>”</span>,
5314 <span class="quote">“<span class="quote">Reply-To:</span>”</span>, <span class="quote">“<span class="quote">Lines:</span>”</span>, <span class="quote">“<span class="quote">List-Post:</span>”</span>, <span class="quote">“<span class="quote">X-Label:</span>”</span>) from IMAP
5315 servers before displaying the index menu. You may want to add more
5316 headers for spam detection.
5317 </p><p>
5318 <span class="bold"><strong>Note:</strong></span> This is a space separated list, items should be uppercase
5319 and not contain the colon, e.g. <span class="quote">“<span class="quote">X-BOGOSITY X-SPAM-STATUS</span>”</span> for the
5320 <span class="quote">“<span class="quote">X-Bogosity:</span>”</span> and <span class="quote">“<span class="quote">X-Spam-Status:</span>”</span> header fields.
5321 </p></div><div class="sect2" title="3.100. imap_idle"><div class="titlepage"><div><div><h3 class="title"><a id="imap-idle"></a>3.100. imap_idle</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5322 Default: no</p></div><p>
5323 When <span class="emphasis"><em>set</em></span>, mutt will attempt to use the IMAP IDLE extension
5324 to check for new mail in the current mailbox. Some servers
5325 (dovecot was the inspiration for this option) react badly
5326 to mutt's implementation. If your connection seems to freeze
5327 up periodically, try unsetting this.
5328 </p></div><div class="sect2" title="3.101. imap_keepalive"><div class="titlepage"><div><div><h3 class="title"><a id="imap-keepalive"></a>3.101. imap_keepalive</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5329 Default: 900</p></div><p>
5330 This variable specifies the maximum amount of time in seconds that mutt
5331 will wait before polling open IMAP connections, to prevent the server
5332 from closing them before mutt has finished with them. The default is
5333 well within the RFC-specified minimum amount of time (30 minutes) before
5334 a server is allowed to do this, but in practice the RFC does get
5335 violated every now and then. Reduce this number if you find yourself
5336 getting disconnected from your IMAP server due to inactivity.
5337 </p></div><div class="sect2" title="3.102. imap_list_subscribed"><div class="titlepage"><div><div><h3 class="title"><a id="imap-list-subscribed"></a>3.102. imap_list_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5338 Default: no</p></div><p>
5339 This variable configures whether IMAP folder browsing will look for
5340 only subscribed folders or all folders.  This can be toggled in the
5341 IMAP browser with the <code class="literal">&lt;toggle-subscribed&gt;</code> function.
5342 </p></div><div class="sect2" title="3.103. imap_login"><div class="titlepage"><div><div><h3 class="title"><a id="imap-login"></a>3.103. imap_login</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5343 Default: (empty)</p></div><p>
5344 Your login name on the IMAP server.
5345 </p><p>
5346 This variable defaults to the value of <a class="link" href="#imap-user" title="3.109. imap_user">$imap_user</a>.
5347 </p></div><div class="sect2" title="3.104. imap_pass"><div class="titlepage"><div><div><h3 class="title"><a id="imap-pass"></a>3.104. imap_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5348 Default: (empty)</p></div><p>
5349 Specifies the password for your IMAP account.  If <span class="emphasis"><em>unset</em></span>, Mutt will
5350 prompt you for your password when you invoke the <code class="literal">&lt;imap-fetch-mail&gt;</code> function
5351 or try to open an IMAP folder.
5352 </p><p>
5353 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
5354 fairly secure machine, because the superuser can read your muttrc even
5355 if you are the only one who can read the file.
5356 </p></div><div class="sect2" title="3.105. imap_passive"><div class="titlepage"><div><div><h3 class="title"><a id="imap-passive"></a>3.105. imap_passive</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5357 Default: yes</p></div><p>
5358 When <span class="emphasis"><em>set</em></span>, mutt will not open new IMAP connections to check for new
5359 mail.  Mutt will only check for new mail over existing IMAP
5360 connections.  This is useful if you don't want to be prompted to
5361 user/password pairs on mutt invocation, or if opening the connection
5362 is slow.
5363 </p></div><div class="sect2" title="3.106. imap_peek"><div class="titlepage"><div><div><h3 class="title"><a id="imap-peek"></a>3.106. imap_peek</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5364 Default: yes</p></div><p>
5365 When <span class="emphasis"><em>set</em></span>, mutt will avoid implicitly marking your mail as read whenever
5366 you fetch a message from the server. This is generally a good thing,
5367 but can make closing an IMAP folder somewhat slower. This option
5368 exists to appease speed freaks.
5369 </p></div><div class="sect2" title="3.107. imap_pipeline_depth"><div class="titlepage"><div><div><h3 class="title"><a id="imap-pipeline-depth"></a>3.107. imap_pipeline_depth</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5370 Default: 15</p></div><p>
5371 Controls the number of IMAP commands that may be queued up before they
5372 are sent to the server. A deeper pipeline reduces the amount of time
5373 mutt must wait for the server, and can make IMAP servers feel much
5374 more responsive. But not all servers correctly handle pipelined commands,
5375 so if you have problems you might want to try setting this variable to 0.
5376 </p><p>
5377 <span class="bold"><strong>Note:</strong></span> Changes to this variable have no effect on open connections.
5378 </p></div><div class="sect2" title="3.108. imap_servernoise"><div class="titlepage"><div><div><h3 class="title"><a id="imap-servernoise"></a>3.108. imap_servernoise</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5379 Default: yes</p></div><p>
5380 When <span class="emphasis"><em>set</em></span>, mutt will display warning messages from the IMAP
5381 server as error messages. Since these messages are often
5382 harmless, or generated due to configuration problems on the
5383 server which are out of the users' hands, you may wish to suppress
5384 them at some point.
5385 </p></div><div class="sect2" title="3.109. imap_user"><div class="titlepage"><div><div><h3 class="title"><a id="imap-user"></a>3.109. imap_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5386 Default: (empty)</p></div><p>
5387 The name of the user whose mail you intend to access on the IMAP
5388 server.
5389 </p><p>
5390 This variable defaults to your user name on the local machine.
5391 </p></div><div class="sect2" title="3.110. implicit_autoview"><div class="titlepage"><div><div><h3 class="title"><a id="implicit-autoview"></a>3.110. implicit_autoview</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5392 Default: no</p></div><p>
5393 If set to <span class="quote">“<span class="quote">yes</span>”</span>, mutt will look for a mailcap entry with the
5394 <span class="quote">“<span class="quote"><code class="literal">copiousoutput</code></span>”</span> flag set for <span class="emphasis"><em>every</em></span> MIME attachment it doesn't have
5395 an internal viewer defined for.  If such an entry is found, mutt will
5396 use the viewer defined in that entry to convert the body part to text
5397 form.
5398 </p></div><div class="sect2" title="3.111. include"><div class="titlepage"><div><div><h3 class="title"><a id="include"></a>3.111. include</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5399 Default: ask-yes</p></div><p>
5400 Controls whether or not a copy of the message(s) you are replying to
5401 is included in your reply.
5402 </p></div><div class="sect2" title="3.112. include_onlyfirst"><div class="titlepage"><div><div><h3 class="title"><a id="include-onlyfirst"></a>3.112. include_onlyfirst</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5403 Default: no</p></div><p>
5404 Controls whether or not Mutt includes only the first attachment
5405 of the message you are replying.
5406 </p></div><div class="sect2" title="3.113. indent_string"><div class="titlepage"><div><div><h3 class="title"><a id="indent-string"></a>3.113. indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5407 Default: <span class="quote">“<span class="quote"><code class="literal">&gt; </code></span>”</span></p></div><p>
5408 Specifies the string to prepend to each line of text quoted in a
5409 message to which you are replying.  You are strongly encouraged not to
5410 change this value, as it tends to agitate the more fanatical netizens.
5411 </p><p>
5412 The value of this option is ignored if <a class="link" href="#text-flowed" title="3.287. text_flowed">$text_flowed</a> is set, too because
5413 the quoting mechanism is strictly defined for format=flowed.
5414 </p><p>
5415 This option is a format string, please see the description of
5416 <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> for supported <code class="literal">printf(3)</code>-style sequences.
5417 </p></div><div class="sect2" title="3.114. index_format"><div class="titlepage"><div><div><h3 class="title"><a id="index-format"></a>3.114. index_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5418 Default: <span class="quote">“<span class="quote"><code class="literal">%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?) %s</code></span>”</span></p></div><p>
5419 This variable allows you to customize the message index display to
5420 your personal taste.
5421 </p><p>
5422 <span class="quote">“<span class="quote">Format strings</span>”</span> are similar to the strings used in the C
5423 function <code class="literal">printf(3)</code> to format output (see the man page for more details).
5424 The following sequences are defined in Mutt:
5425
5426 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a </td><td>address of the author
5427 </td></tr><tr><td>%A </td><td>reply-to address (if present; otherwise: address of author)
5428 </td></tr><tr><td>%b </td><td>filename of the original message folder (think mailbox)
5429 </td></tr><tr><td>%B </td><td>the list to which the letter was sent, or else the folder name (%b).
5430 </td></tr><tr><td>%c </td><td>number of characters (bytes) in the message
5431 </td></tr><tr><td>%C </td><td>current message number
5432 </td></tr><tr><td>%d </td><td>date and time of the message in the format specified by
5433 <a class="link" href="#date-format" title="3.47. date_format">$date_format</a> converted to sender's time zone
5434 </td></tr><tr><td>%D </td><td>date and time of the message in the format specified by
5435 <a class="link" href="#date-format" title="3.47. date_format">$date_format</a> converted to the local time zone
5436 </td></tr><tr><td>%e </td><td>current message number in thread
5437 </td></tr><tr><td>%E </td><td>number of messages in current thread
5438 </td></tr><tr><td>%f </td><td>sender (address + real name), either From: or Return-Path:
5439 </td></tr><tr><td>%F </td><td>author name, or recipient name if the message is from you
5440 </td></tr><tr><td>%H </td><td>spam attribute(s) of this message
5441 </td></tr><tr><td>%i </td><td>message-id of the current message
5442 </td></tr><tr><td>%l </td><td>number of lines in the message (does not work with maildir,
5443 mh, and possibly IMAP folders)
5444 </td></tr><tr><td>%L </td><td>If an address in the <span class="quote">“<span class="quote">To:</span>”</span> or <span class="quote">“<span class="quote">Cc:</span>”</span> header field matches an address
5445 defined by the users <span class="quote">“<span class="quote"><a class="link" href="#subscribe">subscribe</a></span>”</span> command, this displays
5446 "To &lt;list-name&gt;", otherwise the same as %F.
5447 </td></tr><tr><td>%m </td><td>total number of message in the mailbox
5448 </td></tr><tr><td>%M </td><td>number of hidden messages if the thread is collapsed.
5449 </td></tr><tr><td>%N </td><td>message score
5450 </td></tr><tr><td>%n </td><td>author's real name (or address if missing)
5451 </td></tr><tr><td>%O </td><td>original save folder where mutt would formerly have
5452 stashed the message: list name or recipient name
5453 if not sent to a list
5454 </td></tr><tr><td>%P </td><td>progress indicator for the built-in pager (how much of the file has been displayed)
5455 </td></tr><tr><td>%s </td><td>subject of the message
5456 </td></tr><tr><td>%S </td><td>status of the message (<span class="quote">“<span class="quote">N</span>”</span>/<span class="quote">“<span class="quote">D</span>”</span>/<span class="quote">“<span class="quote">d</span>”</span>/<span class="quote">“<span class="quote">!</span>”</span>/<span class="quote">“<span class="quote">r</span>”</span>/*)
5457 </td></tr><tr><td>%t </td><td><span class="quote">“<span class="quote">To:</span>”</span> field (recipients)
5458 </td></tr><tr><td>%T </td><td>the appropriate character from the <a class="link" href="#to-chars" title="3.294. to_chars">$to_chars</a> string
5459 </td></tr><tr><td>%u </td><td>user (login) name of the author
5460 </td></tr><tr><td>%v </td><td>first name of the author, or the recipient if the message is from you
5461 </td></tr><tr><td>%X </td><td>number of attachments
5462 (please see the <span class="quote">“<span class="quote"><a class="link" href="#attachments" title="6. Attachment Searching and Counting">attachments</a></span>”</span> section for possible speed effects)
5463 </td></tr><tr><td>%y </td><td><span class="quote">“<span class="quote">X-Label:</span>”</span> field, if present
5464 </td></tr><tr><td>%Y </td><td><span class="quote">“<span class="quote">X-Label:</span>”</span> field, if present, and <span class="emphasis"><em>(1)</em></span> not at part of a thread tree,
5465 <span class="emphasis"><em>(2)</em></span> at the top of a thread, or <span class="emphasis"><em>(3)</em></span> <span class="quote">“<span class="quote">X-Label:</span>”</span> is different from
5466 preceding message's <span class="quote">“<span class="quote">X-Label:</span>”</span>.
5467 </td></tr><tr><td>%Z </td><td>message status flags
5468 </td></tr><tr><td>%{fmt} </td><td>the date and time of the message is converted to sender's
5469 time zone, and <span class="quote">“<span class="quote">fmt</span>”</span> is expanded by the library function
5470 <code class="literal">strftime(3)</code>; a leading bang disables locales
5471 </td></tr><tr><td>%[fmt] </td><td>the date and time of the message is converted to the local
5472 time zone, and <span class="quote">“<span class="quote">fmt</span>”</span> is expanded by the library function
5473 <code class="literal">strftime(3)</code>; a leading bang disables locales
5474 </td></tr><tr><td>%(fmt) </td><td>the local date and time when the message was received.
5475 <span class="quote">“<span class="quote">fmt</span>”</span> is expanded by the library function <code class="literal">strftime(3)</code>;
5476 a leading bang disables locales
5477 </td></tr><tr><td>%&lt;fmt&gt; </td><td>the current local time. <span class="quote">“<span class="quote">fmt</span>”</span> is expanded by the library
5478 function <code class="literal">strftime(3)</code>; a leading bang disables locales.
5479 </td></tr><tr><td>%&gt;X    </td><td>right justify the rest of the string and pad with character <span class="quote">“<span class="quote">X</span>”</span>
5480 </td></tr><tr><td>%|X    </td><td>pad to the end of the line with character <span class="quote">“<span class="quote">X</span>”</span>
5481 </td></tr><tr><td>%*X    </td><td>soft-fill with character <span class="quote">“<span class="quote">X</span>”</span> as pad
5482 </td></tr></tbody></table></div><p>
5483 <span class="quote">“<span class="quote">Soft-fill</span>”</span> deserves some explanation: Normal right-justification
5484 will print everything to the left of the <span class="quote">“<span class="quote">%&gt;</span>”</span>, displaying padding and
5485 whatever lies to the right only if there's room. By contrast,
5486 soft-fill gives priority to the right-hand side, guaranteeing space
5487 to display it and showing padding only if there's still room. If
5488 necessary, soft-fill will eat text leftwards to make room for
5489 rightward text.
5490 </p><p>
5491 Note that these expandos are supported in
5492 <span class="quote">“<span class="quote"><a class="link" href="#save-hook" title="16. Specify Default Save Mailbox">save-hook</a></span>”</span>, <span class="quote">“<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>”</span> and <span class="quote">“<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>”</span>, too.
5493 </p></div><div class="sect2" title="3.115. ispell"><div class="titlepage"><div><div><h3 class="title"><a id="ispell"></a>3.115. ispell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5494 Default: <span class="quote">“<span class="quote"><code class="literal">ispell</code></span>”</span></p></div><p>
5495 How to invoke ispell (GNU's spell-checking software).
5496 </p></div><div class="sect2" title="3.116. keep_flagged"><div class="titlepage"><div><div><h3 class="title"><a id="keep-flagged"></a>3.116. keep_flagged</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5497 Default: no</p></div><p>
5498 If <span class="emphasis"><em>set</em></span>, read messages marked as flagged will not be moved
5499 from your spool mailbox to your <a class="link" href="#mbox" title="3.127. mbox">$mbox</a> mailbox, or as a result of
5500 a <span class="quote">“<span class="quote"><a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes">mbox-hook</a></span>”</span> command.
5501 </p></div><div class="sect2" title="3.117. locale"><div class="titlepage"><div><div><h3 class="title"><a id="locale"></a>3.117. locale</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5502 Default: <span class="quote">“<span class="quote"><code class="literal">C</code></span>”</span></p></div><p>
5503 The locale used by <code class="literal">strftime(3)</code> to format dates. Legal values are
5504 the strings your system accepts for the locale environment variable <code class="literal">$LC_TIME</code>.
5505 </p></div><div class="sect2" title="3.118. mail_check"><div class="titlepage"><div><div><h3 class="title"><a id="mail-check"></a>3.118. mail_check</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5506 Default: 5</p></div><p>
5507 This variable configures how often (in seconds) mutt should look for
5508 new mail. Also see the <a class="link" href="#timeout" title="3.292. timeout">$timeout</a> variable.
5509 </p></div><div class="sect2" title="3.119. mail_check_recent"><div class="titlepage"><div><div><h3 class="title"><a id="mail-check-recent"></a>3.119. mail_check_recent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5510 Default: yes</p></div><p>
5511 When <span class="emphasis"><em>set</em></span>, Mutt will only notify you about new mail that has been received
5512 since the last time you opened the mailbox.  When <span class="emphasis"><em>unset</em></span>, Mutt will notify you
5513 if any new mail exists in the mailbox, regardless of whether you have visited it
5514 recently.
5515 </p><p>
5516 When <span class="emphasis"><em><a class="link" href="#mark-old" title="3.124. mark_old">$mark_old</a></em></span> is set, Mutt does not consider the mailbox to contain new
5517 mail if only old messages exist.
5518 </p></div><div class="sect2" title="3.120. mailcap_path"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-path"></a>3.120. mailcap_path</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5519 Default: (empty)</p></div><p>
5520 This variable specifies which files to consult when attempting to
5521 display MIME bodies not directly supported by Mutt.
5522 </p></div><div class="sect2" title="3.121. mailcap_sanitize"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-sanitize"></a>3.121. mailcap_sanitize</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5523 Default: yes</p></div><p>
5524 If <span class="emphasis"><em>set</em></span>, mutt will restrict possible characters in mailcap % expandos
5525 to a well-defined set of safe characters.  This is the safe setting,
5526 but we are not sure it doesn't break some more advanced MIME stuff.
5527 </p><p>
5528 <span class="bold"><strong>DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
5529 DOING!</strong></span>
5530 </p></div><div class="sect2" title="3.122. maildir_header_cache_verify"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-header-cache-verify"></a>3.122. maildir_header_cache_verify</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5531 Default: yes</p></div><p>
5532 Check for Maildir unaware programs other than mutt having modified maildir
5533 files when the header cache is in use.  This incurs one <code class="literal">stat(2)</code> per
5534 message every time the folder is opened (which can be very slow for NFS
5535 folders).
5536 </p></div><div class="sect2" title="3.123. maildir_trash"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-trash"></a>3.123. maildir_trash</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5537 Default: no</p></div><p>
5538 If <span class="emphasis"><em>set</em></span>, messages marked as deleted will be saved with the maildir
5539 trashed flag instead of unlinked.  <span class="bold"><strong>Note:</strong></span> this only applies
5540 to maildir-style mailboxes.  Setting it will have no effect on other
5541 mailbox types.
5542 </p></div><div class="sect2" title="3.124. mark_old"><div class="titlepage"><div><div><h3 class="title"><a id="mark-old"></a>3.124. mark_old</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5543 Default: yes</p></div><p>
5544 Controls whether or not mutt marks <span class="emphasis"><em>new</em></span> <span class="bold"><strong>unread</strong></span>
5545 messages as <span class="emphasis"><em>old</em></span> if you exit a mailbox without reading them.
5546 With this option <span class="emphasis"><em>set</em></span>, the next time you start mutt, the messages
5547 will show up with an <span class="quote">“<span class="quote">O</span>”</span> next to them in the index menu,
5548 indicating that they are old.
5549 </p></div><div class="sect2" title="3.125. markers"><div class="titlepage"><div><div><h3 class="title"><a id="markers"></a>3.125. markers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5550 Default: yes</p></div><p>
5551 Controls the display of wrapped lines in the internal pager. If set, a
5552 <span class="quote">“<span class="quote">+</span>”</span> marker is displayed at the beginning of wrapped lines.
5553 </p><p>
5554 Also see the <a class="link" href="#smart-wrap" title="3.239. smart_wrap">$smart_wrap</a> variable.
5555 </p></div><div class="sect2" title="3.126. mask"><div class="titlepage"><div><div><h3 class="title"><a id="mask"></a>3.126. mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5556 Default: <span class="quote">“<span class="quote"><code class="literal">!^\.[^.]</code></span>”</span></p></div><p>
5557 A regular expression used in the file browser, optionally preceded by
5558 the <span class="emphasis"><em>not</em></span> operator <span class="quote">“<span class="quote">!</span>”</span>.  Only files whose names match this mask
5559 will be shown. The match is always case-sensitive.
5560 </p></div><div class="sect2" title="3.127. mbox"><div class="titlepage"><div><div><h3 class="title"><a id="mbox"></a>3.127. mbox</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5561 Default: <span class="quote">“<span class="quote"><code class="literal">~/mbox</code></span>”</span></p></div><p>
5562 This specifies the folder into which read mail in your <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a>
5563 folder will be appended.
5564 </p><p>
5565 Also see the <a class="link" href="#move" title="3.146. move">$move</a> variable.
5566 </p></div><div class="sect2" title="3.128. mbox_type"><div class="titlepage"><div><div><h3 class="title"><a id="mbox-type"></a>3.128. mbox_type</h3></div></div></div><div class="literallayout"><p>Type: folder magic<br />
5567 Default: mbox</p></div><p>
5568 The default mailbox type used when creating new folders. May be any of
5569 <span class="quote">“<span class="quote">mbox</span>”</span>, <span class="quote">“<span class="quote">MMDF</span>”</span>, <span class="quote">“<span class="quote">MH</span>”</span> and <span class="quote">“<span class="quote">Maildir</span>”</span>. This is overridden by the
5570 <code class="literal">-m</code> command-line option.
5571 </p></div><div class="sect2" title="3.129. menu_context"><div class="titlepage"><div><div><h3 class="title"><a id="menu-context"></a>3.129. menu_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5572 Default: 0</p></div><p>
5573 This variable controls the number of lines of context that are given
5574 when scrolling through menus. (Similar to <a class="link" href="#pager-context" title="3.150. pager_context">$pager_context</a>.)
5575 </p></div><div class="sect2" title="3.130. menu_move_off"><div class="titlepage"><div><div><h3 class="title"><a id="menu-move-off"></a>3.130. menu_move_off</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5576 Default: yes</p></div><p>
5577 When <span class="emphasis"><em>unset</em></span>, the bottom entry of menus will never scroll up past
5578 the bottom of the screen, unless there are less entries than lines.
5579 When <span class="emphasis"><em>set</em></span>, the bottom entry may move off the bottom.
5580 </p></div><div class="sect2" title="3.131. menu_scroll"><div class="titlepage"><div><div><h3 class="title"><a id="menu-scroll"></a>3.131. menu_scroll</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5581 Default: no</p></div><p>
5582 When <span class="emphasis"><em>set</em></span>, menus will be scrolled up or down one line when you
5583 attempt to move across a screen boundary.  If <span class="emphasis"><em>unset</em></span>, the screen
5584 is cleared and the next or previous page of the menu is displayed
5585 (useful for slow links to avoid many redraws).
5586 </p></div><div class="sect2" title="3.132. message_cache_clean"><div class="titlepage"><div><div><h3 class="title"><a id="message-cache-clean"></a>3.132. message_cache_clean</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>, mutt will clean out obsolete entries from the message cache when
5589 the mailbox is synchronized. You probably only want to set it
5590 every once in a while, since it can be a little slow
5591 (especially for large folders).
5592 </p></div><div class="sect2" title="3.133. message_cachedir"><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 />
5593 Default: (empty)</p></div><p>
5594 Set this to a directory and mutt will cache copies of messages from
5595 your IMAP and POP servers here. You are free to remove entries at any
5596 time.
5597 </p><p>
5598 When setting this variable to a directory, mutt needs to fetch every
5599 remote message only once and can perform regular expression searches
5600 as fast as for local folders.
5601 </p><p>
5602 Also see the <a class="link" href="#message-cache-clean" title="3.132. message_cache_clean">$message_cache_clean</a> variable.
5603 </p></div><div class="sect2" title="3.134. message_format"><div class="titlepage"><div><div><h3 class="title"><a id="message-format"></a>3.134. message_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5604 Default: <span class="quote">“<span class="quote"><code class="literal">%s</code></span>”</span></p></div><p>
5605 This is the string displayed in the <span class="quote">“<span class="quote">attachment</span>”</span> menu for
5606 attachments of type <code class="literal">message/rfc822</code>.  For a full listing of defined
5607 <code class="literal">printf(3)</code>-like sequences see the section on <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>.
5608 </p></div><div class="sect2" title="3.135. meta_key"><div class="titlepage"><div><div><h3 class="title"><a id="meta-key"></a>3.135. meta_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5609 Default: no</p></div><p>
5610 If <span class="emphasis"><em>set</em></span>, forces Mutt to interpret keystrokes with the high bit (bit 8)
5611 set as if the user had pressed the Esc key and whatever key remains
5612 after having the high bit removed.  For example, if the key pressed
5613 has an ASCII value of <code class="literal">0xf8</code>, then this is treated as if the user had
5614 pressed Esc then <span class="quote">“<span class="quote">x</span>”</span>.  This is because the result of removing the
5615 high bit from <code class="literal">0xf8</code> is <code class="literal">0x78</code>, which is the ASCII character
5616 <span class="quote">“<span class="quote">x</span>”</span>.
5617 </p></div><div class="sect2" title="3.136. metoo"><div class="titlepage"><div><div><h3 class="title"><a id="metoo"></a>3.136. metoo</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5618 Default: no</p></div><p>
5619 If <span class="emphasis"><em>unset</em></span>, Mutt will remove your address (see the <span class="quote">“<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”</span>
5620 command) from the list of recipients when replying to a message.
5621 </p></div><div class="sect2" title="3.137. mh_purge"><div class="titlepage"><div><div><h3 class="title"><a id="mh-purge"></a>3.137. mh_purge</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5622 Default: no</p></div><p>
5623 When <span class="emphasis"><em>unset</em></span>, mutt will mimic mh's behavior and rename deleted messages
5624 to <span class="emphasis"><em>,&lt;old file name&gt;</em></span> in mh folders instead of really deleting
5625 them. This leaves the message on disk but makes programs reading the folder
5626 ignore it. If the variable is <span class="emphasis"><em>set</em></span>, the message files will simply be
5627 deleted.
5628 </p><p>
5629 This option is similar to <a class="link" href="#maildir-trash" title="3.123. maildir_trash">$maildir_trash</a> for Maildir folders.
5630 </p></div><div class="sect2" title="3.138. mh_seq_flagged"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-flagged"></a>3.138. mh_seq_flagged</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5631 Default: <span class="quote">“<span class="quote"><code class="literal">flagged</code></span>”</span></p></div><p>
5632 The name of the MH sequence used for flagged messages.
5633 </p></div><div class="sect2" title="3.139. mh_seq_replied"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-replied"></a>3.139. mh_seq_replied</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5634 Default: <span class="quote">“<span class="quote"><code class="literal">replied</code></span>”</span></p></div><p>
5635 The name of the MH sequence used to tag replied messages.
5636 </p></div><div class="sect2" title="3.140. mh_seq_unseen"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-unseen"></a>3.140. mh_seq_unseen</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5637 Default: <span class="quote">“<span class="quote"><code class="literal">unseen</code></span>”</span></p></div><p>
5638 The name of the MH sequence used for unseen messages.
5639 </p></div><div class="sect2" title="3.141. mime_forward"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward"></a>3.141. mime_forward</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5640 Default: no</p></div><p>
5641 When <span class="emphasis"><em>set</em></span>, the message you are forwarding will be attached as a
5642 separate <code class="literal">message/rfc822</code> MIME part instead of included in the main body of the
5643 message.  This is useful for forwarding MIME messages so the receiver
5644 can properly view the message as it was delivered to you. If you like
5645 to switch between MIME and not MIME from mail to mail, set this
5646 variable to <span class="quote">“<span class="quote">ask-no</span>”</span> or <span class="quote">“<span class="quote">ask-yes</span>”</span>.
5647 </p><p>
5648 Also see <a class="link" href="#forward-decode" title="3.70. forward_decode">$forward_decode</a> and <a class="link" href="#mime-forward-decode" title="3.142. mime_forward_decode">$mime_forward_decode</a>.
5649 </p></div><div class="sect2" title="3.142. mime_forward_decode"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-decode"></a>3.142. mime_forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5650 Default: no</p></div><p>
5651 Controls the decoding of complex MIME messages into <code class="literal">text/plain</code> when
5652 forwarding a message while <a class="link" href="#mime-forward" title="3.141. mime_forward">$mime_forward</a> is <span class="emphasis"><em>set</em></span>. Otherwise
5653 <a class="link" href="#forward-decode" title="3.70. forward_decode">$forward_decode</a> is used instead.
5654 </p></div><div class="sect2" title="3.143. mime_forward_rest"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-rest"></a>3.143. mime_forward_rest</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5655 Default: yes</p></div><p>
5656 When forwarding multiple attachments of a MIME message from the attachment
5657 menu, attachments which cannot be decoded in a reasonable manner will
5658 be attached to the newly composed message if this option is <span class="emphasis"><em>set</em></span>.
5659 </p></div><div class="sect2" title="3.144. mix_entry_format"><div class="titlepage"><div><div><h3 class="title"><a id="mix-entry-format"></a>3.144. mix_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5660 Default: <span class="quote">“<span class="quote"><code class="literal">%4n %c %-16s %a</code></span>”</span></p></div><p>
5661 This variable describes the format of a remailer line on the mixmaster
5662 chain selection screen.  The following <code class="literal">printf(3)</code>-like sequences are
5663 supported:
5664
5665 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%n </td><td>The running number on the menu.
5666 </td></tr><tr><td>%c </td><td>Remailer capabilities.
5667 </td></tr><tr><td>%s </td><td>The remailer's short name.
5668 </td></tr><tr><td>%a </td><td>The remailer's e-mail address.
5669 </td></tr></tbody></table></div></div><div class="sect2" title="3.145. mixmaster"><div class="titlepage"><div><div><h3 class="title"><a id="mixmaster"></a>3.145. mixmaster</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5670 Default: <span class="quote">“<span class="quote"><code class="literal">mixmaster</code></span>”</span></p></div><p>
5671 This variable contains the path to the Mixmaster binary on your
5672 system.  It is used with various sets of parameters to gather the
5673 list of known remailers, and to finally send a message through the
5674 mixmaster chain.
5675 </p></div><div class="sect2" title="3.146. move"><div class="titlepage"><div><div><h3 class="title"><a id="move"></a>3.146. move</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5676 Default: no</p></div><p>
5677 Controls whether or not Mutt will move read messages
5678 from your spool mailbox to your <a class="link" href="#mbox" title="3.127. mbox">$mbox</a> mailbox, or as a result of
5679 a <span class="quote">“<span class="quote"><a class="link" href="#mbox-hook" title="13. Using Multiple Spool Mailboxes">mbox-hook</a></span>”</span> command.
5680 </p></div><div class="sect2" title="3.147. narrow_tree"><div class="titlepage"><div><div><h3 class="title"><a id="narrow-tree"></a>3.147. narrow_tree</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5681 Default: no</p></div><p>
5682 This variable, when <span class="emphasis"><em>set</em></span>, makes the thread tree narrower, allowing
5683 deeper threads to fit on the screen.
5684 </p></div><div class="sect2" title="3.148. net_inc"><div class="titlepage"><div><div><h3 class="title"><a id="net-inc"></a>3.148. net_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5685 Default: 10</p></div><p>
5686 Operations that expect to transfer a large amount of data over the
5687 network will update their progress every <a class="link" href="#net-inc" title="3.148. net_inc">$net_inc</a> kilobytes.
5688 If set to 0, no progress messages will be displayed.
5689 </p><p>
5690 See also <a class="link" href="#read-inc" title="3.208. read_inc">$read_inc</a>, <a class="link" href="#write-inc" title="3.312. write_inc">$write_inc</a> and <a class="link" href="#net-inc" title="3.148. net_inc">$net_inc</a>.
5691 </p></div><div class="sect2" title="3.149. pager"><div class="titlepage"><div><div><h3 class="title"><a id="pager"></a>3.149. pager</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5692 Default: <span class="quote">“<span class="quote"><code class="literal">builtin</code></span>”</span></p></div><p>
5693 This variable specifies which pager you would like to use to view
5694 messages. The value <span class="quote">“<span class="quote">builtin</span>”</span> means to use the built-in pager, otherwise this
5695 variable should specify the pathname of the external pager you would
5696 like to use.
5697 </p><p>
5698 Using an external pager may have some disadvantages: Additional
5699 keystrokes are necessary because you can't call mutt functions
5700 directly from the pager, and screen resizes cause lines longer than
5701 the screen width to be badly formatted in the help menu.
5702 </p></div><div class="sect2" title="3.150. pager_context"><div class="titlepage"><div><div><h3 class="title"><a id="pager-context"></a>3.150. pager_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5703 Default: 0</p></div><p>
5704 This variable controls the number of lines of context that are given
5705 when displaying the next or previous page in the internal pager.  By
5706 default, Mutt will display the line after the last one on the screen
5707 at the top of the next page (0 lines of context).
5708 </p><p>
5709 This variable also specifies the amount of context given for search
5710 results. If positive, this many lines will be given before a match,
5711 if 0, the match will be top-aligned.
5712 </p></div><div class="sect2" title="3.151. pager_format"><div class="titlepage"><div><div><h3 class="title"><a id="pager-format"></a>3.151. pager_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5713 Default: <span class="quote">“<span class="quote"><code class="literal">-%Z- %C/%m: %-20.20n   %s%*  -- (%P)</code></span>”</span></p></div><p>
5714 This variable controls the format of the one-line message <span class="quote">“<span class="quote">status</span>”</span>
5715 displayed before each message in either the internal or an external
5716 pager.  The valid sequences are listed in the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>
5717 section.
5718 </p></div><div class="sect2" title="3.152. pager_index_lines"><div class="titlepage"><div><div><h3 class="title"><a id="pager-index-lines"></a>3.152. pager_index_lines</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5719 Default: 0</p></div><p>
5720 Determines the number of lines of a mini-index which is shown when in
5721 the pager.  The current message, unless near the top or bottom of the
5722 folder, will be roughly one third of the way down this mini-index,
5723 giving the reader the context of a few messages before and after the
5724 message.  This is useful, for example, to determine how many messages
5725 remain to be read in the current thread.  One of the lines is reserved
5726 for the status bar from the index, so a setting of 6
5727 will only show 5 lines of the actual index.  A value of 0 results in
5728 no index being shown.  If the number of messages in the current folder
5729 is less than <a class="link" href="#pager-index-lines" title="3.152. pager_index_lines">$pager_index_lines</a>, then the index will only use as
5730 many lines as it needs.
5731 </p></div><div class="sect2" title="3.153. pager_stop"><div class="titlepage"><div><div><h3 class="title"><a id="pager-stop"></a>3.153. pager_stop</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5732 Default: no</p></div><p>
5733 When <span class="emphasis"><em>set</em></span>, the internal-pager will <span class="bold"><strong>not</strong></span> move to the next message
5734 when you are at the end of a message and invoke the <code class="literal">&lt;next-page&gt;</code>
5735 function.
5736 </p></div><div class="sect2" title="3.154. pgp_auto_decode"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-auto-decode"></a>3.154. pgp_auto_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5737 Default: no</p></div><p>
5738 If <span class="emphasis"><em>set</em></span>, mutt will automatically attempt to decrypt traditional PGP
5739 messages whenever the user performs an operation which ordinarily would
5740 result in the contents of the message being operated on.  For example,
5741 if the user displays a pgp-traditional message which has not been manually
5742 checked with the <code class="literal"><a class="link" href="#check-traditional-pgp">&lt;check-traditional-pgp&gt;</a></code> function, mutt will automatically
5743 check the message for traditional pgp.
5744 </p></div><div class="sect2" title="3.155. pgp_autoinline"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-autoinline"></a>3.155. pgp_autoinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5745 Default: no</p></div><p>
5746 This option controls whether Mutt generates old-style inline
5747 (traditional) PGP encrypted or signed messages under certain
5748 circumstances.  This can be overridden by use of the pgp menu,
5749 when inline is not required.
5750 </p><p>
5751 Note that Mutt might automatically use PGP/MIME for messages
5752 which consist of more than a single MIME part.  Mutt can be
5753 configured to ask before sending PGP/MIME messages when inline
5754 (traditional) would not work.
5755 </p><p>
5756 Also see the <a class="link" href="#pgp-mime-auto" title="3.171. pgp_mime_auto">$pgp_mime_auto</a> variable.
5757 </p><p>
5758 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5759 <span class="bold"><strong>deprecated</strong></span>.
5760 (PGP only)
5761 </p></div><div class="sect2" title="3.156. pgp_check_exit"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-check-exit"></a>3.156. pgp_check_exit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5762 Default: yes</p></div><p>
5763 If <span class="emphasis"><em>set</em></span>, mutt will check the exit code of the PGP subprocess when
5764 signing or encrypting.  A non-zero exit code means that the
5765 subprocess failed.
5766 (PGP only)
5767 </p></div><div class="sect2" title="3.157. pgp_clearsign_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-clearsign-command"></a>3.157. pgp_clearsign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5768 Default: (empty)</p></div><p>
5769 This format is used to create an old-style <span class="quote">“<span class="quote">clearsigned</span>”</span> PGP
5770 message.  Note that the use of this format is <span class="bold"><strong>strongly</strong></span>
5771 <span class="bold"><strong>deprecated</strong></span>.
5772 </p><p>
5773 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5774 possible <code class="literal">printf(3)</code>-like sequences.
5775 (PGP only)
5776 </p></div><div class="sect2" title="3.158. pgp_decode_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decode-command"></a>3.158. pgp_decode_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5777 Default: (empty)</p></div><p>
5778 This format strings specifies a command which is used to decode
5779 application/pgp attachments.
5780 </p><p>
5781 The PGP command formats have their own set of <code class="literal">printf(3)</code>-like sequences:
5782
5783 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%p </td><td>Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
5784 string otherwise. Note: This may be used with a %? construct.
5785 </td></tr><tr><td>%f </td><td>Expands to the name of a file containing a message.
5786 </td></tr><tr><td>%s </td><td>Expands to the name of a file containing the signature part
5787            of a <code class="literal">multipart/signed</code> attachment when verifying it.
5788 </td></tr><tr><td>%a </td><td>The value of <a class="link" href="#pgp-sign-as" title="3.175. pgp_sign_as">$pgp_sign_as</a>.
5789 </td></tr><tr><td>%r </td><td>One or more key IDs.
5790 </td></tr></tbody></table></div><p>
5791 For examples on how to configure these formats for the various versions
5792 of PGP which are floating around, see the pgp and gpg sample configuration files in
5793 the <code class="literal">samples/</code> subdirectory which has been installed on your system
5794 alongside the documentation.
5795 (PGP only)
5796 </p></div><div class="sect2" title="3.159. pgp_decrypt_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decrypt-command"></a>3.159. pgp_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5797 Default: (empty)</p></div><p>
5798 This command is used to decrypt a PGP encrypted message.
5799 </p><p>
5800 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5801 possible <code class="literal">printf(3)</code>-like sequences.
5802 (PGP only)
5803 </p></div><div class="sect2" title="3.160. pgp_encrypt_only_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-only-command"></a>3.160. pgp_encrypt_only_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5804 Default: (empty)</p></div><p>
5805 This command is used to encrypt a body part without signing it.
5806 </p><p>
5807 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5808 possible <code class="literal">printf(3)</code>-like sequences.
5809 (PGP only)
5810 </p></div><div class="sect2" title="3.161. pgp_encrypt_sign_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-sign-command"></a>3.161. pgp_encrypt_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5811 Default: (empty)</p></div><p>
5812 This command is used to both sign and encrypt a body part.
5813 </p><p>
5814 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5815 possible <code class="literal">printf(3)</code>-like sequences.
5816 (PGP only)
5817 </p></div><div class="sect2" title="3.162. pgp_entry_format"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-entry-format"></a>3.162. pgp_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5818 Default: <span class="quote">“<span class="quote"><code class="literal">%4n %t%f %4l/0x%k %-4a %2c %u</code></span>”</span></p></div><p>
5819 This variable allows you to customize the PGP key selection menu to
5820 your personal taste. This string is similar to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, but
5821 has its own set of <code class="literal">printf(3)</code>-like sequences:
5822
5823 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%n     </td><td>number
5824 </td></tr><tr><td>%k     </td><td>key id
5825 </td></tr><tr><td>%u     </td><td>user id
5826 </td></tr><tr><td>%a     </td><td>algorithm
5827 </td></tr><tr><td>%l     </td><td>key length
5828 </td></tr><tr><td>%f     </td><td>flags
5829 </td></tr><tr><td>%c     </td><td>capabilities
5830 </td></tr><tr><td>%t     </td><td>trust/validity of the key-uid association
5831 </td></tr><tr><td>%[&lt;s&gt;] </td><td>date of the key where &lt;s&gt; is an <code class="literal">strftime(3)</code> expression
5832 </td></tr></tbody></table></div><p>
5833 (PGP only)
5834 </p></div><div class="sect2" title="3.163. pgp_export_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-export-command"></a>3.163. pgp_export_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5835 Default: (empty)</p></div><p>
5836 This command is used to export a public key from the user's
5837 key ring.
5838 </p><p>
5839 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5840 possible <code class="literal">printf(3)</code>-like sequences.
5841 (PGP only)
5842 </p></div><div class="sect2" title="3.164. pgp_getkeys_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-getkeys-command"></a>3.164. pgp_getkeys_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5843 Default: (empty)</p></div><p>
5844 This command is invoked whenever mutt will need public key information.
5845 Of the sequences supported by <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a>, %r is the only
5846 <code class="literal">printf(3)</code>-like sequence used with this format.
5847 (PGP only)
5848 </p></div><div class="sect2" title="3.165. pgp_good_sign"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-good-sign"></a>3.165. pgp_good_sign</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5849 Default: (empty)</p></div><p>
5850 If you assign a text to this variable, then a PGP signature is only
5851 considered verified if the output from <a class="link" href="#pgp-verify-command" title="3.181. pgp_verify_command">$pgp_verify_command</a> contains
5852 the text. Use this variable if the exit code from the command is 0
5853 even for bad signatures.
5854 (PGP only)
5855 </p></div><div class="sect2" title="3.166. pgp_ignore_subkeys"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-ignore-subkeys"></a>3.166. pgp_ignore_subkeys</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5856 Default: yes</p></div><p>
5857 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
5858 the principal key will inherit the subkeys' capabilities.  <span class="emphasis"><em>Unset</em></span> this
5859 if you want to play interesting key selection games.
5860 (PGP only)
5861 </p></div><div class="sect2" title="3.167. pgp_import_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-import-command"></a>3.167. pgp_import_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5862 Default: (empty)</p></div><p>
5863 This command is used to import a key from a message into
5864 the user's public key ring.
5865 </p><p>
5866 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5867 possible <code class="literal">printf(3)</code>-like sequences.
5868 (PGP only)
5869 </p></div><div class="sect2" title="3.168. pgp_list_pubring_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-pubring-command"></a>3.168. pgp_list_pubring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5870 Default: (empty)</p></div><p>
5871 This command is used to list the public key ring's contents.  The
5872 output format must be analogous to the one used by
5873
5874 </p><pre class="screen">
5875 gpg --list-keys --with-colons.
5876 </pre><p>
5877 This format is also generated by the <code class="literal">pgpring</code> utility which comes
5878 with mutt.
5879 </p><p>
5880 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5881 possible <code class="literal">printf(3)</code>-like sequences.
5882 (PGP only)
5883 </p></div><div class="sect2" title="3.169. pgp_list_secring_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-secring-command"></a>3.169. pgp_list_secring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5884 Default: (empty)</p></div><p>
5885 This command is used to list the secret key ring's contents.  The
5886 output format must be analogous to the one used by:
5887
5888 </p><pre class="screen">
5889 gpg --list-keys --with-colons.
5890 </pre><p>
5891 This format is also generated by the <code class="literal">pgpring</code> utility which comes
5892 with mutt.
5893 </p><p>
5894 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5895 possible <code class="literal">printf(3)</code>-like sequences.
5896 (PGP only)
5897 </p></div><div class="sect2" title="3.170. pgp_long_ids"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-long-ids"></a>3.170. pgp_long_ids</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5898 Default: no</p></div><p>
5899 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.
5900 (PGP only)
5901 </p></div><div class="sect2" title="3.171. pgp_mime_auto"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-mime-auto"></a>3.171. pgp_mime_auto</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5902 Default: ask-yes</p></div><p>
5903 This option controls whether Mutt will prompt you for
5904 automatically sending a (signed/encrypted) message using
5905 PGP/MIME when inline (traditional) fails (for any reason).
5906 </p><p>
5907 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5908 <span class="bold"><strong>deprecated</strong></span>.
5909 (PGP only)
5910 </p></div><div class="sect2" title="3.172. pgp_replyinline"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-replyinline"></a>3.172. pgp_replyinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5911 Default: no</p></div><p>
5912 Setting this variable will cause Mutt to always attempt to
5913 create an inline (traditional) message when replying to a
5914 message which is PGP encrypted/signed inline.  This can be
5915 overridden by use of the pgp menu, when inline is not
5916 required.  This option does not automatically detect if the
5917 (replied-to) message is inline; instead it relies on Mutt
5918 internals for previously checked/flagged messages.
5919 </p><p>
5920 Note that Mutt might automatically use PGP/MIME for messages
5921 which consist of more than a single MIME part.  Mutt can be
5922 configured to ask before sending PGP/MIME messages when inline
5923 (traditional) would not work.
5924 </p><p>
5925 Also see the <a class="link" href="#pgp-mime-auto" title="3.171. pgp_mime_auto">$pgp_mime_auto</a> variable.
5926 </p><p>
5927 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
5928 <span class="bold"><strong>deprecated</strong></span>.
5929 (PGP only)
5930 </p></div><div class="sect2" title="3.173. pgp_retainable_sigs"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-retainable-sigs"></a>3.173. pgp_retainable_sigs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5931 Default: no</p></div><p>
5932 If <span class="emphasis"><em>set</em></span>, signed and encrypted messages will consist of nested
5933 <code class="literal">multipart/signed</code> and <code class="literal">multipart/encrypted</code> body parts.
5934 </p><p>
5935 This is useful for applications like encrypted and signed mailing
5936 lists, where the outer layer (<code class="literal">multipart/encrypted</code>) can be easily
5937 removed, while the inner <code class="literal">multipart/signed</code> part is retained.
5938 (PGP only)
5939 </p></div><div class="sect2" title="3.174. pgp_show_unusable"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-show-unusable"></a>3.174. pgp_show_unusable</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5940 Default: yes</p></div><p>
5941 If <span class="emphasis"><em>set</em></span>, mutt will display non-usable keys on the PGP key selection
5942 menu.  This includes keys which have been revoked, have expired, or
5943 have been marked as <span class="quote">“<span class="quote">disabled</span>”</span> by the user.
5944 (PGP only)
5945 </p></div><div class="sect2" title="3.175. pgp_sign_as"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-as"></a>3.175. pgp_sign_as</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5946 Default: (empty)</p></div><p>
5947 If you have more than one key pair, this option allows you to specify
5948 which of your private keys to use.  It is recommended that you use the
5949 keyid form to specify your key (e.g. <code class="literal">0x00112233</code>).
5950 (PGP only)
5951 </p></div><div class="sect2" title="3.176. pgp_sign_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-command"></a>3.176. pgp_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5952 Default: (empty)</p></div><p>
5953 This command is used to create the detached PGP signature for a
5954 <code class="literal">multipart/signed</code> PGP/MIME body part.
5955 </p><p>
5956 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5957 possible <code class="literal">printf(3)</code>-like sequences.
5958 (PGP only)
5959 </p></div><div class="sect2" title="3.177. pgp_sort_keys"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sort-keys"></a>3.177. pgp_sort_keys</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5960 Default: address</p></div><p>
5961 Specifies how the entries in the pgp menu are sorted. The
5962 following are legal values:
5963
5964 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>address </td><td>sort alphabetically by user id
5965 </td></tr><tr><td>keyid   </td><td>sort alphabetically by key id
5966 </td></tr><tr><td>date    </td><td>sort by key creation date
5967 </td></tr><tr><td>trust   </td><td>sort by the trust of the key
5968 </td></tr></tbody></table></div><p>
5969 If you prefer reverse order of the above values, prefix it with
5970 <span class="quote">“<span class="quote">reverse-</span>”</span>.
5971 (PGP only)
5972 </p></div><div class="sect2" title="3.178. pgp_strict_enc"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-strict-enc"></a>3.178. pgp_strict_enc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5973 Default: yes</p></div><p>
5974 If <span class="emphasis"><em>set</em></span>, Mutt will automatically encode PGP/MIME signed messages as
5975 quoted-printable.  Please note that unsetting this variable may
5976 lead to problems with non-verifyable PGP signatures, so only change
5977 this if you know what you are doing.
5978 (PGP only)
5979 </p></div><div class="sect2" title="3.179. pgp_timeout"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-timeout"></a>3.179. pgp_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5980 Default: 300</p></div><p>
5981 The number of seconds after which a cached passphrase will expire if
5982 not used.
5983 (PGP only)
5984 </p></div><div class="sect2" title="3.180. pgp_use_gpg_agent"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-use-gpg-agent"></a>3.180. pgp_use_gpg_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5985 Default: no</p></div><p>
5986 If <span class="emphasis"><em>set</em></span>, mutt will use a possibly-running <code class="literal">gpg-agent(1)</code> process.
5987 (PGP only)
5988 </p></div><div class="sect2" title="3.181. pgp_verify_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-command"></a>3.181. pgp_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5989 Default: (empty)</p></div><p>
5990 This command is used to verify PGP signatures.
5991 </p><p>
5992 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
5993 possible <code class="literal">printf(3)</code>-like sequences.
5994 (PGP only)
5995 </p></div><div class="sect2" title="3.182. pgp_verify_key_command"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-key-command"></a>3.182. pgp_verify_key_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5996 Default: (empty)</p></div><p>
5997 This command is used to verify key information from the key selection
5998 menu.
5999 </p><p>
6000 This is a format string, see the <a class="link" href="#pgp-decode-command" title="3.158. pgp_decode_command">$pgp_decode_command</a> command for
6001 possible <code class="literal">printf(3)</code>-like sequences.
6002 (PGP only)
6003 </p></div><div class="sect2" title="3.183. pipe_decode"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-decode"></a>3.183. pipe_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6004 Default: no</p></div><p>
6005 Used in connection with the <code class="literal">&lt;pipe-message&gt;</code> command.  When <span class="emphasis"><em>unset</em></span>,
6006 Mutt will pipe the messages without any preprocessing. When <span class="emphasis"><em>set</em></span>, Mutt
6007 will weed headers and will attempt to decode the messages
6008 first.
6009 </p></div><div class="sect2" title="3.184. pipe_sep"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-sep"></a>3.184. pipe_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6010 Default: <span class="quote">“<span class="quote"><code class="literal">\n</code></span>”</span></p></div><p>
6011 The separator to add between messages when piping a list of tagged
6012 messages to an external Unix command.
6013 </p></div><div class="sect2" title="3.185. pipe_split"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-split"></a>3.185. pipe_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6014 Default: no</p></div><p>
6015 Used in connection with the <code class="literal">&lt;pipe-message&gt;</code> function following
6016 <code class="literal">&lt;tag-prefix&gt;</code>.  If this variable is <span class="emphasis"><em>unset</em></span>, when piping a list of
6017 tagged messages Mutt will concatenate the messages and will pipe them
6018 all concatenated.  When <span class="emphasis"><em>set</em></span>, Mutt will pipe the messages one by one.
6019 In both cases the messages are piped in the current sorted order,
6020 and the <a class="link" href="#pipe-sep" title="3.184. pipe_sep">$pipe_sep</a> separator is added after each message.
6021 </p></div><div class="sect2" title="3.186. pop_auth_try_all"><div class="titlepage"><div><div><h3 class="title"><a id="pop-auth-try-all"></a>3.186. pop_auth_try_all</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6022 Default: yes</p></div><p>
6023 If <span class="emphasis"><em>set</em></span>, Mutt will try all available authentication methods.
6024 When <span class="emphasis"><em>unset</em></span>, Mutt will only fall back to other authentication
6025 methods if the previous methods are unavailable. If a method is
6026 available but authentication fails, Mutt will not connect to the POP server.
6027 </p></div><div class="sect2" title="3.187. pop_authenticators"><div class="titlepage"><div><div><h3 class="title"><a id="pop-authenticators"></a>3.187. pop_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6028 Default: (empty)</p></div><p>
6029 This is a colon-delimited list of authentication methods mutt may
6030 attempt to use to log in to an POP server, in the order mutt should
6031 try them.  Authentication methods are either <span class="quote">“<span class="quote">user</span>”</span>, <span class="quote">“<span class="quote">apop</span>”</span> or any
6032 SASL mechanism, e.g. <span class="quote">“<span class="quote">digest-md5</span>”</span>, <span class="quote">“<span class="quote">gssapi</span>”</span> or <span class="quote">“<span class="quote">cram-md5</span>”</span>.
6033 This option is case-insensitive. If this option is <span class="emphasis"><em>unset</em></span>
6034 (the default) mutt will try all available methods, in order from
6035 most-secure to least-secure.
6036 </p><p>
6037 Example:
6038
6039 </p><pre class="screen">
6040 set pop_authenticators="digest-md5:apop:user"
6041 </pre></div><div class="sect2" title="3.188. pop_checkinterval"><div class="titlepage"><div><div><h3 class="title"><a id="pop-checkinterval"></a>3.188. pop_checkinterval</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6042 Default: 60</p></div><p>
6043 This variable configures how often (in seconds) mutt should look for
6044 new mail in the currently selected mailbox if it is a POP mailbox.
6045 </p></div><div class="sect2" title="3.189. pop_delete"><div class="titlepage"><div><div><h3 class="title"><a id="pop-delete"></a>3.189. pop_delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6046 Default: ask-no</p></div><p>
6047 If <span class="emphasis"><em>set</em></span>, Mutt will delete successfully downloaded messages from the POP
6048 server when using the <code class="literal"><a class="link" href="#fetch-mail">&lt;fetch-mail&gt;</a></code> function.  When <span class="emphasis"><em>unset</em></span>, Mutt will
6049 download messages but also leave them on the POP server.
6050 </p></div><div class="sect2" title="3.190. pop_host"><div class="titlepage"><div><div><h3 class="title"><a id="pop-host"></a>3.190. pop_host</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6051 Default: (empty)</p></div><p>
6052 The name of your POP server for the <code class="literal"><a class="link" href="#fetch-mail">&lt;fetch-mail&gt;</a></code> function.  You
6053 can also specify an alternative port, username and password, i.e.:
6054
6055 </p><pre class="screen">
6056 [pop[s]://][username[:password]@]popserver[:port]
6057 </pre><p>
6058 where <span class="quote">“<span class="quote">[...]</span>”</span> denotes an optional part.
6059 </p></div><div class="sect2" title="3.191. pop_last"><div class="titlepage"><div><div><h3 class="title"><a id="pop-last"></a>3.191. pop_last</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6060 Default: no</p></div><p>
6061 If this variable is <span class="emphasis"><em>set</em></span>, mutt will try to use the <span class="quote">“<span class="quote"><code class="literal">LAST</code></span>”</span> POP command
6062 for retrieving only unread messages from the POP server when using
6063 the <code class="literal"><a class="link" href="#fetch-mail">&lt;fetch-mail&gt;</a></code> function.
6064 </p></div><div class="sect2" title="3.192. pop_pass"><div class="titlepage"><div><div><h3 class="title"><a id="pop-pass"></a>3.192. pop_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6065 Default: (empty)</p></div><p>
6066 Specifies the password for your POP account.  If <span class="emphasis"><em>unset</em></span>, Mutt will
6067 prompt you for your password when you open a POP mailbox.
6068 </p><p>
6069 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
6070 fairly secure machine, because the superuser can read your muttrc
6071 even if you are the only one who can read the file.
6072 </p></div><div class="sect2" title="3.193. pop_reconnect"><div class="titlepage"><div><div><h3 class="title"><a id="pop-reconnect"></a>3.193. pop_reconnect</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6073 Default: ask-yes</p></div><p>
6074 Controls whether or not Mutt will try to reconnect to the POP server if
6075 the connection is lost.
6076 </p></div><div class="sect2" title="3.194. pop_user"><div class="titlepage"><div><div><h3 class="title"><a id="pop-user"></a>3.194. pop_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6077 Default: (empty)</p></div><p>
6078 Your login name on the POP server.
6079 </p><p>
6080 This variable defaults to your user name on the local machine.
6081 </p></div><div class="sect2" title="3.195. post_indent_string"><div class="titlepage"><div><div><h3 class="title"><a id="post-indent-string"></a>3.195. post_indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6082 Default: (empty)</p></div><p>
6083 Similar to the <a class="link" href="#attribution" title="3.16. attribution">$attribution</a> variable, Mutt will append this
6084 string after the inclusion of a message which is being replied to.
6085 </p></div><div class="sect2" title="3.196. postpone"><div class="titlepage"><div><div><h3 class="title"><a id="postpone"></a>3.196. postpone</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6086 Default: ask-yes</p></div><p>
6087 Controls whether or not messages are saved in the <a class="link" href="#postponed" title="3.197. postponed">$postponed</a>
6088 mailbox when you elect not to send immediately.
6089 </p><p>
6090 Also see the <a class="link" href="#recall" title="3.211. recall">$recall</a> variable.
6091 </p></div><div class="sect2" title="3.197. postponed"><div class="titlepage"><div><div><h3 class="title"><a id="postponed"></a>3.197. postponed</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6092 Default: <span class="quote">“<span class="quote"><code class="literal">~/postponed</code></span>”</span></p></div><p>
6093 Mutt allows you to indefinitely <span class="quote">“<span class="quote"><a class="link" href="#postpone" title="3.196. postpone">postpone</a> sending a message</span>”</span> which
6094 you are editing.  When you choose to postpone a message, Mutt saves it
6095 in the mailbox specified by this variable.
6096 </p><p>
6097 Also see the <a class="link" href="#postpone" title="3.196. postpone">$postpone</a> variable.
6098 </p></div><div class="sect2" title="3.198. preconnect"><div class="titlepage"><div><div><h3 class="title"><a id="preconnect"></a>3.198. preconnect</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6099 Default: (empty)</p></div><p>
6100 If <span class="emphasis"><em>set</em></span>, a shell command to be executed if mutt fails to establish
6101 a connection to the server. This is useful for setting up secure
6102 connections, e.g. with <code class="literal">ssh(1)</code>. If the command returns a  nonzero
6103 status, mutt gives up opening the server. Example:
6104
6105 </p><pre class="screen">
6106 set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
6107 sleep 20 &lt; /dev/null &gt; /dev/null"
6108 </pre><p>
6109 Mailbox <span class="quote">“<span class="quote">foo</span>”</span> on <span class="quote">“<span class="quote">mailhost.net</span>”</span> can now be reached
6110 as <span class="quote">“<span class="quote">{localhost:1234}foo</span>”</span>.
6111 </p><p>
6112 Note: For this example to work, you must be able to log in to the
6113 remote machine without having to enter a password.
6114 </p></div><div class="sect2" title="3.199. print"><div class="titlepage"><div><div><h3 class="title"><a id="print"></a>3.199. print</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6115 Default: ask-no</p></div><p>
6116 Controls whether or not Mutt really prints messages.
6117 This is set to <span class="quote">“<span class="quote">ask-no</span>”</span> by default, because some people
6118 accidentally hit <span class="quote">“<span class="quote">p</span>”</span> often.
6119 </p></div><div class="sect2" title="3.200. print_command"><div class="titlepage"><div><div><h3 class="title"><a id="print-command"></a>3.200. print_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6120 Default: <span class="quote">“<span class="quote"><code class="literal">lpr</code></span>”</span></p></div><p>
6121 This specifies the command pipe that should be used to print messages.
6122 </p></div><div class="sect2" title="3.201. print_decode"><div class="titlepage"><div><div><h3 class="title"><a id="print-decode"></a>3.201. print_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6123 Default: yes</p></div><p>
6124 Used in connection with the <code class="literal">&lt;print-message&gt;</code> command.  If this
6125 option is <span class="emphasis"><em>set</em></span>, the message is decoded before it is passed to the
6126 external command specified by <a class="link" href="#print-command" title="3.200. print_command">$print_command</a>.  If this option
6127 is <span class="emphasis"><em>unset</em></span>, no processing will be applied to the message when
6128 printing it.  The latter setting may be useful if you are using
6129 some advanced printer filter which is able to properly format
6130 e-mail messages for printing.
6131 </p></div><div class="sect2" title="3.202. print_split"><div class="titlepage"><div><div><h3 class="title"><a id="print-split"></a>3.202. print_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6132 Default: no</p></div><p>
6133 Used in connection with the <code class="literal">&lt;print-message&gt;</code> command.  If this option
6134 is <span class="emphasis"><em>set</em></span>, the command specified by <a class="link" href="#print-command" title="3.200. print_command">$print_command</a> is executed once for
6135 each message which is to be printed.  If this option is <span class="emphasis"><em>unset</em></span>,
6136 the command specified by <a class="link" href="#print-command" title="3.200. print_command">$print_command</a> is executed only once, and
6137 all the messages are concatenated, with a form feed as the message
6138 separator.
6139 </p><p>
6140 Those who use the <code class="literal">enscript</code>(1) program's mail-printing mode will
6141 most likely want to <span class="emphasis"><em>set</em></span> this option.
6142 </p></div><div class="sect2" title="3.203. prompt_after"><div class="titlepage"><div><div><h3 class="title"><a id="prompt-after"></a>3.203. prompt_after</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6143 Default: yes</p></div><p>
6144 If you use an <span class="emphasis"><em>external</em></span> <a class="link" href="#pager" title="3.149. pager">$pager</a>, setting this variable will
6145 cause Mutt to prompt you for a command when the pager exits rather
6146 than returning to the index menu.  If <span class="emphasis"><em>unset</em></span>, Mutt will return to the
6147 index menu when the external pager exits.
6148 </p></div><div class="sect2" title="3.204. query_command"><div class="titlepage"><div><div><h3 class="title"><a id="query-command"></a>3.204. query_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6149 Default: (empty)</p></div><p>
6150 This specifies the command Mutt will use to make external address
6151 queries.  The string may contain a <span class="quote">“<span class="quote">%s</span>”</span>, which will be substituted
6152 with the query string the user types.  Mutt will add quotes around the
6153 string substituted for <span class="quote">“<span class="quote">%s</span>”</span> automatically according to shell quoting
6154 rules, so you should avoid adding your own.  If no <span class="quote">“<span class="quote">%s</span>”</span> is found in
6155 the string, Mutt will append the user's query to the end of the string.
6156 See <span class="quote">“<span class="quote"><a class="link" href="#query" title="6. External Address Queries">query</a></span>”</span> for more information.
6157 </p></div><div class="sect2" title="3.205. query_format"><div class="titlepage"><div><div><h3 class="title"><a id="query-format"></a>3.205. query_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6158 Default: <span class="quote">“<span class="quote"><code class="literal">%4c %t %-25.25a %-25.25n %?e?(%e)?</code></span>”</span></p></div><p>
6159 This variable describes the format of the <span class="quote">“<span class="quote">query</span>”</span> menu. The
6160 following <code class="literal">printf(3)</code>-style sequences are understood:
6161
6162 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%a  </td><td>destination address
6163 </td></tr><tr><td>%c  </td><td>current entry number
6164 </td></tr><tr><td>%e  </td><td>extra information *
6165 </td></tr><tr><td>%n  </td><td>destination name
6166 </td></tr><tr><td>%t  </td><td><span class="quote">“<span class="quote">*</span>”</span> if current entry is tagged, a space otherwise
6167 </td></tr><tr><td>%&gt;X </td><td>right justify the rest of the string and pad with <span class="quote">“<span class="quote">X</span>”</span>
6168 </td></tr><tr><td>%|X </td><td>pad to the end of the line with <span class="quote">“<span class="quote">X</span>”</span>
6169 </td></tr><tr><td>%*X </td><td>soft-fill with character <span class="quote">“<span class="quote">X</span>”</span> as pad
6170 </td></tr></tbody></table></div><p>
6171 For an explanation of <span class="quote">“<span class="quote">soft-fill</span>”</span>, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
6172 </p><p>
6173 * = can be optionally printed if nonzero, see the <a class="link" href="#status-format" title="3.283. status_format">$status_format</a> documentation.
6174 </p></div><div class="sect2" title="3.206. quit"><div class="titlepage"><div><div><h3 class="title"><a id="quit"></a>3.206. quit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6175 Default: yes</p></div><p>
6176 This variable controls whether <span class="quote">“<span class="quote">quit</span>”</span> and <span class="quote">“<span class="quote">exit</span>”</span> actually quit
6177 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
6178 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
6179 prompted for confirmation when you try to quit.
6180 </p></div><div class="sect2" title="3.207. quote_regexp"><div class="titlepage"><div><div><h3 class="title"><a id="quote-regexp"></a>3.207. quote_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
6181 Default: <span class="quote">“<span class="quote"><code class="literal">^([ \t]*[|&gt;:}#])+</code></span>”</span></p></div><p>
6182 A regular expression used in the internal pager to determine quoted
6183 sections of text in the body of a message. Quoted text may be filtered
6184 out using the <code class="literal">&lt;toggle-quoted&gt;</code> command, or colored according to the
6185 <span class="quote">“<span class="quote">color quoted</span>”</span> family of directives.
6186 </p><p>
6187 Higher levels of quoting may be colored differently (<span class="quote">“<span class="quote">color quoted1</span>”</span>,
6188 <span class="quote">“<span class="quote">color quoted2</span>”</span>, etc.). The quoting level is determined by removing
6189 the last character from the matched text and recursively reapplying
6190 the regular expression until it fails to produce a match.
6191 </p><p>
6192 Match detection may be overridden by the <a class="link" href="#smileys" title="3.240. smileys">$smileys</a> regular expression.
6193 </p></div><div class="sect2" title="3.208. read_inc"><div class="titlepage"><div><div><h3 class="title"><a id="read-inc"></a>3.208. read_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6194 Default: 10</p></div><p>
6195 If set to a value greater than 0, Mutt will display which message it
6196 is currently on when reading a mailbox or when performing search actions
6197 such as search and limit. The message is printed after
6198 this many messages have been read or searched (e.g., if set to 25, Mutt will
6199 print a message when it is at message 25, and then again when it gets
6200 to message 50).  This variable is meant to indicate progress when
6201 reading or searching large mailboxes which may take some time.
6202 When set to 0, only a single message will appear before the reading
6203 the mailbox.
6204 </p><p>
6205 Also see the <a class="link" href="#write-inc" title="3.312. write_inc">$write_inc</a>, <a class="link" href="#net-inc" title="3.148. net_inc">$net_inc</a> and <a class="link" href="#time-inc" title="3.291. time_inc">$time_inc</a> variables and the
6206 <span class="quote">“<span class="quote"><a class="link" href="#tuning" title="Chapter 8. Performance Tuning">tuning</a></span>”</span> section of the manual for performance considerations.
6207 </p></div><div class="sect2" title="3.209. read_only"><div class="titlepage"><div><div><h3 class="title"><a id="read-only"></a>3.209. read_only</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6208 Default: no</p></div><p>
6209 If <span class="emphasis"><em>set</em></span>, all folders are opened in read-only mode.
6210 </p></div><div class="sect2" title="3.210. realname"><div class="titlepage"><div><div><h3 class="title"><a id="realname"></a>3.210. realname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6211 Default: (empty)</p></div><p>
6212 This variable specifies what <span class="quote">“<span class="quote">real</span>”</span> or <span class="quote">“<span class="quote">personal</span>”</span> name should be used
6213 when sending messages.
6214 </p><p>
6215 By default, this is the GECOS field from <code class="literal">/etc/passwd</code>.  Note that this
6216 variable will <span class="emphasis"><em>not</em></span> be used when the user has set a real name
6217 in the <a class="link" href="#from" title="3.75. from">$from</a> variable.
6218 </p></div><div class="sect2" title="3.211. recall"><div class="titlepage"><div><div><h3 class="title"><a id="recall"></a>3.211. recall</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6219 Default: ask-yes</p></div><p>
6220 Controls whether or not Mutt recalls postponed messages
6221 when composing a new message.
6222 </p><p>
6223 <span class="emphasis"><em>Setting</em></span> this variable to is not generally useful, and thus not
6224 recommended.
6225 </p><p>
6226 Also see <a class="link" href="#postponed" title="3.197. postponed">$postponed</a> variable.
6227 </p></div><div class="sect2" title="3.212. record"><div class="titlepage"><div><div><h3 class="title"><a id="record"></a>3.212. record</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6228 Default: <span class="quote">“<span class="quote"><code class="literal">~/sent</code></span>”</span></p></div><p>
6229 This specifies the file into which your outgoing messages should be
6230 appended.  (This is meant as the primary method for saving a copy of
6231 your messages, but another way to do this is using the <span class="quote">“<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”</span>
6232 command to create a <span class="quote">“<span class="quote">Bcc:</span>”</span> field with your email address in it.)
6233 </p><p>
6234 The value of <span class="emphasis"><em><a class="link" href="#record" title="3.212. record">$record</a></em></span> is overridden by the <a class="link" href="#force-name" title="3.69. force_name">$force_name</a> and
6235 <a class="link" href="#save-name" title="3.224. save_name">$save_name</a> variables, and the <span class="quote">“<span class="quote"><a class="link" href="#fcc-hook" title="17. Specify Default Fcc: Mailbox When Composing">fcc-hook</a></span>”</span> command.
6236 </p></div><div class="sect2" title="3.213. reply_regexp"><div class="titlepage"><div><div><h3 class="title"><a id="reply-regexp"></a>3.213. reply_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
6237 Default: <span class="quote">“<span class="quote"><code class="literal">^(re([\[0-9\]+])*|aw):[ \t]*</code></span>”</span></p></div><p>
6238 A regular expression used to recognize reply messages when threading
6239 and replying. The default value corresponds to the English "Re:" and
6240 the German "Aw:".
6241 </p></div><div class="sect2" title="3.214. reply_self"><div class="titlepage"><div><div><h3 class="title"><a id="reply-self"></a>3.214. reply_self</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6242 Default: no</p></div><p>
6243 If <span class="emphasis"><em>unset</em></span> and you are replying to a message sent by you, Mutt will
6244 assume that you want to reply to the recipients of that message rather
6245 than to yourself.
6246 </p><p>
6247 Also see the <span class="quote">“<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”</span> command.
6248 </p></div><div class="sect2" title="3.215. reply_to"><div class="titlepage"><div><div><h3 class="title"><a id="reply-to"></a>3.215. reply_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6249 Default: ask-yes</p></div><p>
6250 If <span class="emphasis"><em>set</em></span>, when replying to a message, Mutt will use the address listed
6251 in the Reply-to: header as the recipient of the reply.  If <span class="emphasis"><em>unset</em></span>,
6252 it will use the address in the From: header field instead.  This
6253 option is useful for reading a mailing list that sets the Reply-To:
6254 header field to the list address and you want to send a private
6255 message to the author of a message.
6256 </p></div><div class="sect2" title="3.216. resolve"><div class="titlepage"><div><div><h3 class="title"><a id="resolve"></a>3.216. resolve</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6257 Default: yes</p></div><p>
6258 When <span class="emphasis"><em>set</em></span>, the cursor will be automatically advanced to the next
6259 (possibly undeleted) message whenever a command that modifies the
6260 current message is executed.
6261 </p></div><div class="sect2" title="3.217. reverse_alias"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-alias"></a>3.217. reverse_alias</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6262 Default: no</p></div><p>
6263 This variable controls whether or not Mutt will display the <span class="quote">“<span class="quote">personal</span>”</span>
6264 name from your aliases in the index menu if it finds an alias that
6265 matches the message's sender.  For example, if you have the following
6266 alias:
6267
6268 </p><pre class="screen">
6269 alias juser abd30425@somewhere.net (Joe User)
6270 </pre><p>
6271 and then you receive mail which contains the following header:
6272
6273 </p><pre class="screen">
6274 From: abd30425@somewhere.net
6275 </pre><p>
6276 It would be displayed in the index menu as <span class="quote">“<span class="quote">Joe User</span>”</span> instead of
6277 <span class="quote">“<span class="quote">abd30425@somewhere.net.</span>”</span>  This is useful when the person's e-mail
6278 address is not human friendly.
6279 </p></div><div class="sect2" title="3.218. reverse_name"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-name"></a>3.218. reverse_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6280 Default: no</p></div><p>
6281 It may sometimes arrive that you receive mail to a certain machine,
6282 move the messages to another machine, and reply to some the messages
6283 from there.  If this variable is <span class="emphasis"><em>set</em></span>, the default <span class="emphasis"><em>From:</em></span> line of
6284 the reply messages is built using the address where you received the
6285 messages you are replying to <span class="bold"><strong>if</strong></span> that address matches your
6286 <span class="quote">“<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”</span>.  If the variable is <span class="emphasis"><em>unset</em></span>, or the address that would be
6287 used doesn't match your <span class="quote">“<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”</span>, the <span class="emphasis"><em>From:</em></span> line will use
6288 your address on the current machine.
6289 </p><p>
6290 Also see the <span class="quote">“<span class="quote"><a class="link" href="#alternates" title="11. Alternative Addresses">alternates</a></span>”</span> command.
6291 </p></div><div class="sect2" title="3.219. reverse_realname"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-realname"></a>3.219. reverse_realname</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6292 Default: yes</p></div><p>
6293 This variable fine-tunes the behavior of the <a class="link" href="#reverse-name" title="3.218. reverse_name">$reverse_name</a> feature.
6294 When it is <span class="emphasis"><em>set</em></span>, mutt will use the address from incoming messages as-is,
6295 possibly including eventual real names.  When it is <span class="emphasis"><em>unset</em></span>, mutt will
6296 override any such real names with the setting of the <a class="link" href="#realname" title="3.210. realname">$realname</a> variable.
6297 </p></div><div class="sect2" title="3.220. rfc2047_parameters"><div class="titlepage"><div><div><h3 class="title"><a id="rfc2047-parameters"></a>3.220. rfc2047_parameters</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6298 Default: no</p></div><p>
6299 When this variable is <span class="emphasis"><em>set</em></span>, Mutt will decode RFC2047-encoded MIME
6300 parameters. You want to set this variable when mutt suggests you
6301 to save attachments to files named like:
6302
6303 </p><pre class="screen">
6304 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
6305 </pre><p>
6306 When this variable is <span class="emphasis"><em>set</em></span> interactively, the change won't be
6307 active until you change folders.
6308 </p><p>
6309 Note that this use of RFC2047's encoding is explicitly
6310 prohibited by the standard, but nevertheless encountered in the
6311 wild.
6312 </p><p>
6313 Also note that setting this parameter will <span class="emphasis"><em>not</em></span> have the effect
6314 that mutt <span class="emphasis"><em>generates</em></span> this kind of encoding.  Instead, mutt will
6315 unconditionally use the encoding specified in RFC2231.
6316 </p></div><div class="sect2" title="3.221. save_address"><div class="titlepage"><div><div><h3 class="title"><a id="save-address"></a>3.221. save_address</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6317 Default: no</p></div><p>
6318 If <span class="emphasis"><em>set</em></span>, mutt will take the sender's full address when choosing a
6319 default folder for saving a mail. If <a class="link" href="#save-name" title="3.224. save_name">$save_name</a> or <a class="link" href="#force-name" title="3.69. force_name">$force_name</a>
6320 is <span class="emphasis"><em>set</em></span> too, the selection of the Fcc folder will be changed as well.
6321 </p></div><div class="sect2" title="3.222. save_empty"><div class="titlepage"><div><div><h3 class="title"><a id="save-empty"></a>3.222. save_empty</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6322 Default: yes</p></div><p>
6323 When <span class="emphasis"><em>unset</em></span>, mailboxes which contain no saved messages will be removed
6324 when closed (the exception is <a class="link" href="#spoolfile" title="3.270. spoolfile">$spoolfile</a> which is never removed).
6325 If <span class="emphasis"><em>set</em></span>, mailboxes are never removed.
6326 </p><p>
6327 <span class="bold"><strong>Note:</strong></span> This only applies to mbox and MMDF folders, Mutt does not
6328 delete MH and Maildir directories.
6329 </p></div><div class="sect2" title="3.223. save_history"><div class="titlepage"><div><div><h3 class="title"><a id="save-history"></a>3.223. save_history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6330 Default: 0</p></div><p>
6331 This variable controls the size of the history (per category) saved in the
6332 <a class="link" href="#history-file" title="3.90. history_file">$history_file</a> file.
6333 </p></div><div class="sect2" title="3.224. save_name"><div class="titlepage"><div><div><h3 class="title"><a id="save-name"></a>3.224. save_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6334 Default: no</p></div><p>
6335 This variable controls how copies of outgoing messages are saved.
6336 When <span class="emphasis"><em>set</em></span>, a check is made to see if a mailbox specified by the
6337 recipient address exists (this is done by searching for a mailbox in
6338 the <a class="link" href="#folder" title="3.66. folder">$folder</a> directory with the <span class="emphasis"><em>username</em></span> part of the
6339 recipient address).  If the mailbox exists, the outgoing message will
6340 be saved to that mailbox, otherwise the message is saved to the
6341 <a class="link" href="#record" title="3.212. record">$record</a> mailbox.
6342 </p><p>
6343 Also see the <a class="link" href="#force-name" title="3.69. force_name">$force_name</a> variable.
6344 </p></div><div class="sect2" title="3.225. score"><div class="titlepage"><div><div><h3 class="title"><a id="score"></a>3.225. score</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6345 Default: yes</p></div><p>
6346 When this variable is <span class="emphasis"><em>unset</em></span>, scoring is turned off.  This can
6347 be useful to selectively disable scoring for certain folders when the
6348 <a class="link" href="#score-threshold-delete" title="3.226. score_threshold_delete">$score_threshold_delete</a> variable and related are used.
6349 </p></div><div class="sect2" title="3.226. score_threshold_delete"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-delete"></a>3.226. score_threshold_delete</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6350 Default: -1</p></div><p>
6351 Messages which have been assigned a score equal to or lower than the value
6352 of this variable are automatically marked for deletion by mutt.  Since
6353 mutt scores are always greater than or equal to zero, the default setting
6354 of this variable will never mark a message for deletion.
6355 </p></div><div class="sect2" title="3.227. score_threshold_flag"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-flag"></a>3.227. score_threshold_flag</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6356 Default: 9999</p></div><p>
6357 Messages which have been assigned a score greater than or equal to this
6358 variable's value are automatically marked "flagged".
6359 </p></div><div class="sect2" title="3.228. score_threshold_read"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-read"></a>3.228. score_threshold_read</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6360 Default: -1</p></div><p>
6361 Messages which have been assigned a score equal to or lower than the value
6362 of this variable are automatically marked as read by mutt.  Since
6363 mutt scores are always greater than or equal to zero, the default setting
6364 of this variable will never mark a message read.
6365 </p></div><div class="sect2" title="3.229. search_context"><div class="titlepage"><div><div><h3 class="title"><a id="search-context"></a>3.229. search_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6366 Default: 0</p></div><p>
6367 For the pager, this variable specifies the number of lines shown
6368 before search results. By default, search results will be top-aligned.
6369 </p></div><div class="sect2" title="3.230. send_charset"><div class="titlepage"><div><div><h3 class="title"><a id="send-charset"></a>3.230. send_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6370 Default: <span class="quote">“<span class="quote"><code class="literal">us-ascii:iso-8859-1:utf-8</code></span>”</span></p></div><p>
6371 A colon-delimited list of character sets for outgoing messages. Mutt will use the
6372 first character set into which the text can be converted exactly.
6373 If your <a class="link" href="#charset" title="3.25. charset">$charset</a> is not <span class="quote">“<span class="quote">iso-8859-1</span>”</span> and recipients may not
6374 understand <span class="quote">“<span class="quote">UTF-8</span>”</span>, it is advisable to include in the list an
6375 appropriate widely used standard character set (such as
6376 <span class="quote">“<span class="quote">iso-8859-2</span>”</span>, <span class="quote">“<span class="quote">koi8-r</span>”</span> or <span class="quote">“<span class="quote">iso-2022-jp</span>”</span>) either instead of or after
6377 <span class="quote">“<span class="quote">iso-8859-1</span>”</span>.
6378 </p><p>
6379 In case the text cannot be converted into one of these exactly,
6380 mutt uses <a class="link" href="#charset" title="3.25. charset">$charset</a> as a fallback.
6381 </p></div><div class="sect2" title="3.231. sendmail"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail"></a>3.231. sendmail</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6382 Default: <span class="quote">“<span class="quote"><code class="literal">/usr/sbin/sendmail -oem -oi</code></span>”</span></p></div><p>
6383 Specifies the program and arguments used to deliver mail sent by Mutt.
6384 Mutt expects that the specified program interprets additional
6385 arguments as recipient addresses.
6386 </p></div><div class="sect2" title="3.232. sendmail_wait"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail-wait"></a>3.232. sendmail_wait</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6387 Default: 0</p></div><p>
6388 Specifies the number of seconds to wait for the <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> process
6389 to finish before giving up and putting delivery in the background.
6390 </p><p>
6391 Mutt interprets the value of this variable as follows:
6392
6393 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>&gt;0 </td><td>number of seconds to wait for sendmail to finish before continuing
6394 </td></tr><tr><td>0  </td><td>wait forever for sendmail to finish
6395 </td></tr><tr><td>&lt;0 </td><td>always put sendmail in the background without waiting
6396 </td></tr></tbody></table></div><p>
6397 Note that if you specify a value other than 0, the output of the child
6398 process will be put in a temporary file.  If there is some error, you
6399 will be informed as to where to find the output.
6400 </p></div><div class="sect2" title="3.233. shell"><div class="titlepage"><div><div><h3 class="title"><a id="shell"></a>3.233. shell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6401 Default: (empty)</p></div><p>
6402 Command to use when spawning a subshell.  By default, the user's login
6403 shell from <code class="literal">/etc/passwd</code> is used.
6404 </p></div><div class="sect2" title="3.234. sig_dashes"><div class="titlepage"><div><div><h3 class="title"><a id="sig-dashes"></a>3.234. sig_dashes</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6405 Default: yes</p></div><p>
6406 If <span class="emphasis"><em>set</em></span>, a line containing <span class="quote">“<span class="quote">-- </span>”</span> (note the trailing space) will be inserted before your
6407 <a class="link" href="#signature" title="3.236. signature">$signature</a>.  It is <span class="bold"><strong>strongly</strong></span> recommended that you not <span class="emphasis"><em>unset</em></span>
6408 this variable unless your signature contains just your name.  The
6409 reason for this is because many software packages use <span class="quote">“<span class="quote">-- \n</span>”</span> to
6410 detect your signature.  For example, Mutt has the ability to highlight
6411 the signature in a different color in the built-in pager.
6412 </p></div><div class="sect2" title="3.235. sig_on_top"><div class="titlepage"><div><div><h3 class="title"><a id="sig-on-top"></a>3.235. sig_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6413 Default: no</p></div><p>
6414 If <span class="emphasis"><em>set</em></span>, the signature will be included before any quoted or forwarded
6415 text.  It is <span class="bold"><strong>strongly</strong></span> recommended that you do not set this variable
6416 unless you really know what you are doing, and are prepared to take
6417 some heat from netiquette guardians.
6418 </p></div><div class="sect2" title="3.236. signature"><div class="titlepage"><div><div><h3 class="title"><a id="signature"></a>3.236. signature</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6419 Default: <span class="quote">“<span class="quote"><code class="literal">~/.signature</code></span>”</span></p></div><p>
6420 Specifies the filename of your signature, which is appended to all
6421 outgoing messages.   If the filename ends with a pipe (<span class="quote">“<span class="quote">|</span>”</span>), it is
6422 assumed that filename is a shell command and input should be read from
6423 its standard output.
6424 </p></div><div class="sect2" title="3.237. simple_search"><div class="titlepage"><div><div><h3 class="title"><a id="simple-search"></a>3.237. simple_search</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6425 Default: <span class="quote">“<span class="quote"><code class="literal">~f %s | ~s %s</code></span>”</span></p></div><p>
6426 Specifies how Mutt should expand a simple search into a real search
6427 pattern.  A simple search is one that does not contain any of the <span class="quote">“<span class="quote">~</span>”</span> pattern
6428 operators.  See <span class="quote">“<span class="quote"><a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a></span>”</span> for more information on search patterns.
6429 </p><p>
6430 For example, if you simply type <span class="quote">“<span class="quote">joe</span>”</span> at a search or limit prompt, Mutt
6431 will automatically expand it to the value specified by this variable by
6432 replacing <span class="quote">“<span class="quote">%s</span>”</span> with the supplied string.
6433 For the default value, <span class="quote">“<span class="quote">joe</span>”</span> would be expanded to: <span class="quote">“<span class="quote">~f joe | ~s joe</span>”</span>.
6434 </p></div><div class="sect2" title="3.238. sleep_time"><div class="titlepage"><div><div><h3 class="title"><a id="sleep-time"></a>3.238. sleep_time</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6435 Default: 1</p></div><p>
6436 Specifies time, in seconds, to pause while displaying certain informational
6437 messages, while moving from folder to folder and after expunging
6438 messages from the current folder.  The default is to pause one second, so
6439 a value of zero for this option suppresses the pause.
6440 </p></div><div class="sect2" title="3.239. smart_wrap"><div class="titlepage"><div><div><h3 class="title"><a id="smart-wrap"></a>3.239. smart_wrap</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6441 Default: yes</p></div><p>
6442 Controls the display of lines longer than the screen width in the
6443 internal pager. If <span class="emphasis"><em>set</em></span>, long lines are wrapped at a word boundary.  If
6444 <span class="emphasis"><em>unset</em></span>, lines are simply wrapped at the screen edge. Also see the
6445 <a class="link" href="#markers" title="3.125. markers">$markers</a> variable.
6446 </p></div><div class="sect2" title="3.240. smileys"><div class="titlepage"><div><div><h3 class="title"><a id="smileys"></a>3.240. smileys</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
6447 Default: <span class="quote">“<span class="quote"><code class="literal">(&gt;From )|(:[-^]?[][)(&gt;&lt;}{|/DP])</code></span>”</span></p></div><p>
6448 The <span class="emphasis"><em>pager</em></span> uses this variable to catch some common false
6449 positives of <a class="link" href="#quote-regexp" title="3.207. quote_regexp">$quote_regexp</a>, most notably smileys and not consider
6450 a line quoted text if it also matches <a class="link" href="#smileys" title="3.240. smileys">$smileys</a>. This mostly
6451 happens at the beginning of a line.
6452 </p></div><div class="sect2" title="3.241. smime_ask_cert_label"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ask-cert-label"></a>3.241. smime_ask_cert_label</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6453 Default: yes</p></div><p>
6454 This flag controls whether you want to be asked to enter a label
6455 for a certificate about to be added to the database or not. It is
6456 <span class="emphasis"><em>set</em></span> by default.
6457 (S/MIME only)
6458 </p></div><div class="sect2" title="3.242. smime_ca_location"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ca-location"></a>3.242. smime_ca_location</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6459 Default: (empty)</p></div><p>
6460 This variable contains the name of either a directory, or a file which
6461 contains trusted certificates for use with OpenSSL.
6462 (S/MIME only)
6463 </p></div><div class="sect2" title="3.243. smime_certificates"><div class="titlepage"><div><div><h3 class="title"><a id="smime-certificates"></a>3.243. smime_certificates</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6464 Default: (empty)</p></div><p>
6465 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6466 storage and retrieval of keys by itself. This is very basic right
6467 now, and keys and certificates are stored in two different
6468 directories, both named as the hash-value retrieved from
6469 OpenSSL. There is an index file which contains mailbox-address
6470 keyid pairs, and which can be manually edited. This option points to
6471 the location of the certificates.
6472 (S/MIME only)
6473 </p></div><div class="sect2" title="3.244. smime_decrypt_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-command"></a>3.244. smime_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6474 Default: (empty)</p></div><p>
6475 This format string specifies a command which is used to decrypt
6476 <code class="literal">application/x-pkcs7-mime</code> attachments.
6477 </p><p>
6478 The OpenSSL command formats have their own set of <code class="literal">printf(3)</code>-like sequences
6479 similar to PGP's:
6480
6481 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%f </td><td>Expands to the name of a file containing a message.
6482 </td></tr><tr><td>%s </td><td>Expands to the name of a file containing the signature part
6483            of a <code class="literal">multipart/signed</code> attachment when verifying it.
6484 </td></tr><tr><td>%k </td><td>The key-pair specified with <a class="link" href="#smime-default-key" title="3.246. smime_default_key">$smime_default_key</a>
6485 </td></tr><tr><td>%c </td><td>One or more certificate IDs.
6486 </td></tr><tr><td>%a </td><td>The algorithm used for encryption.
6487 </td></tr><tr><td>%C </td><td>CA location:  Depending on whether <a class="link" href="#smime-ca-location" title="3.242. smime_ca_location">$smime_ca_location</a>
6488            points to a directory or file, this expands to
6489            <span class="quote">“<span class="quote">-CApath <a class="link" href="#smime-ca-location" title="3.242. smime_ca_location">$smime_ca_location</a></span>”</span> or <span class="quote">“<span class="quote">-CAfile <a class="link" href="#smime-ca-location" title="3.242. smime_ca_location">$smime_ca_location</a></span>”</span>.
6490 </td></tr></tbody></table></div><p>
6491 For examples on how to configure these formats, see the <code class="literal">smime.rc</code> in
6492 the <code class="literal">samples/</code> subdirectory which has been installed on your system
6493 alongside the documentation.
6494 (S/MIME only)
6495 </p></div><div class="sect2" title="3.245. smime_decrypt_use_default_key"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-use-default-key"></a>3.245. smime_decrypt_use_default_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6496 Default: yes</p></div><p>
6497 If <span class="emphasis"><em>set</em></span> (default) this tells mutt to use the default key for decryption. Otherwise,
6498 if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address
6499 to determine the key to use. It will ask you to supply a key, if it can't find one.
6500 (S/MIME only)
6501 </p></div><div class="sect2" title="3.246. smime_default_key"><div class="titlepage"><div><div><h3 class="title"><a id="smime-default-key"></a>3.246. smime_default_key</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6502 Default: (empty)</p></div><p>
6503 This is the default key-pair to use for signing. This must be set to the
6504 keyid (the hash-value that OpenSSL generates) to work properly
6505 (S/MIME only)
6506 </p></div><div class="sect2" title="3.247. smime_encrypt_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-command"></a>3.247. smime_encrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6507 Default: (empty)</p></div><p>
6508 This command is used to create encrypted S/MIME messages.
6509 </p><p>
6510 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6511 possible <code class="literal">printf(3)</code>-like sequences.
6512 (S/MIME only)
6513 </p></div><div class="sect2" title="3.248. smime_encrypt_with"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-with"></a>3.248. smime_encrypt_with</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6514 Default: (empty)</p></div><p>
6515 This sets the algorithm that should be used for encryption.
6516 Valid choices are <span class="quote">“<span class="quote">des</span>”</span>, <span class="quote">“<span class="quote">des3</span>”</span>, <span class="quote">“<span class="quote">rc2-40</span>”</span>, <span class="quote">“<span class="quote">rc2-64</span>”</span>, <span class="quote">“<span class="quote">rc2-128</span>”</span>.
6517 If <span class="emphasis"><em>unset</em></span>, <span class="quote">“<span class="quote">3des</span>”</span> (TripleDES) is used.
6518 (S/MIME only)
6519 </p></div><div class="sect2" title="3.249. smime_get_cert_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-command"></a>3.249. smime_get_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6520 Default: (empty)</p></div><p>
6521 This command is used to extract X509 certificates from a PKCS7 structure.
6522 </p><p>
6523 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6524 possible <code class="literal">printf(3)</code>-like sequences.
6525 (S/MIME only)
6526 </p></div><div class="sect2" title="3.250. smime_get_cert_email_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-email-command"></a>3.250. smime_get_cert_email_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6527 Default: (empty)</p></div><p>
6528 This command is used to extract the mail address(es) used for storing
6529 X509 certificates, and for verification purposes (to check whether the
6530 certificate was issued for the sender's mailbox).
6531 </p><p>
6532 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6533 possible <code class="literal">printf(3)</code>-like sequences.
6534 (S/MIME only)
6535 </p></div><div class="sect2" title="3.251. smime_get_signer_cert_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-signer-cert-command"></a>3.251. smime_get_signer_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6536 Default: (empty)</p></div><p>
6537 This command is used to extract only the signers X509 certificate from a S/MIME
6538 signature, so that the certificate's owner may get compared to the
6539 email's <span class="quote">“<span class="quote">From:</span>”</span> field.
6540 </p><p>
6541 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6542 possible <code class="literal">printf(3)</code>-like sequences.
6543 (S/MIME only)
6544 </p></div><div class="sect2" title="3.252. smime_import_cert_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-import-cert-command"></a>3.252. smime_import_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6545 Default: (empty)</p></div><p>
6546 This command is used to import a certificate via smime_keys.
6547 </p><p>
6548 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6549 possible <code class="literal">printf(3)</code>-like sequences.
6550 (S/MIME only)
6551 </p></div><div class="sect2" title="3.253. smime_is_default"><div class="titlepage"><div><div><h3 class="title"><a id="smime-is-default"></a>3.253. smime_is_default</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6552 Default: no</p></div><p>
6553 The default behavior of mutt is to use PGP on all auto-sign/encryption
6554 operations. To override and to use OpenSSL instead this must be <span class="emphasis"><em>set</em></span>.
6555 However, this has no effect while replying, since mutt will automatically
6556 select the same application that was used to sign/encrypt the original
6557 message.  (Note that this variable can be overridden by unsetting <a class="link" href="#crypt-autosmime" title="3.39. crypt_autosmime">$crypt_autosmime</a>.)
6558 (S/MIME only)
6559 </p></div><div class="sect2" title="3.254. smime_keys"><div class="titlepage"><div><div><h3 class="title"><a id="smime-keys"></a>3.254. smime_keys</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6560 Default: (empty)</p></div><p>
6561 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
6562 storage and retrieval of keys/certs by itself. This is very basic right now,
6563 and stores keys and certificates in two different directories, both
6564 named as the hash-value retrieved from OpenSSL. There is an index file
6565 which contains mailbox-address keyid pair, and which can be manually
6566 edited. This option points to the location of the private keys.
6567 (S/MIME only)
6568 </p></div><div class="sect2" title="3.255. smime_pk7out_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-pk7out-command"></a>3.255. smime_pk7out_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6569 Default: (empty)</p></div><p>
6570 This command is used to extract PKCS7 structures of S/MIME signatures,
6571 in order to extract the public X509 certificate(s).
6572 </p><p>
6573 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6574 possible <code class="literal">printf(3)</code>-like sequences.
6575 (S/MIME only)
6576 </p></div><div class="sect2" title="3.256. smime_sign_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-command"></a>3.256. smime_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6577 Default: (empty)</p></div><p>
6578 This command is used to created S/MIME signatures of type
6579 <code class="literal">multipart/signed</code>, which can be read by all mail clients.
6580 </p><p>
6581 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6582 possible <code class="literal">printf(3)</code>-like sequences.
6583 (S/MIME only)
6584 </p></div><div class="sect2" title="3.257. smime_sign_opaque_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-opaque-command"></a>3.257. smime_sign_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6585 Default: (empty)</p></div><p>
6586 This command is used to created S/MIME signatures of type
6587 <code class="literal">application/x-pkcs7-signature</code>, which can only be handled by mail
6588 clients supporting the S/MIME extension.
6589 </p><p>
6590 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6591 possible <code class="literal">printf(3)</code>-like sequences.
6592 (S/MIME only)
6593 </p></div><div class="sect2" title="3.258. smime_timeout"><div class="titlepage"><div><div><h3 class="title"><a id="smime-timeout"></a>3.258. smime_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6594 Default: 300</p></div><p>
6595 The number of seconds after which a cached passphrase will expire if
6596 not used.
6597 (S/MIME only)
6598 </p></div><div class="sect2" title="3.259. smime_verify_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-command"></a>3.259. smime_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6599 Default: (empty)</p></div><p>
6600 This command is used to verify S/MIME signatures of type <code class="literal">multipart/signed</code>.
6601 </p><p>
6602 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6603 possible <code class="literal">printf(3)</code>-like sequences.
6604 (S/MIME only)
6605 </p></div><div class="sect2" title="3.260. smime_verify_opaque_command"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-opaque-command"></a>3.260. smime_verify_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6606 Default: (empty)</p></div><p>
6607 This command is used to verify S/MIME signatures of type
6608 <code class="literal">application/x-pkcs7-mime</code>.
6609 </p><p>
6610 This is a format string, see the <a class="link" href="#smime-decrypt-command" title="3.244. smime_decrypt_command">$smime_decrypt_command</a> command for
6611 possible <code class="literal">printf(3)</code>-like sequences.
6612 (S/MIME only)
6613 </p></div><div class="sect2" title="3.261. smtp_authenticators"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-authenticators"></a>3.261. smtp_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6614 Default: (empty)</p></div><p>
6615 This is a colon-delimited list of authentication methods mutt may
6616 attempt to use to log in to an SMTP server, in the order mutt should
6617 try them.  Authentication methods are any SASL mechanism, e.g.
6618 <span class="quote">“<span class="quote">digest-md5</span>”</span>, <span class="quote">“<span class="quote">gssapi</span>”</span> or <span class="quote">“<span class="quote">cram-md5</span>”</span>.
6619 This option is case-insensitive. If it is <span class="quote">“<span class="quote">unset</span>”</span>
6620 (the default) mutt will try all available methods, in order from
6621 most-secure to least-secure.
6622 </p><p>
6623 Example:
6624
6625 </p><pre class="screen">
6626 set smtp_authenticators="digest-md5:cram-md5"
6627 </pre></div><div class="sect2" title="3.262. smtp_pass"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-pass"></a>3.262. smtp_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6628 Default: (empty)</p></div><p>
6629 Specifies the password for your SMTP account.  If <span class="emphasis"><em>unset</em></span>, Mutt will
6630 prompt you for your password when you first send mail via SMTP.
6631 See <a class="link" href="#smtp-url" title="3.263. smtp_url">$smtp_url</a> to configure mutt to send mail via SMTP.
6632 </p><p>
6633 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
6634 fairly secure machine, because the superuser can read your muttrc even
6635 if you are the only one who can read the file.
6636 </p></div><div class="sect2" title="3.263. smtp_url"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-url"></a>3.263. smtp_url</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6637 Default: (empty)</p></div><p>
6638 Defines the SMTP smarthost where sent messages should relayed for
6639 delivery. This should take the form of an SMTP URL, e.g.:
6640
6641 </p><pre class="screen">
6642 smtp[s]://[user[:pass]@]host[:port]
6643 </pre><p>
6644 where <span class="quote">“<span class="quote">[...]</span>”</span> denotes an optional part.
6645 Setting this variable overrides the value of the <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a>
6646 variable.
6647 </p></div><div class="sect2" title="3.264. sort"><div class="titlepage"><div><div><h3 class="title"><a id="sort"></a>3.264. sort</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6648 Default: date</p></div><p>
6649 Specifies how to sort messages in the <span class="quote">“<span class="quote">index</span>”</span> menu.  Valid values
6650 are:
6651
6652 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>date or date-sent
6653 </p></li><li class="listitem"><p>date-received
6654 </p></li><li class="listitem"><p>from
6655 </p></li><li class="listitem"><p>mailbox-order (unsorted)
6656 </p></li><li class="listitem"><p>score
6657 </p></li><li class="listitem"><p>size
6658 </p></li><li class="listitem"><p>spam
6659 </p></li><li class="listitem"><p>subject
6660 </p></li><li class="listitem"><p>threads
6661 </p></li><li class="listitem"><p>to
6662 </p></li></ul></div><p>
6663 You may optionally use the <span class="quote">“<span class="quote">reverse-</span>”</span> prefix to specify reverse sorting
6664 order (example: <span class="quote">“<span class="quote"><code class="literal">set sort=reverse-date-sent</code></span>”</span>).
6665 </p></div><div class="sect2" title="3.265. sort_alias"><div class="titlepage"><div><div><h3 class="title"><a id="sort-alias"></a>3.265. sort_alias</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6666 Default: alias</p></div><p>
6667 Specifies how the entries in the <span class="quote">“<span class="quote">alias</span>”</span> menu are sorted.  The
6668 following are legal values:
6669
6670 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>address (sort alphabetically by email address)
6671 </p></li><li class="listitem"><p>alias (sort alphabetically by alias name)
6672 </p></li><li class="listitem"><p>unsorted (leave in order specified in .muttrc)
6673 </p></li></ul></div></div><div class="sect2" title="3.266. sort_aux"><div class="titlepage"><div><div><h3 class="title"><a id="sort-aux"></a>3.266. sort_aux</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6674 Default: date</p></div><p>
6675 When sorting by threads, this variable controls how threads are sorted
6676 in relation to other threads, and how the branches of the thread trees
6677 are sorted.  This can be set to any value that <a class="link" href="#sort" title="3.264. sort">$sort</a> can, except
6678 <span class="quote">“<span class="quote">threads</span>”</span> (in that case, mutt will just use <span class="quote">“<span class="quote">date-sent</span>”</span>).  You can also
6679 specify the <span class="quote">“<span class="quote">last-</span>”</span> prefix in addition to the <span class="quote">“<span class="quote">reverse-</span>”</span> prefix, but <span class="quote">“<span class="quote">last-</span>”</span>
6680 must come after <span class="quote">“<span class="quote">reverse-</span>”</span>.  The <span class="quote">“<span class="quote">last-</span>”</span> prefix causes messages to be
6681 sorted against its siblings by which has the last descendant, using
6682 the rest of <a class="link" href="#sort-aux" title="3.266. sort_aux">$sort_aux</a> as an ordering.  For instance,
6683
6684 </p><pre class="screen">
6685 set sort_aux=last-date-received
6686 </pre><p>
6687 would mean that if a new message is received in a
6688 thread, that thread becomes the last one displayed (or the first, if
6689 you have <span class="quote">“<span class="quote"><code class="literal">set sort=reverse-threads</code></span>”</span>.)
6690 </p><p>
6691 Note: For reversed <a class="link" href="#sort" title="3.264. sort">$sort</a>
6692 order <a class="link" href="#sort-aux" title="3.266. sort_aux">$sort_aux</a> is reversed again (which is not the right thing to do,
6693 but kept to not break any existing configuration setting).
6694 </p></div><div class="sect2" title="3.267. sort_browser"><div class="titlepage"><div><div><h3 class="title"><a id="sort-browser"></a>3.267. sort_browser</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
6695 Default: alpha</p></div><p>
6696 Specifies how to sort entries in the file browser.  By default, the
6697 entries are sorted alphabetically.  Valid values:
6698
6699 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>alpha (alphabetically)
6700 </p></li><li class="listitem"><p>date
6701 </p></li><li class="listitem"><p>size
6702 </p></li><li class="listitem"><p>unsorted
6703 </p></li></ul></div><p>
6704 You may optionally use the <span class="quote">“<span class="quote">reverse-</span>”</span> prefix to specify reverse sorting
6705 order (example: <span class="quote">“<span class="quote"><code class="literal">set sort_browser=reverse-date</code></span>”</span>).
6706 </p></div><div class="sect2" title="3.268. sort_re"><div class="titlepage"><div><div><h3 class="title"><a id="sort-re"></a>3.268. sort_re</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6707 Default: yes</p></div><p>
6708 This variable is only useful when sorting by threads with
6709 <a class="link" href="#strict-threads" title="3.285. strict_threads">$strict_threads</a> <span class="emphasis"><em>unset</em></span>.  In that case, it changes the heuristic
6710 mutt uses to thread messages by subject.  With <a class="link" href="#sort-re" title="3.268. sort_re">$sort_re</a> <span class="emphasis"><em>set</em></span>, mutt will
6711 only attach a message as the child of another message by subject if
6712 the subject of the child message starts with a substring matching the
6713 setting of <a class="link" href="#reply-regexp" title="3.213. reply_regexp">$reply_regexp</a>.  With <a class="link" href="#sort-re" title="3.268. sort_re">$sort_re</a> <span class="emphasis"><em>unset</em></span>, mutt will attach
6714 the message whether or not this is the case, as long as the
6715 non-<a class="link" href="#reply-regexp" title="3.213. reply_regexp">$reply_regexp</a> parts of both messages are identical.
6716 </p></div><div class="sect2" title="3.269. spam_separator"><div class="titlepage"><div><div><h3 class="title"><a id="spam-separator"></a>3.269. spam_separator</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6717 Default: <span class="quote">“<span class="quote"><code class="literal">,</code></span>”</span></p></div><p>
6718 This variable controls what happens when multiple spam headers
6719 are matched: if <span class="emphasis"><em>unset</em></span>, each successive header will overwrite any
6720 previous matches value for the spam label. If <span class="emphasis"><em>set</em></span>, each successive
6721 match will append to the previous, using this variable's value as a
6722 separator.
6723 </p></div><div class="sect2" title="3.270. spoolfile"><div class="titlepage"><div><div><h3 class="title"><a id="spoolfile"></a>3.270. spoolfile</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6724 Default: (empty)</p></div><p>
6725 If your spool mailbox is in a non-default place where Mutt cannot find
6726 it, you can specify its location with this variable.  Mutt will
6727 initially set this variable to the value of the environment
6728 variable <code class="literal">$MAIL</code> or <code class="literal">$MAILDIR</code> if either is defined.
6729 </p></div><div class="sect2" title="3.271. ssl_ca_certificates_file"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-ca-certificates-file"></a>3.271. ssl_ca_certificates_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6730 Default: (empty)</p></div><p>
6731 This variable specifies a file containing trusted CA certificates.
6732 Any server certificate that is signed with one of these CA
6733 certificates is also automatically accepted.
6734 </p><p>
6735 Example:
6736
6737 </p><pre class="screen">
6738 set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
6739 </pre></div><div class="sect2" title="3.272. ssl_client_cert"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-client-cert"></a>3.272. ssl_client_cert</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6740 Default: (empty)</p></div><p>
6741 The file containing a client certificate and its associated private
6742 key.
6743 </p></div><div class="sect2" title="3.273. ssl_force_tls"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-force-tls"></a>3.273. ssl_force_tls</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6744 Default: no</p></div><p>
6745 If this variable is <span class="emphasis"><em>set</em></span>, Mutt will require that all connections
6746 to remote servers be encrypted. Furthermore it will attempt to
6747 negotiate TLS even if the server does not advertise the capability,
6748 since it would otherwise have to abort the connection anyway. This
6749 option supersedes <a class="link" href="#ssl-starttls" title="3.275. ssl_starttls">$ssl_starttls</a>.
6750 </p></div><div class="sect2" title="3.274. ssl_min_dh_prime_bits"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-min-dh-prime-bits"></a>3.274. ssl_min_dh_prime_bits</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6751 Default: 0</p></div><p>
6752 This variable specifies the minimum acceptable prime size (in bits)
6753 for use in any Diffie-Hellman key exchange. A value of 0 will use
6754 the default from the GNUTLS library.
6755 </p></div><div class="sect2" title="3.275. ssl_starttls"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-starttls"></a>3.275. ssl_starttls</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
6756 Default: yes</p></div><p>
6757 If <span class="emphasis"><em>set</em></span> (the default), mutt will attempt to use <code class="literal">STARTTLS</code> on servers
6758 advertising the capability. When <span class="emphasis"><em>unset</em></span>, mutt will not attempt to
6759 use <code class="literal">STARTTLS</code> regardless of the server's capabilities.
6760 </p></div><div class="sect2" title="3.276. ssl_use_sslv2"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv2"></a>3.276. ssl_use_sslv2</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6761 Default: no</p></div><p>
6762 This variable specifies whether to attempt to use SSLv2 in the
6763 SSL authentication process.
6764 </p></div><div class="sect2" title="3.277. ssl_use_sslv3"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv3"></a>3.277. ssl_use_sslv3</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6765 Default: yes</p></div><p>
6766 This variable specifies whether to attempt to use SSLv3 in the
6767 SSL authentication process.
6768 </p></div><div class="sect2" title="3.278. ssl_use_tlsv1"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-tlsv1"></a>3.278. ssl_use_tlsv1</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6769 Default: yes</p></div><p>
6770 This variable specifies whether to attempt to use TLSv1 in the
6771 SSL authentication process.
6772 </p></div><div class="sect2" title="3.279. ssl_usesystemcerts"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-usesystemcerts"></a>3.279. ssl_usesystemcerts</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6773 Default: yes</p></div><p>
6774 If set to <span class="emphasis"><em>yes</em></span>, mutt will use CA certificates in the
6775 system-wide certificate store when checking if a server certificate
6776 is signed by a trusted CA.
6777 </p></div><div class="sect2" title="3.280. ssl_verify_dates"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-verify-dates"></a>3.280. ssl_verify_dates</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6778 Default: yes</p></div><p>
6779 If <span class="emphasis"><em>set</em></span> (the default), mutt will not automatically accept a server
6780 certificate that is either not yet valid or already expired. You should
6781 only unset this for particular known hosts, using the
6782 <code class="literal"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts">&lt;account-hook&gt;</a></code> function.
6783 </p></div><div class="sect2" title="3.281. ssl_verify_host"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-verify-host"></a>3.281. ssl_verify_host</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6784 Default: yes</p></div><p>
6785 If <span class="emphasis"><em>set</em></span> (the default), mutt will not automatically accept a server
6786 certificate whose host name does not match the host used in your folder
6787 URL. You should only unset this for particular known hosts, using
6788 the <code class="literal"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts">&lt;account-hook&gt;</a></code> function.
6789 </p></div><div class="sect2" title="3.282. status_chars"><div class="titlepage"><div><div><h3 class="title"><a id="status-chars"></a>3.282. status_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6790 Default: <span class="quote">“<span class="quote"><code class="literal">-*%A</code></span>”</span></p></div><p>
6791 Controls the characters used by the <span class="quote">“<span class="quote">%r</span>”</span> indicator in
6792 <a class="link" href="#status-format" title="3.283. status_format">$status_format</a>. The first character is used when the mailbox is
6793 unchanged. The second is used when the mailbox has been changed, and
6794 it needs to be resynchronized. The third is used if the mailbox is in
6795 read-only mode, or if the mailbox will not be written when exiting
6796 that mailbox (You can toggle whether to write changes to a mailbox
6797 with the <code class="literal">&lt;toggle-write&gt;</code> operation, bound by default to <span class="quote">“<span class="quote">%</span>”</span>). The fourth
6798 is used to indicate that the current folder has been opened in attach-
6799 message mode (Certain operations like composing a new mail, replying,
6800 forwarding, etc. are not permitted in this mode).
6801 </p></div><div class="sect2" title="3.283. status_format"><div class="titlepage"><div><div><h3 class="title"><a id="status-format"></a>3.283. status_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6802 Default: <span class="quote">“<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)-%&gt;-(%P)---</code></span>”</span></p></div><p>
6803 Controls the format of the status line displayed in the <span class="quote">“<span class="quote">index</span>”</span>
6804 menu.  This string is similar to <a class="link" href="#index-format" title="3.114. index_format">$index_format</a>, but has its own
6805 set of <code class="literal">printf(3)</code>-like sequences:
6806
6807 </p><div class="informaltable"><table border="1"><colgroup><col /><col /></colgroup><tbody><tr><td>%b  </td><td>number of mailboxes with new mail *
6808 </td></tr><tr><td>%d  </td><td>number of deleted messages *
6809 </td></tr><tr><td>%f  </td><td>the full pathname of the current mailbox
6810 </td></tr><tr><td>%F  </td><td>number of flagged messages *
6811 </td></tr><tr><td>%h  </td><td>local hostname
6812 </td></tr><tr><td>%l  </td><td>size (in bytes) of the current mailbox *
6813 </td></tr><tr><td>%L  </td><td>size (in bytes) of the messages shown
6814 (i.e., which match the current limit) *
6815 </td></tr><tr><td>%m  </td><td>the number of messages in the mailbox *
6816 </td></tr><tr><td>%M  </td><td>the number of messages shown (i.e., which match the current limit) *
6817 </td></tr><tr><td>%n  </td><td>number of new messages in the mailbox *
6818 </td></tr><tr><td>%o  </td><td>number of old unread messages *
6819 </td></tr><tr><td>%p  </td><td>number of postponed messages *
6820 </td></tr><tr><td>%P  </td><td>percentage of the way through the index
6821 </td></tr><tr><td>%r  </td><td>modified/read-only/won't-write/attach-message indicator,
6822 according to <a class="link" href="#status-chars" title="3.282. status_chars">$status_chars</a>
6823 </td></tr><tr><td>%s  </td><td>current sorting mode (<a class="link" href="#sort" title="3.264. sort">$sort</a>)
6824 </td></tr><tr><td>%S  </td><td>current aux sorting method (<a class="link" href="#sort-aux" title="3.266. sort_aux">$sort_aux</a>)
6825 </td></tr><tr><td>%t  </td><td>number of tagged messages *
6826 </td></tr><tr><td>%u  </td><td>number of unread messages *
6827 </td></tr><tr><td>%v  </td><td>Mutt version string
6828 </td></tr><tr><td>%V  </td><td>currently active limit pattern, if any *
6829 </td></tr><tr><td>%&gt;X </td><td>right justify the rest of the string and pad with <span class="quote">“<span class="quote">X</span>”</span>
6830 </td></tr><tr><td>%|X </td><td>pad to the end of the line with <span class="quote">“<span class="quote">X</span>”</span>
6831 </td></tr><tr><td>%*X </td><td>soft-fill with character <span class="quote">“<span class="quote">X</span>”</span> as pad
6832 </td></tr></tbody></table></div><p>
6833 For an explanation of <span class="quote">“<span class="quote">soft-fill</span>”</span>, see the <a class="link" href="#index-format" title="3.114. index_format">$index_format</a> documentation.
6834 </p><p>
6835 * = can be optionally printed if nonzero
6836 </p><p>
6837 Some of the above sequences can be used to optionally print a string
6838 if their value is nonzero.  For example, you may only want to see the
6839 number of flagged messages if such messages exist, since zero is not
6840 particularly meaningful.  To optionally print a string based upon one
6841 of the above sequences, the following construct is used:
6842 </p><p>
6843 <code class="literal">%?&lt;sequence_char&gt;?&lt;optional_string&gt;?</code>
6844 </p><p>
6845 where <span class="emphasis"><em>sequence_char</em></span> is a character from the table above, and
6846 <span class="emphasis"><em>optional_string</em></span> is the string you would like printed if
6847 <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
6848 other sequences as well as normal text, but you may <span class="bold"><strong>not</strong></span> nest
6849 optional strings.
6850 </p><p>
6851 Here is an example illustrating how to optionally print the number of
6852 new messages in a mailbox:
6853 </p><p>
6854 <code class="literal">%?n?%n new messages.?</code>
6855 </p><p>
6856 You can also switch between two strings using the following construct:
6857 </p><p>
6858 <code class="literal">%?&lt;sequence_char&gt;?&lt;if_string&gt;&amp;&lt;else_string&gt;?</code>
6859 </p><p>
6860 If the value of <span class="emphasis"><em>sequence_char</em></span> is non-zero, <span class="emphasis"><em>if_string</em></span> will
6861 be expanded, otherwise <span class="emphasis"><em>else_string</em></span> will be expanded.
6862 </p><p>
6863 You can force the result of any <code class="literal">printf(3)</code>-like sequence to be lowercase
6864 by prefixing the sequence character with an underscore (<span class="quote">“<span class="quote">_</span>”</span>) sign.
6865 For example, if you want to display the local hostname in lowercase,
6866 you would use: <span class="quote">“<span class="quote"><code class="literal">%_h</code></span>”</span>.
6867 </p><p>
6868 If you prefix the sequence character with a colon (<span class="quote">“<span class="quote">:</span>”</span>) character, mutt
6869 will replace any dots in the expansion by underscores. This might be helpful
6870 with IMAP folders that don't like dots in folder names.
6871 </p></div><div class="sect2" title="3.284. status_on_top"><div class="titlepage"><div><div><h3 class="title"><a id="status-on-top"></a>3.284. status_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6872 Default: no</p></div><p>
6873 Setting this variable causes the <span class="quote">“<span class="quote">status bar</span>”</span> to be displayed on
6874 the first line of the screen rather than near the bottom. If <a class="link" href="#help" title="3.82. help">$help</a>
6875 is <span class="emphasis"><em>set</em></span>, too it'll be placed at the bottom.
6876 </p></div><div class="sect2" title="3.285. strict_threads"><div class="titlepage"><div><div><h3 class="title"><a id="strict-threads"></a>3.285. strict_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6877 Default: no</p></div><p>
6878 If <span class="emphasis"><em>set</em></span>, threading will only make use of the <span class="quote">“<span class="quote">In-Reply-To</span>”</span> and
6879 <span class="quote">“<span class="quote">References:</span>”</span> fields when you <a class="link" href="#sort" title="3.264. sort">$sort</a> by message threads.  By
6880 default, messages with the same subject are grouped together in
6881 <span class="quote">“<span class="quote">pseudo threads.</span>”</span>. This may not always be desirable, such as in a
6882 personal mailbox where you might have several unrelated messages with
6883 the subjects like <span class="quote">“<span class="quote">hi</span>”</span> which will get grouped together. See also
6884 <a class="link" href="#sort-re" title="3.268. sort_re">$sort_re</a> for a less drastic way of controlling this
6885 behavior.
6886 </p></div><div class="sect2" title="3.286. suspend"><div class="titlepage"><div><div><h3 class="title"><a id="suspend"></a>3.286. suspend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6887 Default: yes</p></div><p>
6888 When <span class="emphasis"><em>unset</em></span>, mutt won't stop when the user presses the terminal's
6889 <span class="emphasis"><em>susp</em></span> key, usually <span class="quote">“<span class="quote">^Z</span>”</span>. This is useful if you run mutt
6890 inside an xterm using a command like <span class="quote">“<span class="quote"><code class="literal">xterm -e mutt</code></span>”</span>.
6891 </p></div><div class="sect2" title="3.287. text_flowed"><div class="titlepage"><div><div><h3 class="title"><a id="text-flowed"></a>3.287. text_flowed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6892 Default: no</p></div><p>
6893 When <span class="emphasis"><em>set</em></span>, mutt will generate <span class="quote">“<span class="quote">format=flowed</span>”</span> bodies with a content type
6894 of <span class="quote">“<span class="quote"><code class="literal">text/plain; format=flowed</code></span>”</span>.
6895 This format is easier to handle for some mailing software, and generally
6896 just looks like ordinary text.  To actually make use of this format's
6897 features, you'll need support in your editor.
6898 </p><p>
6899 Note that <a class="link" href="#indent-string" title="3.113. indent_string">$indent_string</a> is ignored when this option is <span class="emphasis"><em>set</em></span>.
6900 </p></div><div class="sect2" title="3.288. thorough_search"><div class="titlepage"><div><div><h3 class="title"><a id="thorough-search"></a>3.288. thorough_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6901 Default: yes</p></div><p>
6902 Affects the <code class="literal">~b</code> and <code class="literal">~h</code> search operations described in
6903 section <span class="quote">“<span class="quote"><a class="link" href="#patterns" title="3. Patterns: Searching, Limiting and Tagging">patterns</a></span>”</span>.  If <span class="emphasis"><em>set</em></span>, the headers and body/attachments of
6904 messages to be searched are decoded before searching. If <span class="emphasis"><em>unset</em></span>,
6905 messages are searched as they appear in the folder.
6906 </p><p>
6907 Users searching attachments or for non-ASCII characters should <span class="emphasis"><em>set</em></span>
6908 this value because decoding also includes MIME parsing/decoding and possible
6909 character set conversions. Otherwise mutt will attempt to match against the
6910 raw message received (for example quoted-printable encoded or with encoded
6911 headers) which may lead to incorrect search results.
6912 </p></div><div class="sect2" title="3.289. thread_received"><div class="titlepage"><div><div><h3 class="title"><a id="thread-received"></a>3.289. thread_received</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6913 Default: no</p></div><p>
6914 When <span class="emphasis"><em>set</em></span>, mutt uses the date received rather than the date sent
6915 to thread messages by subject.
6916 </p></div><div class="sect2" title="3.290. tilde"><div class="titlepage"><div><div><h3 class="title"><a id="tilde"></a>3.290. tilde</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6917 Default: no</p></div><p>
6918 When <span class="emphasis"><em>set</em></span>, the internal-pager will pad blank lines to the bottom of the
6919 screen with a tilde (<span class="quote">“<span class="quote">~</span>”</span>).
6920 </p></div><div class="sect2" title="3.291. time_inc"><div class="titlepage"><div><div><h3 class="title"><a id="time-inc"></a>3.291. time_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6921 Default: 0</p></div><p>
6922 Along with <a class="link" href="#read-inc" title="3.208. read_inc">$read_inc</a>, <a class="link" href="#write-inc" title="3.312. write_inc">$write_inc</a>, and <a class="link" href="#net-inc" title="3.148. net_inc">$net_inc</a>, this
6923 variable controls the frequency with which progress updates are
6924 displayed. It suppresses updates less than <a class="link" href="#time-inc" title="3.291. time_inc">$time_inc</a> milliseconds
6925 apart. This can improve throughput on systems with slow terminals,
6926 or when running mutt on a remote system.
6927 </p><p>
6928 Also see the <span class="quote">“<span class="quote"><a class="link" href="#tuning" title="Chapter 8. Performance Tuning">tuning</a></span>”</span> section of the manual for performance considerations.
6929 </p></div><div class="sect2" title="3.292. timeout"><div class="titlepage"><div><div><h3 class="title"><a id="timeout"></a>3.292. timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
6930 Default: 600</p></div><p>
6931 When Mutt is waiting for user input either idling in menus or
6932 in an interactive prompt, Mutt would block until input is
6933 present. Depending on the context, this would prevent certain
6934 operations from working, like checking for new mail or keeping
6935 an IMAP connection alive.
6936 </p><p>
6937 This variable controls how many seconds Mutt will at most wait
6938 until it aborts waiting for input, performs these operations and
6939 continues to wait for input.
6940 </p><p>
6941 A value of zero or less will cause Mutt to never time out.
6942 </p></div><div class="sect2" title="3.293. tmpdir"><div class="titlepage"><div><div><h3 class="title"><a id="tmpdir"></a>3.293. tmpdir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
6943 Default: (empty)</p></div><p>
6944 This variable allows you to specify where Mutt will place its
6945 temporary files needed for displaying and composing messages.  If
6946 this variable is not set, the environment variable <code class="literal">$TMPDIR</code> is
6947 used.  If <code class="literal">$TMPDIR</code> is not set then <span class="quote">“<span class="quote"><code class="literal">/tmp</code></span>”</span> is used.
6948 </p></div><div class="sect2" title="3.294. to_chars"><div class="titlepage"><div><div><h3 class="title"><a id="to-chars"></a>3.294. to_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6949 Default: <span class="quote">“<span class="quote"><code class="literal"> +TCFL</code></span>”</span></p></div><p>
6950 Controls the character used to indicate mail addressed to you.  The
6951 first character is the one used when the mail is <span class="emphasis"><em>not</em></span> addressed to your
6952 address.  The second is used when you are the only
6953 recipient of the message.  The third is when your address
6954 appears in the <span class="quote">“<span class="quote">To:</span>”</span> header field, but you are not the only recipient of
6955 the message.  The fourth character is used when your
6956 address is specified in the <span class="quote">“<span class="quote">Cc:</span>”</span> header field, but you are not the only
6957 recipient.  The fifth character is used to indicate mail that was sent
6958 by <span class="emphasis"><em>you</em></span>.  The sixth character is used to indicate when a mail
6959 was sent to a mailing-list you subscribe to.
6960 </p></div><div class="sect2" title="3.295. tunnel"><div class="titlepage"><div><div><h3 class="title"><a id="tunnel"></a>3.295. tunnel</h3></div></div></div><div class="literallayout"><p>Type: string<br />
6961 Default: (empty)</p></div><p>
6962 Setting this variable will cause mutt to open a pipe to a command
6963 instead of a raw socket. You may be able to use this to set up
6964 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
6965
6966 </p><pre class="screen">
6967 set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
6968 </pre><p>
6969 Note: For this example to work you must be able to log in to the remote
6970 machine without having to enter a password.
6971 </p><p>
6972 When set, Mutt uses the tunnel for all remote connections.
6973 Please see <span class="quote">“<span class="quote"><a class="link" href="#account-hook" title="6. Managing Multiple Accounts">account-hook</a></span>”</span> in the manual for how to use different
6974 tunnel commands per connection.
6975 </p></div><div class="sect2" title="3.296. uncollapse_jump"><div class="titlepage"><div><div><h3 class="title"><a id="uncollapse-jump"></a>3.296. uncollapse_jump</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6976 Default: no</p></div><p>
6977 When <span class="emphasis"><em>set</em></span>, Mutt will jump to the next unread message, if any,
6978 when the current thread is <span class="emphasis"><em>un</em></span>collapsed.
6979 </p></div><div class="sect2" title="3.297. use_8bitmime"><div class="titlepage"><div><div><h3 class="title"><a id="use-8bitmime"></a>3.297. use_8bitmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6980 Default: no</p></div><p>
6981 <span class="bold"><strong>Warning:</strong></span> do not set this variable unless you are using a version
6982 of sendmail which supports the <code class="literal">-B8BITMIME</code> flag (such as sendmail
6983 8.8.x) or you may not be able to send mail.
6984 </p><p>
6985 When <span class="emphasis"><em>set</em></span>, Mutt will invoke <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> with the <code class="literal">-B8BITMIME</code>
6986 flag when sending 8-bit messages to enable ESMTP negotiation.
6987 </p></div><div class="sect2" title="3.298. use_domain"><div class="titlepage"><div><div><h3 class="title"><a id="use-domain"></a>3.298. use_domain</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6988 Default: yes</p></div><p>
6989 When <span class="emphasis"><em>set</em></span>, Mutt will qualify all local addresses (ones without the
6990 <span class="quote">“<span class="quote">@host</span>”</span> portion) with the value of <a class="link" href="#hostname" title="3.93. hostname">$hostname</a>.  If <span class="emphasis"><em>unset</em></span>, no
6991 addresses will be qualified.
6992 </p></div><div class="sect2" title="3.299. use_envelope_from"><div class="titlepage"><div><div><h3 class="title"><a id="use-envelope-from"></a>3.299. use_envelope_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
6993 Default: no</p></div><p>
6994 When <span class="emphasis"><em>set</em></span>, mutt will set the <span class="emphasis"><em>envelope</em></span> sender of the message.
6995 If <a class="link" href="#envelope-from-address" title="3.61. envelope_from_address">$envelope_from_address</a> is <span class="emphasis"><em>set</em></span>, it will be used as the sender
6996 address. If <span class="emphasis"><em>unset</em></span>, mutt will attempt to derive the sender from the
6997 <span class="quote">“<span class="quote">From:</span>”</span> header.
6998 </p><p>
6999 Note that this information is passed to sendmail command using the
7000 <code class="literal">-f</code> command line switch. Therefore setting this option is not useful
7001 if the <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> variable already contains <code class="literal">-f</code> or if the
7002 executable pointed to by <a class="link" href="#sendmail" title="3.231. sendmail">$sendmail</a> doesn't support the <code class="literal">-f</code> switch.
7003 </p></div><div class="sect2" title="3.300. use_from"><div class="titlepage"><div><div><h3 class="title"><a id="use-from"></a>3.300. use_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7004 Default: yes</p></div><p>
7005 When <span class="emphasis"><em>set</em></span>, Mutt will generate the <span class="quote">“<span class="quote">From:</span>”</span> header field when
7006 sending messages.  If <span class="emphasis"><em>unset</em></span>, no <span class="quote">“<span class="quote">From:</span>”</span> header field will be
7007 generated unless the user explicitly sets one using the <span class="quote">“<span class="quote"><a class="link" href="#my-hdr" title="15. User-Defined Headers">my_hdr</a></span>”</span>
7008 command.
7009 </p></div><div class="sect2" title="3.301. use_idn"><div class="titlepage"><div><div><h3 class="title"><a id="use-idn"></a>3.301. use_idn</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7010 Default: yes</p></div><p>
7011 When <span class="emphasis"><em>set</em></span>, Mutt will show you international domain names decoded.
7012 Note: You can use IDNs for addresses even if this is <span class="emphasis"><em>unset</em></span>.
7013 This variable only affects decoding.
7014 </p></div><div class="sect2" title="3.302. use_ipv6"><div class="titlepage"><div><div><h3 class="title"><a id="use-ipv6"></a>3.302. use_ipv6</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7015 Default: yes</p></div><p>
7016 When <span class="emphasis"><em>set</em></span>, Mutt will look for IPv6 addresses of hosts it tries to
7017 contact.  If this option is <span class="emphasis"><em>unset</em></span>, Mutt will restrict itself to IPv4 addresses.
7018 Normally, the default should work.
7019 </p></div><div class="sect2" title="3.303. user_agent"><div class="titlepage"><div><div><h3 class="title"><a id="user-agent"></a>3.303. user_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7020 Default: yes</p></div><p>
7021 When <span class="emphasis"><em>set</em></span>, mutt will add a <span class="quote">“<span class="quote">User-Agent:</span>”</span> header to outgoing
7022 messages, indicating which version of mutt was used for composing
7023 them.
7024 </p></div><div class="sect2" title="3.304. visual"><div class="titlepage"><div><div><h3 class="title"><a id="visual"></a>3.304. visual</h3></div></div></div><div class="literallayout"><p>Type: path<br />
7025 Default: (empty)</p></div><p>
7026 Specifies the visual editor to invoke when the <span class="quote">“<span class="quote"><code class="literal">~v</code></span>”</span> command is
7027 given in the built-in editor.
7028 </p></div><div class="sect2" title="3.305. wait_key"><div class="titlepage"><div><div><h3 class="title"><a id="wait-key"></a>3.305. wait_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7029 Default: yes</p></div><p>
7030 Controls whether Mutt will ask you to press a key after an external command
7031 has been invoked by these functions: <code class="literal">&lt;shell-escape&gt;</code>,
7032 <code class="literal">&lt;pipe-message&gt;</code>, <code class="literal">&lt;pipe-entry&gt;</code>, <code class="literal">&lt;print-message&gt;</code>,
7033 and <code class="literal">&lt;print-entry&gt;</code> commands.
7034 </p><p>
7035 It is also used when viewing attachments with <span class="quote">“<span class="quote"><a class="link" href="#auto-view" title="4. MIME Autoview">auto_view</a></span>”</span>, provided
7036 that the corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag,
7037 and the external program is interactive.
7038 </p><p>
7039 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
7040 for a key only if the external command returned a non-zero status.
7041 </p></div><div class="sect2" title="3.306. weed"><div class="titlepage"><div><div><h3 class="title"><a id="weed"></a>3.306. weed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7042 Default: yes</p></div><p>
7043 When <span class="emphasis"><em>set</em></span>, mutt will weed headers when displaying, forwarding,
7044 printing, or replying to messages.
7045 </p></div><div class="sect2" title="3.307. wrap"><div class="titlepage"><div><div><h3 class="title"><a id="wrap"></a>3.307. wrap</h3></div></div></div><div class="literallayout"><p>Type: number<br />
7046 Default: 0</p></div><p>
7047 When set to a positive value, mutt will wrap text at <a class="link" href="#wrap" title="3.307. wrap">$wrap</a> characters.
7048 When set to a negative value, mutt will wrap text so that there are <a class="link" href="#wrap" title="3.307. wrap">$wrap</a>
7049 characters of empty space on the right side of the terminal. Setting it
7050 to zero makes mutt wrap at the terminal width.
7051 </p></div><div class="sect2" title="3.308. wrap_headers"><div class="titlepage"><div><div><h3 class="title"><a id="wrap-headers"></a>3.308. wrap_headers</h3></div></div></div><div class="literallayout"><p>Type: number<br />
7052 Default: 78</p></div><p>
7053 This option specifies the number of characters to use for wrapping
7054 an outgoing message's headers. Allowed values are between 78 and 998
7055 inclusive.
7056 </p><p>
7057 <span class="bold"><strong>Note:</strong></span> This option usually shouldn't be changed. RFC5233
7058 recommends a line length of 78 (the default), so <span class="bold"><strong>please only change
7059 this setting when you know what you're doing</strong></span>.
7060 </p></div><div class="sect2" title="3.309. wrap_search"><div class="titlepage"><div><div><h3 class="title"><a id="wrap-search"></a>3.309. wrap_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7061 Default: yes</p></div><p>
7062 Controls whether searches wrap around the end.
7063 </p><p>
7064 When <span class="emphasis"><em>set</em></span>, searches will wrap around the first (or last) item. When
7065 <span class="emphasis"><em>unset</em></span>, incremental searches will not wrap.
7066 </p></div><div class="sect2" title="3.310. wrapmargin"><div class="titlepage"><div><div><h3 class="title"><a id="wrapmargin"></a>3.310. wrapmargin</h3></div></div></div><div class="literallayout"><p>Type: number<br />
7067 Default: 0</p></div><p>
7068 (DEPRECATED) Equivalent to setting <a class="link" href="#wrap" title="3.307. wrap">$wrap</a> with a negative value.
7069 </p></div><div class="sect2" title="3.311. write_bcc"><div class="titlepage"><div><div><h3 class="title"><a id="write-bcc"></a>3.311. write_bcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
7070 Default: yes</p></div><p>
7071 Controls whether mutt writes out the <span class="quote">“<span class="quote">Bcc:</span>”</span> header when preparing
7072 messages to be sent.  Exim users may wish to unset this. If mutt
7073 is set to deliver directly via SMTP (see <a class="link" href="#smtp-url" title="3.263. smtp_url">$smtp_url</a>), this
7074 option does nothing: mutt will never write out the <span class="quote">“<span class="quote">Bcc:</span>”</span> header
7075 in this case.
7076 </p></div><div class="sect2" title="3.312. write_inc"><div class="titlepage"><div><div><h3 class="title"><a id="write-inc"></a>3.312. write_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
7077 Default: 10</p></div><p>
7078 When writing a mailbox, a message will be printed every
7079 <a class="link" href="#write-inc" title="3.312. write_inc">$write_inc</a> messages to indicate progress.  If set to 0, only a
7080 single message will be displayed before writing a mailbox.
7081 </p><p>
7082 Also see the <a class="link" href="#read-inc" title="3.208. read_inc">$read_inc</a>, <a class="link" href="#net-inc" title="3.148. net_inc">$net_inc</a> and <a class="link" href="#time-inc" title="3.291. time_inc">$time_inc</a> variables and the
7083 <span class="quote">“<span class="quote"><a class="link" href="#tuning" title="Chapter 8. Performance Tuning">tuning</a></span>”</span> section of the manual for performance considerations.
7084 </p></div></div><div class="sect1" title="4. Functions"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="functions"></a>4. Functions</h2></div></div></div><p>
7085 The following is the list of available functions listed by the mapping
7086 in which they are available.  The default key setting is given, and an
7087 explanation of what the function does.  The key bindings of these
7088 functions can be changed with the <a class="link" href="#bind" title="5. Changing the Default Key Bindings">bind</a>
7089 command.
7090 </p><div class="sect2" title="4.1. Generic Menu"><div class="titlepage"><div><div><h3 class="title"><a id="generic-map"></a>4.1. Generic Menu</h3></div></div></div><p>
7091 The <span class="emphasis"><em>generic</em></span> menu is not a real menu, but specifies common functions
7092 (such as movement) available in all menus except for <span class="emphasis"><em>pager</em></span> and
7093 <span class="emphasis"><em>editor</em></span>.  Changing settings for this menu will affect the default
7094 bindings for all menus (except as noted).
7095 </p><div class="table"><a id="tab-generic-bindings"></a><p class="title"><b>Table 9.2. Default Generic Menu Bindings</b></p><div class="table-contents"><table summary="Default Generic Menu 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">&lt;top-page&gt;</code></td><td>H</td><td>move to the top of the page</td></tr><tr><td><code class="literal">&lt;next-entry&gt;</code></td><td>j</td><td>move to the next entry</td></tr><tr><td><code class="literal">&lt;previous-entry&gt;</code></td><td>k</td><td>move to the previous entry</td></tr><tr><td><code class="literal">&lt;bottom-page&gt;</code></td><td>L</td><td>move to the bottom of the page</td></tr><tr><td><code class="literal">&lt;refresh&gt;</code></td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td><code class="literal">&lt;middle-page&gt;</code></td><td>M</td><td>move to the middle of the page</td></tr><tr><td><code class="literal">&lt;search-next&gt;</code></td><td>n</td><td>search for next match</td></tr><tr><td><code class="literal">&lt;exit&gt;</code></td><td>q</td><td>exit this menu</td></tr><tr><td><code class="literal">&lt;tag-entry&gt;</code></td><td>t</td><td>tag the current entry</td></tr><tr><td><code class="literal">&lt;next-page&gt;</code></td><td>z</td><td>move to the next page</td></tr><tr><td><code class="literal">&lt;previous-page&gt;</code></td><td>Z</td><td>move to the previous page</td></tr><tr><td><code class="literal">&lt;last-entry&gt;</code></td><td>*</td><td>move to the last entry</td></tr><tr><td><code class="literal">&lt;first-entry&gt;</code></td><td>=</td><td>move to the first entry</td></tr><tr><td><code class="literal">&lt;enter-command&gt;</code></td><td>:</td><td>enter a muttrc command</td></tr><tr><td><code class="literal">&lt;next-line&gt;</code></td><td>&gt;</td><td>scroll down one line</td></tr><tr><td><code class="literal">&lt;previous-line&gt;</code></td><td>&lt;</td><td>scroll up one line</td></tr><tr><td><code class="literal">&lt;half-up&gt;</code></td><td>[</td><td>scroll up 1/2 page</td></tr><tr><td><code class="literal">&lt;half-down&gt;</code></td><td>]</td><td>scroll down 1/2 page</td></tr><tr><td><code class="literal">&lt;help&gt;</code></td><td>?</td><td>this screen</td></tr><tr><td><code class="literal">&lt;tag-prefix&gt;</code></td><td>;</td><td>apply next function to tagged messages</td></tr><tr><td><code class="literal">&lt;tag-prefix-cond&gt;</code></td><td> </td><td>apply next function ONLY to tagged messages</td></tr><tr><td><code class="literal">&lt;end-cond&gt;</code></td><td> </td><td>end of conditional execution (noop)</td></tr><tr><td><code class="literal">&lt;shell-escape&gt;</code></td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td><code class="literal">&lt;select-entry&gt;</code></td><td>&lt;Return&gt;</td><td>select the current entry</td></tr><tr><td><code class="literal">&lt;search&gt;</code></td><td>/</td><td>search for a regular expression</td></tr><tr><td><code class="literal">&lt;search-reverse&gt;</code></td><td>Esc /</td><td>search backwards for a regular expression</td></tr><tr><td><code class="literal">&lt;search-opposite&gt;</code></td><td> </td><td>search for next match in opposite direction</td></tr><tr><td><code class="literal">&lt;jump&gt;</code></td><td> </td><td>jump to an index number</td></tr><tr><td><code class="literal">&lt;current-top&gt;</code></td><td> </td><td>move entry to top of screen</td></tr><tr><td><code class="literal">&lt;current-middle&gt;</code></td><td> </td><td>move entry to middle of screen</td></tr><tr><td><code class="literal">&lt;current-bottom&gt;</code></td><td> </td><td>move entry to bottom of screen</td></tr><tr><td><code class="literal">&lt;what-key&gt;</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" title="4.2. Index Menu"><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="tab-index-bindings"></a><p class="title"><b>Table 9.3. Default Index Menu Bindings</b></p><div class="table-contents"><table summary="Default Index Menu 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">&lt;create-alias&gt;</code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal">&lt;bounce-message&gt;</code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal">&lt;break-thread&gt;</code></td><td>#</td><td>break the thread in two</td></tr><tr><td><code class="literal">&lt;change-folder&gt;</code></td><td>c</td><td>open a different folder</td></tr><tr><td><code class="literal">&lt;change-folder-readonly&gt;</code></td><td>Esc c</td><td>open a different folder in read only mode</td></tr><tr><td><code class="literal">&lt;next-unread-mailbox&gt;</code></td><td> </td><td>open next mailbox with new mail</td></tr><tr><td><code class="literal">&lt;collapse-thread&gt;</code></td><td>Esc v</td><td>collapse/uncollapse current thread</td></tr><tr><td><code class="literal">&lt;collapse-all&gt;</code></td><td>Esc V</td><td>collapse/uncollapse all threads</td></tr><tr><td><code class="literal">&lt;copy-message&gt;</code></td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td><code class="literal">&lt;decode-copy&gt;</code></td><td>Esc C</td><td>make decoded (text/plain) copy</td></tr><tr><td><code class="literal">&lt;decode-save&gt;</code></td><td>Esc s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td><code class="literal">&lt;delete-message&gt;</code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal">&lt;delete-pattern&gt;</code></td><td>D</td><td>delete messages matching a pattern</td></tr><tr><td><code class="literal">&lt;delete-thread&gt;</code></td><td>^D</td><td>delete all messages in thread</td></tr><tr><td><code class="literal">&lt;delete-subthread&gt;</code></td><td>Esc d</td><td>delete all messages in subthread</td></tr><tr><td><code class="literal">&lt;edit&gt;</code></td><td>e</td><td>edit the raw message</td></tr><tr><td><code class="literal">&lt;edit-type&gt;</code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal">&lt;forward-message&gt;</code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal">&lt;flag-message&gt;</code></td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td><code class="literal">&lt;group-reply&gt;</code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal">&lt;fetch-mail&gt;</code></td><td>G</td><td>retrieve mail from POP server</td></tr><tr><td><code class="literal">&lt;imap-fetch-mail&gt;</code></td><td> </td><td>force retrieval of mail from IMAP server</td></tr><tr><td><code class="literal">&lt;imap-logout-all&gt;</code></td><td> </td><td>logout from all IMAP servers</td></tr><tr><td><code class="literal">&lt;display-toggle-weed&gt;</code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal">&lt;next-undeleted&gt;</code></td><td>j</td><td>move to the next undeleted message</td></tr><tr><td><code class="literal">&lt;previous-undeleted&gt;</code></td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td><code class="literal">&lt;limit&gt;</code></td><td>l</td><td>show only messages matching a pattern</td></tr><tr><td><code class="literal">&lt;link-threads&gt;</code></td><td>&amp;</td><td>link tagged message to the current one</td></tr><tr><td><code class="literal">&lt;list-reply&gt;</code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal">&lt;mail&gt;</code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal">&lt;toggle-new&gt;</code></td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td><code class="literal">&lt;toggle-write&gt;</code></td><td>%</td><td>toggle whether the mailbox will be rewritten</td></tr><tr><td><code class="literal">&lt;next-thread&gt;</code></td><td>^N</td><td>jump to the next thread</td></tr><tr><td><code class="literal">&lt;next-subthread&gt;</code></td><td>Esc n</td><td>jump to the next subthread</td></tr><tr><td><code class="literal">&lt;query&gt;</code></td><td>Q</td><td>query external program for addresses</td></tr><tr><td><code class="literal">&lt;quit&gt;</code></td><td>q</td><td>save changes to mailbox and quit</td></tr><tr><td><code class="literal">&lt;reply&gt;</code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal">&lt;show-limit&gt;</code></td><td>Esc l</td><td>show currently active limit pattern</td></tr><tr><td><code class="literal">&lt;sort-mailbox&gt;</code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal">&lt;sort-reverse&gt;</code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal">&lt;print-message&gt;</code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal">&lt;previous-thread&gt;</code></td><td>^P</td><td>jump to previous thread</td></tr><tr><td><code class="literal">&lt;previous-subthread&gt;</code></td><td>Esc p</td><td>jump to previous subthread</td></tr><tr><td><code class="literal">&lt;recall-message&gt;</code></td><td>R</td><td>recall a postponed message</td></tr><tr><td><code class="literal">&lt;read-thread&gt;</code></td><td>^R</td><td>mark the current thread as read</td></tr><tr><td><code class="literal">&lt;read-subthread&gt;</code></td><td>Esc r</td><td>mark the current subthread as read</td></tr><tr><td><code class="literal">&lt;resend-message&gt;</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">&lt;save-message&gt;</code></td><td>s</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal">&lt;tag-pattern&gt;</code></td><td>T</td><td>tag messages matching a pattern</td></tr><tr><td><code class="literal">&lt;tag-subthread&gt;</code></td><td> </td><td>tag the current subthread</td></tr><tr><td><code class="literal">&lt;tag-thread&gt;</code></td><td>Esc t</td><td>tag the current thread</td></tr><tr><td><code class="literal">&lt;untag-pattern&gt;</code></td><td>^T</td><td>untag messages matching a pattern</td></tr><tr><td><code class="literal">&lt;undelete-message&gt;</code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal">&lt;undelete-pattern&gt;</code></td><td>U</td><td>undelete messages matching a pattern</td></tr><tr><td><code class="literal">&lt;undelete-subthread&gt;</code></td><td>Esc u</td><td>undelete all messages in subthread</td></tr><tr><td><code class="literal">&lt;undelete-thread&gt;</code></td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td><code class="literal">&lt;view-attachments&gt;</code></td><td>v</td><td>show MIME attachments</td></tr><tr><td><code class="literal">&lt;show-version&gt;</code></td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td><code class="literal">&lt;set-flag&gt;</code></td><td>w</td><td>set a status flag on a message</td></tr><tr><td><code class="literal">&lt;clear-flag&gt;</code></td><td>W</td><td>clear a status flag from a message</td></tr><tr><td><code class="literal">&lt;display-message&gt;</code></td><td>&lt;Return&gt;</td><td>display a message</td></tr><tr><td><code class="literal">&lt;buffy-list&gt;</code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal">&lt;sync-mailbox&gt;</code></td><td>$</td><td>save changes to mailbox</td></tr><tr><td><code class="literal">&lt;display-address&gt;</code></td><td>@</td><td>display full address of sender</td></tr><tr><td><code class="literal">&lt;pipe-message&gt;</code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal">&lt;next-new&gt;</code></td><td> </td><td>jump to the next new message</td></tr><tr><td><code class="literal">&lt;next-new-then-unread&gt;</code></td><td>&lt;Tab&gt;</td><td>jump to the next new or unread message</td></tr><tr><td><code class="literal">&lt;previous-new&gt;</code></td><td> </td><td>jump to the previous new message</td></tr><tr><td><code class="literal">&lt;previous-new-then-unread&gt;</code></td><td>Esc &lt;Tab&gt;</td><td>jump to the previous new or unread message</td></tr><tr><td><code class="literal">&lt;next-unread&gt;</code></td><td> </td><td>jump to the next unread message</td></tr><tr><td><code class="literal">&lt;previous-unread&gt;</code></td><td> </td><td>jump to the previous unread message</td></tr><tr><td><code class="literal">&lt;parent-message&gt;</code></td><td>P</td><td>jump to parent message in thread</td></tr><tr><td><code class="literal">&lt;extract-keys&gt;</code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal">&lt;forget-passphrase&gt;</code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal">&lt;check-traditional-pgp&gt;</code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal">&lt;mail-key&gt;</code></td><td>Esc k</td><td>mail a PGP public key</td></tr><tr><td><code class="literal">&lt;decrypt-copy&gt;</code></td><td> </td><td>make decrypted copy</td></tr><tr><td><code class="literal">&lt;decrypt-save&gt;</code></td><td> </td><td>make decrypted copy and delete</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" title="4.3. Pager Menu"><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="tab-pager-bindings"></a><p class="title"><b>Table 9.4. Default Pager Menu Bindings</b></p><div class="table-contents"><table summary="Default Pager Menu 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">&lt;break-thread&gt;</code></td><td>#</td><td>break the thread in two</td></tr><tr><td><code class="literal">&lt;create-alias&gt;</code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal">&lt;bounce-message&gt;</code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal">&lt;change-folder&gt;</code></td><td>c</td><td>open a different folder</td></tr><tr><td><code class="literal">&lt;change-folder-readonly&gt;</code></td><td>Esc c</td><td>open a different folder in read only mode</td></tr><tr><td><code class="literal">&lt;next-unread-mailbox&gt;</code></td><td> </td><td>open next mailbox with new mail</td></tr><tr><td><code class="literal">&lt;copy-message&gt;</code></td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td><code class="literal">&lt;decode-copy&gt;</code></td><td>Esc C</td><td>make decoded (text/plain) copy</td></tr><tr><td><code class="literal">&lt;delete-message&gt;</code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal">&lt;delete-thread&gt;</code></td><td>^D</td><td>delete all messages in thread</td></tr><tr><td><code class="literal">&lt;delete-subthread&gt;</code></td><td>Esc d</td><td>delete all messages in subthread</td></tr><tr><td><code class="literal">&lt;set-flag&gt;</code></td><td>w</td><td>set a status flag on a message</td></tr><tr><td><code class="literal">&lt;clear-flag&gt;</code></td><td>W</td><td>clear a status flag from a message</td></tr><tr><td><code class="literal">&lt;edit&gt;</code></td><td>e</td><td>edit the raw message</td></tr><tr><td><code class="literal">&lt;edit-type&gt;</code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal">&lt;forward-message&gt;</code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal">&lt;flag-message&gt;</code></td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td><code class="literal">&lt;group-reply&gt;</code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal">&lt;imap-fetch-mail&gt;</code></td><td> </td><td>force retrieval of mail from IMAP server</td></tr><tr><td><code class="literal">&lt;imap-logout-all&gt;</code></td><td> </td><td>logout from all IMAP servers</td></tr><tr><td><code class="literal">&lt;display-toggle-weed&gt;</code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal">&lt;next-undeleted&gt;</code></td><td>j</td><td>move to the next undeleted message</td></tr><tr><td><code class="literal">&lt;next-entry&gt;</code></td><td>J</td><td>move to the next entry</td></tr><tr><td><code class="literal">&lt;previous-undeleted&gt;</code></td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td><code class="literal">&lt;previous-entry&gt;</code></td><td>K</td><td>move to the previous entry</td></tr><tr><td><code class="literal">&lt;link-threads&gt;</code></td><td>&amp;</td><td>link tagged message to the current one</td></tr><tr><td><code class="literal">&lt;list-reply&gt;</code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal">&lt;redraw-screen&gt;</code></td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td><code class="literal">&lt;mail&gt;</code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal">&lt;mark-as-new&gt;</code></td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td><code class="literal">&lt;search-next&gt;</code></td><td>n</td><td>search for next match</td></tr><tr><td><code class="literal">&lt;next-thread&gt;</code></td><td>^N</td><td>jump to the next thread</td></tr><tr><td><code class="literal">&lt;next-subthread&gt;</code></td><td>Esc n</td><td>jump to the next subthread</td></tr><tr><td><code class="literal">&lt;sort-mailbox&gt;</code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal">&lt;sort-reverse&gt;</code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal">&lt;print-message&gt;</code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal">&lt;previous-thread&gt;</code></td><td>^P</td><td>jump to previous thread</td></tr><tr><td><code class="literal">&lt;previous-subthread&gt;</code></td><td>Esc p</td><td>jump to previous subthread</td></tr><tr><td><code class="literal">&lt;quit&gt;</code></td><td>Q</td><td>save changes to mailbox and quit</td></tr><tr><td><code class="literal">&lt;exit&gt;</code></td><td>q</td><td>exit this menu</td></tr><tr><td><code class="literal">&lt;reply&gt;</code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal">&lt;recall-message&gt;</code></td><td>R</td><td>recall a postponed message</td></tr><tr><td><code class="literal">&lt;read-thread&gt;</code></td><td>^R</td><td>mark the current thread as read</td></tr><tr><td><code class="literal">&lt;read-subthread&gt;</code></td><td>Esc r</td><td>mark the current subthread as read</td></tr><tr><td><code class="literal">&lt;resend-message&gt;</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">&lt;save-message&gt;</code></td><td>s</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal">&lt;skip-quoted&gt;</code></td><td>S</td><td>skip beyond quoted text</td></tr><tr><td><code class="literal">&lt;decode-save&gt;</code></td><td>Esc s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td><code class="literal">&lt;tag-message&gt;</code></td><td>t</td><td>tag the current entry</td></tr><tr><td><code class="literal">&lt;toggle-quoted&gt;</code></td><td>T</td><td>toggle display of quoted text</td></tr><tr><td><code class="literal">&lt;undelete-message&gt;</code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal">&lt;undelete-subthread&gt;</code></td><td>Esc u</td><td>undelete all messages in subthread</td></tr><tr><td><code class="literal">&lt;undelete-thread&gt;</code></td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td><code class="literal">&lt;view-attachments&gt;</code></td><td>v</td><td>show MIME attachments</td></tr><tr><td><code class="literal">&lt;show-version&gt;</code></td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td><code class="literal">&lt;search-toggle&gt;</code></td><td>\\</td><td>toggle search pattern coloring</td></tr><tr><td><code class="literal">&lt;display-address&gt;</code></td><td>@</td><td>display full address of sender</td></tr><tr><td><code class="literal">&lt;next-new&gt;</code></td><td> </td><td>jump to the next new message</td></tr><tr><td><code class="literal">&lt;pipe-message&gt;</code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal">&lt;help&gt;</code></td><td>?</td><td>this screen</td></tr><tr><td><code class="literal">&lt;next-page&gt;</code></td><td>&lt;Space&gt;</td><td>move to the next page</td></tr><tr><td><code class="literal">&lt;previous-page&gt;</code></td><td>-</td><td>move to the previous page</td></tr><tr><td><code class="literal">&lt;top&gt;</code></td><td>^</td><td>jump to the top of the message</td></tr><tr><td><code class="literal">&lt;sync-mailbox&gt;</code></td><td>$</td><td>save changes to mailbox</td></tr><tr><td><code class="literal">&lt;shell-escape&gt;</code></td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td><code class="literal">&lt;enter-command&gt;</code></td><td>:</td><td>enter a muttrc command</td></tr><tr><td><code class="literal">&lt;buffy-list&gt;</code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal">&lt;search&gt;</code></td><td>/</td><td>search for a regular expression</td></tr><tr><td><code class="literal">&lt;search-reverse&gt;</code></td><td>Esc /</td><td>search backwards for a regular expression</td></tr><tr><td><code class="literal">&lt;search-opposite&gt;</code></td><td> </td><td>search for next match in opposite direction</td></tr><tr><td><code class="literal">&lt;next-line&gt;</code></td><td>&lt;Return&gt;</td><td>scroll down one line</td></tr><tr><td><code class="literal">&lt;jump&gt;</code></td><td> </td><td>jump to an index number</td></tr><tr><td><code class="literal">&lt;next-unread&gt;</code></td><td> </td><td>jump to the next unread message</td></tr><tr><td><code class="literal">&lt;previous-new&gt;</code></td><td> </td><td>jump to the previous new message</td></tr><tr><td><code class="literal">&lt;previous-unread&gt;</code></td><td> </td><td>jump to the previous unread message</td></tr><tr><td><code class="literal">&lt;half-up&gt;</code></td><td> </td><td>scroll up 1/2 page</td></tr><tr><td><code class="literal">&lt;half-down&gt;</code></td><td> </td><td>scroll down 1/2 page</td></tr><tr><td><code class="literal">&lt;previous-line&gt;</code></td><td> </td><td>scroll up one line</td></tr><tr><td><code class="literal">&lt;bottom&gt;</code></td><td> </td><td>jump to the bottom of the message</td></tr><tr><td><code class="literal">&lt;parent-message&gt;</code></td><td>P</td><td>jump to parent message in thread</td></tr><tr><td><code class="literal">&lt;check-traditional-pgp&gt;</code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal">&lt;mail-key&gt;</code></td><td>Esc k</td><td>mail a PGP public key</td></tr><tr><td><code class="literal">&lt;extract-keys&gt;</code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal">&lt;forget-passphrase&gt;</code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal">&lt;decrypt-copy&gt;</code></td><td> </td><td>make decrypted copy</td></tr><tr><td><code class="literal">&lt;decrypt-save&gt;</code></td><td> </td><td>make decrypted copy and delete</td></tr><tr><td><code class="literal">&lt;what-key&gt;</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" title="4.4. Alias Menu"><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="tab-alias-bindings"></a><p class="title"><b>Table 9.5. Default Alias Menu Bindings</b></p><div class="table-contents"><table summary="Default Alias Menu 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">&lt;delete-entry&gt;</code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal">&lt;undelete-entry&gt;</code></td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" title="4.5. Query Menu"><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="tab-query-bindings"></a><p class="title"><b>Table 9.6. Default Query Menu Bindings</b></p><div class="table-contents"><table summary="Default Query Menu 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">&lt;create-alias&gt;</code></td><td>a</td><td>create an alias from a message sender</td></tr><tr><td><code class="literal">&lt;mail&gt;</code></td><td>m</td><td>compose a new mail message</td></tr><tr><td><code class="literal">&lt;query&gt;</code></td><td>Q</td><td>query external program for addresses</td></tr><tr><td><code class="literal">&lt;query-append&gt;</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" title="4.6. Attachment Menu"><div class="titlepage"><div><div><h3 class="title"><a id="attachment-map"></a>4.6. Attachment Menu</h3></div></div></div><div class="table"><a id="tab-attachment-bindings"></a><p class="title"><b>Table 9.7. Default Attachment Menu Bindings</b></p><div class="table-contents"><table summary="Default Attachment Menu 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">&lt;bounce-message&gt;</code></td><td>b</td><td>remail a message to another user</td></tr><tr><td><code class="literal">&lt;display-toggle-weed&gt;</code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal">&lt;edit-type&gt;</code></td><td>^E</td><td>edit attachment content type</td></tr><tr><td><code class="literal">&lt;print-entry&gt;</code></td><td>p</td><td>print the current entry</td></tr><tr><td><code class="literal">&lt;save-entry&gt;</code></td><td>s</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal">&lt;pipe-entry&gt;</code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal">&lt;view-mailcap&gt;</code></td><td>m</td><td>force viewing of attachment using mailcap</td></tr><tr><td><code class="literal">&lt;reply&gt;</code></td><td>r</td><td>reply to a message</td></tr><tr><td><code class="literal">&lt;resend-message&gt;</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">&lt;group-reply&gt;</code></td><td>g</td><td>reply to all recipients</td></tr><tr><td><code class="literal">&lt;list-reply&gt;</code></td><td>L</td><td>reply to specified mailing list</td></tr><tr><td><code class="literal">&lt;forward-message&gt;</code></td><td>f</td><td>forward a message with comments</td></tr><tr><td><code class="literal">&lt;view-text&gt;</code></td><td>T</td><td>view attachment as text</td></tr><tr><td><code class="literal">&lt;view-attach&gt;</code></td><td>&lt;Return&gt;</td><td>view attachment using mailcap entry if necessary</td></tr><tr><td><code class="literal">&lt;delete-entry&gt;</code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal">&lt;undelete-entry&gt;</code></td><td>u</td><td>undelete the current entry</td></tr><tr><td><code class="literal">&lt;collapse-parts&gt;</code></td><td>v</td><td>Toggle display of subparts</td></tr><tr><td><code class="literal">&lt;check-traditional-pgp&gt;</code></td><td>Esc P</td><td>check for classic PGP</td></tr><tr><td><code class="literal">&lt;extract-keys&gt;</code></td><td>^K</td><td>extract supported public keys</td></tr><tr><td><code class="literal">&lt;forget-passphrase&gt;</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" title="4.7. Compose Menu"><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="tab-compose-bindings"></a><p class="title"><b>Table 9.8. Default Compose Menu Bindings</b></p><div class="table-contents"><table summary="Default Compose Menu 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">&lt;attach-file&gt;</code></td><td>a</td><td>attach file(s) to this message</td></tr><tr><td><code class="literal">&lt;attach-message&gt;</code></td><td>A</td><td>attach message(s) to this message</td></tr><tr><td><code class="literal">&lt;edit-bcc&gt;</code></td><td>b</td><td>edit the BCC list</td></tr><tr><td><code class="literal">&lt;edit-cc&gt;</code></td><td>c</td><td>edit the CC list</td></tr><tr><td><code class="literal">&lt;copy-file&gt;</code></td><td>C</td><td>save message/attachment to a mailbox/file</td></tr><tr><td><code class="literal">&lt;detach-file&gt;</code></td><td>D</td><td>delete the current entry</td></tr><tr><td><code class="literal">&lt;toggle-disposition&gt;</code></td><td>^D</td><td>toggle disposition between inline/attachment</td></tr><tr><td><code class="literal">&lt;edit-description&gt;</code></td><td>d</td><td>edit attachment description</td></tr><tr><td><code class="literal">&lt;edit-message&gt;</code></td><td>e</td><td>edit the message</td></tr><tr><td><code class="literal">&lt;edit-headers&gt;</code></td><td>E</td><td>edit the message with headers</td></tr><tr><td><code class="literal">&lt;edit-file&gt;</code></td><td>^X e</td><td>edit the file to be attached</td></tr><tr><td><code class="literal">&lt;edit-encoding&gt;</code></td><td>^E</td><td>edit attachment transfer-encoding</td></tr><tr><td><code class="literal">&lt;edit-from&gt;</code></td><td>Esc f</td><td>edit the from field</td></tr><tr><td><code class="literal">&lt;edit-fcc&gt;</code></td><td>f</td><td>enter a file to save a copy of this message in</td></tr><tr><td><code class="literal">&lt;filter-entry&gt;</code></td><td>F</td><td>filter attachment through a shell command</td></tr><tr><td><code class="literal">&lt;get-attachment&gt;</code></td><td>G</td><td>get a temporary copy of an attachment</td></tr><tr><td><code class="literal">&lt;display-toggle-weed&gt;</code></td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td><code class="literal">&lt;ispell&gt;</code></td><td>i</td><td>run ispell on the message</td></tr><tr><td><code class="literal">&lt;print-entry&gt;</code></td><td>l</td><td>print the current entry</td></tr><tr><td><code class="literal">&lt;edit-mime&gt;</code></td><td>m</td><td>edit attachment using mailcap entry</td></tr><tr><td><code class="literal">&lt;new-mime&gt;</code></td><td>n</td><td>compose new attachment using mailcap entry</td></tr><tr><td><code class="literal">&lt;postpone-message&gt;</code></td><td>P</td><td>save this message to send later</td></tr><tr><td><code class="literal">&lt;edit-reply-to&gt;</code></td><td>r</td><td>edit the Reply-To field</td></tr><tr><td><code class="literal">&lt;rename-file&gt;</code></td><td>R</td><td>rename/move an attached file</td></tr><tr><td><code class="literal">&lt;edit-subject&gt;</code></td><td>s</td><td>edit the subject of this message</td></tr><tr><td><code class="literal">&lt;edit-to&gt;</code></td><td>t</td><td>edit the TO list</td></tr><tr><td><code class="literal">&lt;edit-type&gt;</code></td><td>^T</td><td>edit attachment content type</td></tr><tr><td><code class="literal">&lt;write-fcc&gt;</code></td><td>w</td><td>write the message to a folder</td></tr><tr><td><code class="literal">&lt;toggle-unlink&gt;</code></td><td>u</td><td>toggle whether to delete file after sending it</td></tr><tr><td><code class="literal">&lt;toggle-recode&gt;</code></td><td> </td><td>toggle recoding of this attachment</td></tr><tr><td><code class="literal">&lt;update-encoding&gt;</code></td><td>U</td><td>update an attachment's encoding info</td></tr><tr><td><code class="literal">&lt;view-attach&gt;</code></td><td>&lt;Return&gt;</td><td>view attachment using mailcap entry if necessary</td></tr><tr><td><code class="literal">&lt;send-message&gt;</code></td><td>y</td><td>send the message</td></tr><tr><td><code class="literal">&lt;pipe-entry&gt;</code></td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td><code class="literal">&lt;attach-key&gt;</code></td><td>Esc k</td><td>attach a PGP public key</td></tr><tr><td><code class="literal">&lt;pgp-menu&gt;</code></td><td>p</td><td>show PGP options</td></tr><tr><td><code class="literal">&lt;forget-passphrase&gt;</code></td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td><code class="literal">&lt;smime-menu&gt;</code></td><td>S</td><td>show S/MIME options</td></tr><tr><td><code class="literal">&lt;mix&gt;</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" title="4.8. Postpone Menu"><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="tab-postpone-bindings"></a><p class="title"><b>Table 9.9. Default Postpone Menu Bindings</b></p><div class="table-contents"><table summary="Default Postpone Menu 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">&lt;delete-entry&gt;</code></td><td>d</td><td>delete the current entry</td></tr><tr><td><code class="literal">&lt;undelete-entry&gt;</code></td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" title="4.9. Browser Menu"><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="tab-browser-bindings"></a><p class="title"><b>Table 9.10. Default Browser Menu Bindings</b></p><div class="table-contents"><table summary="Default Browser Menu 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">&lt;change-dir&gt;</code></td><td>c</td><td>change directories</td></tr><tr><td><code class="literal">&lt;display-filename&gt;</code></td><td>@</td><td>display the currently selected file's name</td></tr><tr><td><code class="literal">&lt;enter-mask&gt;</code></td><td>m</td><td>enter a file mask</td></tr><tr><td><code class="literal">&lt;sort&gt;</code></td><td>o</td><td>sort messages</td></tr><tr><td><code class="literal">&lt;sort-reverse&gt;</code></td><td>O</td><td>sort messages in reverse order</td></tr><tr><td><code class="literal">&lt;select-new&gt;</code></td><td>N</td><td>select a new file in this directory</td></tr><tr><td><code class="literal">&lt;check-new&gt;</code></td><td> </td><td>check mailboxes for new mail</td></tr><tr><td><code class="literal">&lt;toggle-mailboxes&gt;</code></td><td>&lt;Tab&gt;</td><td>toggle whether to browse mailboxes or all files</td></tr><tr><td><code class="literal">&lt;view-file&gt;</code></td><td>&lt;Space&gt;</td><td>view file</td></tr><tr><td><code class="literal">&lt;buffy-list&gt;</code></td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td><code class="literal">&lt;create-mailbox&gt;</code></td><td>C</td><td>create a new mailbox (IMAP only)</td></tr><tr><td><code class="literal">&lt;delete-mailbox&gt;</code></td><td>d</td><td>delete the current mailbox (IMAP only)</td></tr><tr><td><code class="literal">&lt;rename-mailbox&gt;</code></td><td>r</td><td>rename the current mailbox (IMAP only)</td></tr><tr><td><code class="literal">&lt;subscribe&gt;</code></td><td>s</td><td>subscribe to current mailbox (IMAP only)</td></tr><tr><td><code class="literal">&lt;unsubscribe&gt;</code></td><td>u</td><td>unsubscribe from current mailbox (IMAP only)</td></tr><tr><td><code class="literal">&lt;toggle-subscribed&gt;</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" title="4.10. Pgp Menu"><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="tab-pgp-bindings"></a><p class="title"><b>Table 9.11. Default Pgp Menu Bindings</b></p><div class="table-contents"><table summary="Default Pgp Menu 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">&lt;verify-key&gt;</code></td><td>c</td><td>verify a PGP public key</td></tr><tr><td><code class="literal">&lt;view-name&gt;</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" title="4.11. Smime Menu"><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="tab-smime-bindings"></a><p class="title"><b>Table 9.12. Default Smime Menu Bindings</b></p><div class="table-contents"><table summary="Default Smime Menu 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">&lt;verify-key&gt;</code></td><td>c</td><td>verify a PGP public key</td></tr><tr><td><code class="literal">&lt;view-name&gt;</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" title="4.12. Mixmaster Menu"><div class="titlepage"><div><div><h3 class="title"><a id="mixmaster-map"></a>4.12. Mixmaster Menu</h3></div></div></div><div class="table"><a id="tab-mixmaster-bindings"></a><p class="title"><b>Table 9.13. Default Mixmaster Menu Bindings</b></p><div class="table-contents"><table summary="Default Mixmaster Menu 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">&lt;accept&gt;</code></td><td>&lt;Return&gt;</td><td>Accept the chain constructed</td></tr><tr><td><code class="literal">&lt;append&gt;</code></td><td>a</td><td>Append a remailer to the chain</td></tr><tr><td><code class="literal">&lt;insert&gt;</code></td><td>i</td><td>Insert a remailer into the chain</td></tr><tr><td><code class="literal">&lt;delete&gt;</code></td><td>d</td><td>Delete a remailer from the chain</td></tr><tr><td><code class="literal">&lt;chain-prev&gt;</code></td><td>&lt;Left&gt;</td><td>Select the previous element of the chain</td></tr><tr><td><code class="literal">&lt;chain-next&gt;</code></td><td>&lt;Right&gt;</td><td>Select the next element of the chain</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="sect2" title="4.13. Editor Menu"><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="tab-editor-bindings"></a><p class="title"><b>Table 9.14. Default Editor Menu Bindings</b></p><div class="table-contents"><table summary="Default Editor Menu 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">&lt;bol&gt;</code></td><td>^A</td><td>jump to the beginning of the line</td></tr><tr><td><code class="literal">&lt;backward-char&gt;</code></td><td>^B</td><td>move the cursor one character to the left</td></tr><tr><td><code class="literal">&lt;backward-word&gt;</code></td><td>Esc b</td><td>move the cursor to the beginning of the word</td></tr><tr><td><code class="literal">&lt;capitalize-word&gt;</code></td><td>Esc c</td><td>capitalize the word</td></tr><tr><td><code class="literal">&lt;downcase-word&gt;</code></td><td>Esc l</td><td>convert the word to lower case</td></tr><tr><td><code class="literal">&lt;upcase-word&gt;</code></td><td>Esc u</td><td>convert the word to upper case</td></tr><tr><td><code class="literal">&lt;delete-char&gt;</code></td><td>^D</td><td>delete the char under the cursor</td></tr><tr><td><code class="literal">&lt;eol&gt;</code></td><td>^E</td><td>jump to the end of the line</td></tr><tr><td><code class="literal">&lt;forward-char&gt;</code></td><td>^F</td><td>move the cursor one character to the right</td></tr><tr><td><code class="literal">&lt;forward-word&gt;</code></td><td>Esc f</td><td>move the cursor to the end of the word</td></tr><tr><td><code class="literal">&lt;backspace&gt;</code></td><td>&lt;Backspace&gt;</td><td>delete the char in front of the cursor</td></tr><tr><td><code class="literal">&lt;kill-eol&gt;</code></td><td>^K</td><td>delete chars from cursor to end of line</td></tr><tr><td><code class="literal">&lt;kill-eow&gt;</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">&lt;kill-line&gt;</code></td><td>^U</td><td>delete all chars on the line</td></tr><tr><td><code class="literal">&lt;quote-char&gt;</code></td><td>^V</td><td>quote the next typed key</td></tr><tr><td><code class="literal">&lt;kill-word&gt;</code></td><td>^W</td><td>delete the word in front of the cursor</td></tr><tr><td><code class="literal">&lt;complete&gt;</code></td><td>&lt;Tab&gt;</td><td>complete filename or alias</td></tr><tr><td><code class="literal">&lt;complete-query&gt;</code></td><td>^T</td><td>complete address with query</td></tr><tr><td><code class="literal">&lt;buffy-cycle&gt;</code></td><td>&lt;Space&gt;</td><td>cycle among incoming mailboxes</td></tr><tr><td><code class="literal">&lt;history-up&gt;</code></td><td> </td><td>scroll up through the history list</td></tr><tr><td><code class="literal">&lt;history-down&gt;</code></td><td> </td><td>scroll down through the history list</td></tr><tr><td><code class="literal">&lt;transpose-chars&gt;</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" title="Chapter 10. Miscellany"><div class="titlepage"><div><div><h2 class="title"><a id="miscellany"></a>Chapter 10. 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" title="1. Acknowledgements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="acknowledgements"></a>1. Acknowledgements</h2></div></div></div><p>
7096 Kari Hurtta <code class="email">&lt;<a class="email" href="mailto:kari.hurtta@fmi.fi">kari.hurtta@fmi.fi</a>&gt;</code> co-developed the original
7097 MIME parsing code back in the ELM-ME days.
7098 </p><p>
7099 The following people have been very helpful to the development of Mutt:
7100 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Vikas Agnihotri <code class="email">&lt;<a class="email" href="mailto:vikasa@writeme.com">vikasa@writeme.com</a>&gt;</code></p></li><li class="listitem"><p>Francois Berjon <code class="email">&lt;<a class="email" href="mailto:Francois.Berjon@aar.alcatel-alsthom.fr">Francois.Berjon@aar.alcatel-alsthom.fr</a>&gt;</code></p></li><li class="listitem"><p>Aric Blumer <code class="email">&lt;<a class="email" href="mailto:aric@fore.com">aric@fore.com</a>&gt;</code></p></li><li class="listitem"><p>John Capo <code class="email">&lt;<a class="email" href="mailto:jc@irbs.com">jc@irbs.com</a>&gt;</code></p></li><li class="listitem"><p>David Champion <code class="email">&lt;<a class="email" href="mailto:dgc@uchicago.edu">dgc@uchicago.edu</a>&gt;</code></p></li><li class="listitem"><p>Brendan Cully <code class="email">&lt;<a class="email" href="mailto:brendan@kublai.com">brendan@kublai.com</a>&gt;</code></p></li><li class="listitem"><p>Liviu Daia <code class="email">&lt;<a class="email" href="mailto:daia@stoilow.imar.ro">daia@stoilow.imar.ro</a>&gt;</code></p></li><li class="listitem"><p>Thomas E. Dickey <code class="email">&lt;<a class="email" href="mailto:dickey@herndon4.his.com">dickey@herndon4.his.com</a>&gt;</code></p></li><li class="listitem"><p>David DeSimone <code class="email">&lt;<a class="email" href="mailto:fox@convex.hp.com">fox@convex.hp.com</a>&gt;</code></p></li><li class="listitem"><p>Nickolay N. Dudorov <code class="email">&lt;<a class="email" href="mailto:nnd@wint.itfs.nsk.su">nnd@wint.itfs.nsk.su</a>&gt;</code></p></li><li class="listitem"><p>Ruslan Ermilov <code class="email">&lt;<a class="email" href="mailto:ru@freebsd.org">ru@freebsd.org</a>&gt;</code></p></li><li class="listitem"><p>Edmund Grimley Evans <code class="email">&lt;<a class="email" href="mailto:edmundo@rano.org">edmundo@rano.org</a>&gt;</code></p></li><li class="listitem"><p>Michael Finken <code class="email">&lt;<a class="email" href="mailto:finken@conware.de">finken@conware.de</a>&gt;</code></p></li><li class="listitem"><p>Sven Guckes <code class="email">&lt;<a class="email" href="mailto:guckes@math.fu-berlin.de">guckes@math.fu-berlin.de</a>&gt;</code></p></li><li class="listitem"><p>Lars Hecking <code class="email">&lt;<a class="email" href="mailto:lhecking@nmrc.ie">lhecking@nmrc.ie</a>&gt;</code></p></li><li class="listitem"><p>Mark Holloman <code class="email">&lt;<a class="email" href="mailto:holloman@nando.net">holloman@nando.net</a>&gt;</code></p></li><li class="listitem"><p>Andreas Holzmann <code class="email">&lt;<a class="email" href="mailto:holzmann@fmi.uni-passau.de">holzmann@fmi.uni-passau.de</a>&gt;</code></p></li><li class="listitem"><p>Marco d'Itri <code class="email">&lt;<a class="email" href="mailto:md@linux.it">md@linux.it</a>&gt;</code></p></li><li class="listitem"><p>Björn Jacke <code class="email">&lt;<a class="email" href="mailto:bjacke@suse.com">bjacke@suse.com</a>&gt;</code></p></li><li class="listitem"><p>Byrial Jensen <code class="email">&lt;<a class="email" href="mailto:byrial@image.dk">byrial@image.dk</a>&gt;</code></p></li><li class="listitem"><p>David Jeske <code class="email">&lt;<a class="email" href="mailto:jeske@igcom.net">jeske@igcom.net</a>&gt;</code></p></li><li class="listitem"><p>Christophe Kalt <code class="email">&lt;<a class="email" href="mailto:kalt@hugo.int-evry.fr">kalt@hugo.int-evry.fr</a>&gt;</code></p></li><li class="listitem"><p>Tommi Komulainen <code class="email">&lt;<a class="email" href="mailto:Tommi.Komulainen@iki.fi">Tommi.Komulainen@iki.fi</a>&gt;</code></p></li><li class="listitem"><p>Felix von Leitner (a.k.a <span class="quote">“<span class="quote">Fefe</span>”</span>) <code class="email">&lt;<a class="email" href="mailto:leitner@math.fu-berlin.de">leitner@math.fu-berlin.de</a>&gt;</code></p></li><li class="listitem"><p>Brandon Long <code class="email">&lt;<a class="email" href="mailto:blong@fiction.net">blong@fiction.net</a>&gt;</code></p></li><li class="listitem"><p>Jimmy Mäkelä <code class="email">&lt;<a class="email" href="mailto:jmy@flashback.net">jmy@flashback.net</a>&gt;</code></p></li><li class="listitem"><p>Lars Marowsky-Bree <code class="email">&lt;<a class="email" href="mailto:lmb@pointer.in-minden.de">lmb@pointer.in-minden.de</a>&gt;</code></p></li><li class="listitem"><p>Thomas <span class="quote">“<span class="quote">Mike</span>”</span> Michlmayr <code class="email">&lt;<a class="email" href="mailto:mike@cosy.sbg.ac.at">mike@cosy.sbg.ac.at</a>&gt;</code></p></li><li class="listitem"><p>Andrew W. Nosenko <code class="email">&lt;<a class="email" href="mailto:awn@bcs.zp.ua">awn@bcs.zp.ua</a>&gt;</code></p></li><li class="listitem"><p>David O'Brien <code class="email">&lt;<a class="email" href="mailto:obrien@Nuxi.cs.ucdavis.edu">obrien@Nuxi.cs.ucdavis.edu</a>&gt;</code></p></li><li class="listitem"><p>Clint Olsen <code class="email">&lt;<a class="email" href="mailto:olsenc@ichips.intel.com">olsenc@ichips.intel.com</a>&gt;</code></p></li><li class="listitem"><p>Park Myeong Seok <code class="email">&lt;<a class="email" href="mailto:pms@romance.kaist.ac.kr">pms@romance.kaist.ac.kr</a>&gt;</code></p></li><li class="listitem"><p>Thomas Parmelan <code class="email">&lt;<a class="email" href="mailto:tom@ankh.fr.eu.org">tom@ankh.fr.eu.org</a>&gt;</code></p></li><li class="listitem"><p>Ollivier Robert <code class="email">&lt;<a class="email" href="mailto:roberto@keltia.freenix.fr">roberto@keltia.freenix.fr</a>&gt;</code></p></li><li class="listitem"><p>Thomas Roessler <code class="email">&lt;<a class="email" href="mailto:roessler@does-not-exist.org">roessler@does-not-exist.org</a>&gt;</code></p></li><li class="listitem"><p>Roland Rosenfeld <code class="email">&lt;<a class="email" href="mailto:roland@spinnaker.de">roland@spinnaker.de</a>&gt;</code></p></li><li class="listitem"><p>Rocco Rutte <code class="email">&lt;<a class="email" href="mailto:pdmef@gmx.net">pdmef@gmx.net</a>&gt;</code></p></li><li class="listitem"><p>TAKIZAWA Takashi <code class="email">&lt;<a class="email" href="mailto:taki@luna.email.ne.jp">taki@luna.email.ne.jp</a>&gt;</code></p></li><li class="listitem"><p>Allain Thivillon <code class="email">&lt;<a class="email" href="mailto:Allain.Thivillon@alma.fr">Allain.Thivillon@alma.fr</a>&gt;</code></p></li><li class="listitem"><p>Gero Treuner <code class="email">&lt;<a class="email" href="mailto:gero@70t.de">gero@70t.de</a>&gt;</code></p></li><li class="listitem"><p>Vsevolod Volkov <code class="email">&lt;<a class="email" href="mailto:vvv@lucky.net">vvv@lucky.net</a>&gt;</code></p></li><li class="listitem"><p>Ken Weinert <code class="email">&lt;<a class="email" href="mailto:kenw@ihs.com">kenw@ihs.com</a>&gt;</code></p></li></ul></div></div><div class="sect1" title="2. About This Document"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="about"></a>2. About This Document</h2></div></div></div><p>
7101 This document was written in <a class="ulink" href="http://docbook.sourceforge.net" target="_top">DocBook</a>, and then rendered
7102 using the <a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">Gnome XSLT
7103 toolkit</a>.
7104 </p></div></div></div></body></html>